Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - EnvironmentMapExtensionsSummary

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

EnvironmentMapExtensionsSummary

The Environment Map Extensions Summary object refers to an extensible data map for an environment to which you attach a given process. An extensible map to which the object refers is represented by the Environment Map Extension object. Data map extensions are overrides to field mappings or fields augmenting profile-based object definitions. Data map extensions represent the generalized mapping between two object definitions. For more information, refer to the topic Data map extensions. Before you can request a GET or UPDATE operation on an Environment Map Extension object, you must perform a QUERY operation on the Environment Map Extensions Summary object to obtain the object IDs for extensible maps. The Environment Map Extensions Summary object also returns any connection fields required to reimport the source and destination profiles for customization.

Note: You use the Environment Map Extension Summary object to configure extended maps only. Using the Environment Extensions object, you manage all other types of extensions, such as connections and process properties.

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 EnvironmentMapExtensionsSummary 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

required
object
required
EnvironmentMapExtensionsSummarySimpleExpression (object) or EnvironmentMapExtensionsSummaryGroupingExpression (object) (EnvironmentMapExtensionsSummaryExpression)
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"
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 (EnvironmentMapExtensionsSummary)

Request samples

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

Response samples

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

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

Response samples

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