Waiting for engine...
Skip to main content

Connector object

Use the Connector object to retrieve information about the type of a connector that exists on the account, equivalent to the list of connector types available in a process connector’s Start shape.

Using the Connector object, you can use the GET operation to retrieve the connector type for a component name, and the QUERY operation to return a list of all connector types available for the account.

  • All standard connectors.

  • Any custom SDK connectors created by the specified tenant.

  • Any custom connectors shared to the specific tenant through account groups.

  • Any connectors made available through tenant feature flags. For example, the AS2 Client/Server only available with Trading Partner feature, or Web Services Shared.

  • Legacy connectors, such as the legacy LDAP connector.

Component Metadata object​

The Connector object plays a supportive role to the Component Metadata object. Using the Component Metadata object, you can filter by component type, similar to doing so on the Build tab's Component Explorer in the user interface. For connectors specifically, you can use Component Metadata to refine by subtype by providing the connector type value. To find this value, use the Connector object to query a list of available connector types, which you can then use to query the ComponentMetadata using the subType.

Structure​

<Connector type="" name=""/> </Connector>
FieldTypeDescription
typestringThe internal and unique identifier for connector type, such as http, ftp, greatplains. The Component Metadata object refers to this field as subType.
namestringThe user-facing connector label of the connector type, which mimics the connector type names presented on the Build tab of the user interface.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
 SupportedSupported Not Supported Not Supported  Not Supported Not Supported

Using the GET and QUERY operations​

You can only perform the GET operation by type but not name. However, you can QUERY for both name and type.

SOAP implementation​

  • GET operation

    Request:

    <soapenv:Envelope>
       <soapenv:Body>
          <api:get>
             <api:objectType>connector</api:objectType>
             <api:objectId>HTTP</api:objectId>
          </api:get>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
             <bns:result xsi:type="bns:Connector" type="http" name="HTTP Client"/>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example query returns all HTTP type connectors that exist on the account.

    Request:

    <soapenv:Body>
          <api:query>
             <api:objectType>connector</api:objectType>
             <api:queryConfig>

             <api:QueryFilter><api:expression xsi:type="api:SimpleExpression" operator="EQUALS" property="type" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
       <!--Zero or more repetitions:-->
       <api:argument>http</api:argument>
    </api:expression></api:QueryFilter></api:queryConfig>
          </api:query>
       </soapenv:Body>

    Response:

    <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="1">
                <bns:result xsi:type="bns:Connector" type="http" name="HTTP Client"/>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>
On this Page