Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - Connector

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Connector

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.

Retrieves an instance of a Connector object

You can only perform the GET operation by type and not by name.

Send an HTTP GET where accountId is the ID of the authenticating account for the request and connectorType is the name of the connector subtype you are attempting to GET.

For example, sending an HTTP GET to https://api.boomi.com/api/rest/v1/accountId/Connector/database returns Database type connectors available on the account.

Authorizations:
basicAuth
path Parameters
connectorType
required
string

The internal and unique identifier for connector type, such as http, ftp, greatplains. The Component Metadata object refers to this field as subType.

Responses

Response Schema:
name
string

The user-facing connector label of the connector type, which mimics the connector type names presented on the Build tab of the user interface.

type
string

The internal and unique identifier for connector type, such as http, ftp, greatplains. The Component Metadata object refers to this field as subType.

Response samples

Content type
{
  • "@type": "Connector",
  • "type": "database",
  • "name": "Database"
}

Retrieves multiple Connector objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (Connector)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for a Connector 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.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: type, name

required
object
required
ConnectorSimpleExpression (object) or ConnectorGroupingExpression (object) (ConnectorExpression)
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: "type" "name"
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 (Connector)

Request samples

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

Response samples

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

Retrieves additional results for a Connector 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 (Connector)

Response samples

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