Execution Connector object

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 Boomi Enterprise 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, see the Community article How to get integration process execution details with the Boomi Enterprise Platform 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.

Structure

<id="" executionId="" executionConnector="" connectorType="" actionType="" errorCount="" successCount="" size="" isStartShape="" recordType=""/>

Field	Type	Description
Filter	Filter	Filter
id	string	A unique ID generated for this connector record.
executionId	string	The ID of the process run.
executionConnector	string	The executionConnector field represents the operation performed by the execution connector. This field's value varies between Connectors, Trading Partners, and Return Documents shapes: 1. For Connectors such as Disk, FTP, HTTP, and so on. The executionConnector is the user-defined name of the associated connector operation component. If the user did not change the operation component name in the user interface, this field adopts a default name pattern of `New <connector type> Connector Operation.` 2. For Trading Partners, executionConnector is the type of communication method that the Trading Partner uses (for example: `disk`, `as2`, and so on). 3. For Return Documents, executionConnector is the user -defined display name of the Return Documents shape in the process canvas. If you do not configure a display name, executionConnector is the internal shape name, for example "shape2" or "shape8." 4. For a No Data or Data Passthrough Start shape, executionConnector is always `start`, indicating that the connector was a Start shape.
connectorType	string	The internal and unique identifier for a connector type. 1. For Connectors, connectorType is the type of Connector (for example: `http`, `ftp`, `greatplains`). 2. For Trading Partners, connectorType is the type of documentstandard the Trading Partner uses (for example: hl7, edifact, x12). 3. For a No Data Start shape or a Return Documents shape, the connectorType is either nodata or return, respectively.
actionType	string	The type of action performed by the connector, as defined in the Connector Operation component (for example: GET, SEND, QUERY, UPDATE, and so on). The value varies by individual connector.
errorCount	numeric	The count of unsuccessful documents on the given execution connector, where the status is error or aborted.
successCount	numeric	The count of successful documents on the given execution connector, where a successful run is one with a status of complete.
size	numeric	The total size of all documents tracked by the given execution connector, in bytes.
isStartShape	boolean	If the value is set to true, this indicates the given execution connector is the Start shape of the process. If the value is set to false, this indicates that the given execution connector is not the Startshape of the process.
recordType	string	The type of connector record: tradingpartner, connector, nodata, or return.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not Supported	Supported	Not Supported	Not Supported	Not Supported	Not Supported

Using the QUERY operations

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.

You can use the following fields as QUERY filters for the Execution Connector object:

Field	Allowed values
executionId	Any string value. EQUALS is the only allowed operator for this filter field.
connectorType	Any valid Connector type. For example: x12, nodata, return, boomiapi, disk, and so on.
actionType	Any valid Connector action type. (For example: SEND, GET, LISTEN)
errorCount	Any numeric value.
successCount	Any numeric value.
size	Any numeric value.
isStartShape	true or false.
recordType	Any valid connector record type: tradingpartner, connector, or return.

The operators allowed for the Execution Connector object filters are:
- EQUALS
- BETWEEN
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- LESS_THAN
- LESS_THAN_OR_EQUAL
- IS_NULL
- IS_NOT_NULL
- LIKE
For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

SOAP implementation

QUERY operation

Send a POST request to:

https://api.boomi.com/api/soap/v1/<accountId>/ExecutionConnector

where accountId is the ID of the authenticating account for the request.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
    <soapenv:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password123</wsse:Password>
            </wsse:UsernameToken>
        </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
        <api:query>
            <api:objectType>executionconnector</api:objectType>
            <api:queryConfig>
                <api:QueryFilter>
                    <api:expression operator="EQUALS" property="executionId" xsi:type="api:SimpleExpression" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                        <api:argument>execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01</api:argument>
                    </api:expression>
                </api:QueryFilter>
            </api:queryConfig>
        </api:query>
    </soapenv:Body>
</soapenv:Envelope>

Response:

<?xml version='1.0' encoding='UTF-8'?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:queryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:results numberOfResults="2">
                <bns:result xsi:type="bns:ExecutionConnector" id="ABcDE19FT05GhIJ1KLmno2PqrST6c2uvwXYzA51bCd6EFglH3I0jK9lMNoPqr4StuvWXY3ZABcEFGhIJ1kLMN4OPQ1RsTuVWxyZaBcDe0fGHIjKLmNoP1" executionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01" executionConnector="Start" connectorType="nodata" actionType="nodata" errorCount="0" successCount="1" size="0" isStartShape="true" recordType="nodata"/>
                <bns:result xsi:type="bns:ExecutionConnector" id="ABcDE19FT05GhaBcd2E6fgHIjKLmNoPlaRStubwxyzABcDEF63I0jK9lMNoPqr4StuvWXY3ZABcEFGhIJ1kLMN4OPQ1RsTuVWxyZaBcDe0fGHIjKLmNoP1" executionId="execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01" executionConnector="shape2" connectorType="return" actionType="return" errorCount="0" successCount="1" size="0" isStartShape="false" recordType="return"/>
            </bns:results>
        </bns:queryResponse>
    </S:Body>
</S:Envelope>

Structure​

Supported operations​

Using the QUERY operations​

SOAP implementation​

Structure

Supported operations

Using the QUERY operations

SOAP implementation