Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - EnvironmentConnectionFieldExtensionSummary

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

EnvironmentConnectionFieldExtensionSummary

You can use the Environment Connection Field Extension Summary object to obtain the URL for OAuth 2.0 access token generation.

Through the Environment Extensions endpoint, you can programmatically set almost all extensible connection fields for those used in processes attached to environments. 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 Environment Connection Field Extension Summary object.

From the time you generate it, the URL returned by the operation is valid for up to 15 minutes only.

Note: Note: The Boomi Enterprise Platform API and Partner API connectors do not support operations on the Environment Connection Field Extension Summary object.

Required Privileges

You need these privileges in the target environment:

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.
  • ATOM_MANAGEMENT — Configure and administer integration runtimes.
  • ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration.

Queries for an EnvironmentConnectionFieldExtensionSummary 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: environmentId, extensionGroupId, connectionId, fieldId

required
object
required
EnvironmentConnectionFieldExtensionSummarySimpleExpression (object) or EnvironmentConnectionFieldExtensionSummaryGroupingExpression (object) (EnvironmentConnectionFieldExtensionSummaryExpression)
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: "environmentId" "extensionGroupId" "connectionId" "fieldId"

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

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 (EnvironmentConnectionFieldExtensionSummary)

Request samples

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

Response samples

Content type
{}

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

Response samples

Content type
{}