Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AtomConnectionFieldExtensionSummary

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AtomConnectionFieldExtensionSummary (Legacy deployment, Deprecated)

The Atom Connection Field Extension Summary object is used to obtain the URL for OAuth 2.0 access token generation.

CAUTION:
The Atom Connection Field Extension Summary object is a deprecated API and should no longer be used. removed non-environment functionality from the , and changed all accounts to utilize Environments. Therefore, Boomi recommends that you take advantage of the API functionality provided by the Environment Connection Field Extension Summary object. For more information about Boomi's API object deprecation status, refer to the topic API deprecation and versioning policy.

You can programmatically set almost all extensible connection fields for connections used in processes attached to Runtimes through the Atom Extensions endpoint. The only current exception is the accessToken field in a connection that uses OAuth 2.0 authentication. You can obtain the URL for OAuth 2.0 access token generation using a QUERY operation on the Atom Connection Field Extension Summary object.

The URL returned by the operation is valid for up to 15 minutes from the time it is generated.

Note: In an XML response body, the returned URL requires decoding — for example, replacement of each instance of “&” with “&” — for use in the browser.

Queries for an AtomConnectionFieldExtensionSummary object(s)

All filters are required except for extensionGroupId, which is required only for a multi-install integration pack. You can obtain valid values for each filter by using the QUERY operation on the Atom Extensions object.

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: atomId, extensionGroupId, connectionId, fieldId

required
object
required
AtomConnectionFieldExtensionSummarySimpleExpression (object) or AtomConnectionFieldExtensionSummaryGroupingExpression (object) (AtomConnectionFieldExtensionSummaryExpression)
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: "atomId" "extensionGroupId" "connectionId" "fieldId"
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 (AtomConnectionFieldExtensionSummary)

Request samples

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

Response samples

Content type
{}

Retrieves additional results for an AtomConnectionFieldExtensionSummary 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 (AtomConnectionFieldExtensionSummary)

Response samples

Content type
{}