Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ExecutionConnector

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ExecutionConnector

Use the Execution Connector object to programmatically retrieve information about the connectors included in a process run.

Note: This object is part of a series of process run-related API objects and operations for viewing and running documents using the Platform API. You can use each object or operation conjunctively with one another to achieve a set of results pertaining to viewing or retrieving process run details. For a deeper dive into understanding the relationships and usability between each of these APIs, Refer to the Community article How to get integration process execution details with the AtomSphere API.

The Execution Connector object represents the connector steps used in a given process run that moves documents either into or out of the process. Execution Connector records include the Start shape, Connector shapes, Trading Partner shapes, and Return Documents shapes used in the process. The information returned with the Execution Connector object includes the type of connector, the number of success or error documents, and the action performed by the connector.

Queries for an ExecutionConnector object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

  • The QUERY operation allows you to query the connectors involved in a process run by filtering on attributes like executionId, actionType, successCount, and so on.
  • Requires one or more execution IDs in the request body.
  • You can filter all fields except executionConnector and id.
Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: executionId, connectorType, actionType, errorCount, successCount, size, isStartShape, recordType

required
object
required
ExecutionConnectorSimpleExpression (object) or ExecutionConnectorGroupingExpression (object) (ExecutionConnectorExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
Enum: "executionId" "connectorType" "actionType" "errorCount" "successCount" "size" "isStartShape" "recordType"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (ExecutionConnector)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 2
}

Retrieves additional results for an ExecutionConnector query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (ExecutionConnector)

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 2
}