Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - EnvironmentMapExtension

Toggle Pane

Download OpenAPI Specification: Download

EnvironmentMapExtension

The Environment Map Extension object represents the extensible data map configuration for a deployed process.

Data map extensions allow you to override or augment default field mappings and profile elements for a given pair of object definitions. Map extensions are typically used with integration packs. It is common for an integration pack developer to configure a default set of field mappings for a given integration, but then allow extension of the map. This enables each consumer of that integration pack to customize and augment the field mappings to meet their specific requirements. Additionally, in some cases, consumers can customize the source and destination profiles to incorporate custom fields that exist in their endpoint applications. For more information, refer to the topic Data map extensions.

Integration pack developers typically use the Environment Map Extension object to present the mapping configuration to their end users through a custom user interface. In some situations, developers can customize the source and destination profile fields to include the end user's own custom fields. Refer to the Customizing profiles section later in this topic.

The Environment Map Extension object operates with a single map ID. Use the Environment Map Extensions Summary object to query the list of available map extensions for the given environment.

To learn more about customizing profiles, refer to the topic Customizing Profile.

For more details on the map function, refer to Environment Map Extension Function.

Required Privileges

You need these privileges in the target environment:

Write access

  • API — Use the Boomi Platform API to access account data.
  • ATOM_MANAGEMENT — Configure and administer integration runtimes.

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.

Retrieves an instance of an EnvironmentMapExtension object

Retrieves an extensible map by its Environment Map Extension object ID.

Note: Extending a source or destination profile by means of browsing an external account may require including credentials in the request. The GET operation uses the credentials from the original process for the browse connection. However, because credential reuse can be problematic when sharing processes in Integration Packs, use the EXECUTE operation instead.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response Schema:
object (MapExtension)
environmentId
string

The ID of the environment.

extensionGroupId
string

The ID of the multi-install integration pack to which the extensible map applies, if applicable.

id
string

The ID of the object. This is a conceptual ID synthesized from the IDs of the Map, Process, Multi-install integration pack (extensionGroupId), and, if applicable Environment. After obtaining this value with a QUERY operation on the Environment Map Extensions Summary object, you can retrieve or update the extensible map by specifying the ID in a GET or UPDATE operation on this object

mapId
string

The ID of the extensible map.

name
string

The name of the extensible map. This variable includes the source object definition name and the destination object definition name, separated by a hyphen.

processId
string

The ID of the process.

Response samples

Content type
{
  • "EnvironmentMapExtension": {
    • "name": "Account - Customer",
    • "mapId": "01234567890123456789012345",
    • "processId": "789abcde-f012-3456-789a-bcdef0123456",
    • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
    • "extensionGroupId": "",
    • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
    • "Map": {
      }
    }
}

Modifies or updates an EnvironmentMapExtension object

Updates the extended mapping configuration for the specified Environment Map Extension object ID.

Authorizations:
basicAuth
path Parameters
id
required
string
Request Body schema:
optional
object (MapExtension)
environmentId
string

The ID of the environment.

extensionGroupId
string

The ID of the multi-install integration pack to which the extensible map applies, if applicable.

id
string

The ID of the object. This is a conceptual ID synthesized from the IDs of the Map, Process, Multi-install integration pack (extensionGroupId), and, if applicable Environment. After obtaining this value with a QUERY operation on the Environment Map Extensions Summary object, you can retrieve or update the extensible map by specifying the ID in a GET or UPDATE operation on this object

mapId
string

The ID of the extensible map.

name
string

The name of the extensible map. This variable includes the source object definition name and the destination object definition name, separated by a hyphen.

processId
string

The ID of the process.

Responses

Response Schema:
object (MapExtension)
environmentId
string

The ID of the environment.

extensionGroupId
string

The ID of the multi-install integration pack to which the extensible map applies, if applicable.

id
string

The ID of the object. This is a conceptual ID synthesized from the IDs of the Map, Process, Multi-install integration pack (extensionGroupId), and, if applicable Environment. After obtaining this value with a QUERY operation on the Environment Map Extensions Summary object, you can retrieve or update the extensible map by specifying the ID in a GET or UPDATE operation on this object

mapId
string

The ID of the extensible map.

name
string

The name of the extensible map. This variable includes the source object definition name and the destination object definition name, separated by a hyphen.

processId
string

The ID of the process.

Request samples

Content type
{
  • "name": "Account - Customer",
  • "mapId": "01234567890123456789012345",
  • "processId": "789abcde-f012-3456-789a-bcdef0123456",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
  • "extensionGroupId": "",
  • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
  • "Map": {
    • "ExtendedFunctions": {
      },
    • "ExtendedMappings": {
      },
    • "SourceProfileExtensions": {
      },
    • "DestinationProfileExtensions": [
      ]
    }
}

Response samples

Content type
{
  • "@type": "Environment",
  • "id": "456789ab-cdef-0123-4567-89abcdef0123",
  • "name": "Our Production Environment",
  • "classification": "PROD"
}

Retrieves multiple EnvironmentMapExtension 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 (EnvironmentMapExtension)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

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

Response samples

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

Executes an action on an EnvironmentMapExtension object

Use the EXECUTE operation when you want to customize XML profiles by reimporting them from endpoint applications. The EXECUTE operation returns the current Environment Map Extension configuration similar to the GET operation.

It also accepts connection credentials and automatically connects to the external application to retrieve additional custom fields for that profile. You must have the Runtime Management privilege to perform the EXECUTE operation. If you have the Runtime Management Read Access privilege, you cannot post connection credentials.

For information about using these operations to retrieve or update map functions, refer to Environment Map Extension functions.

Include the SourceBrowse and DestinationBrowse sections as appropriate to browse the respective profile and include the required BrowseFields for the given connector. If you need to call the EXECUTE action repeatedly for the same map, you can alternatively use the sessionId to avoid having to supply the connector fields in subsequent calls. Session caching lasts about 30 minutes.

Authorizations:
basicAuth
path Parameters
id
required
string
Request Body schema:
optional
object (MapExtension)
environmentId
string

The ID of the environment.

extensionGroupId
string

The ID of the multi-install integration pack to which the extensible map applies, if applicable.

id
string

The ID of the object. This is a conceptual ID synthesized from the IDs of the Map, Process, Multi-install integration pack (extensionGroupId), and, if applicable Environment. After obtaining this value with a QUERY operation on the Environment Map Extensions Summary object, you can retrieve or update the extensible map by specifying the ID in a GET or UPDATE operation on this object

mapId
string

The ID of the extensible map.

name
string

The name of the extensible map. This variable includes the source object definition name and the destination object definition name, separated by a hyphen.

processId
string

The ID of the process.

Responses

Response Schema:
object (MapExtension)
environmentId
string

The ID of the environment.

extensionGroupId
string

The ID of the multi-install integration pack to which the extensible map applies, if applicable.

id
string

The ID of the object. This is a conceptual ID synthesized from the IDs of the Map, Process, Multi-install integration pack (extensionGroupId), and, if applicable Environment. After obtaining this value with a QUERY operation on the Environment Map Extensions Summary object, you can retrieve or update the extensible map by specifying the ID in a GET or UPDATE operation on this object

mapId
string

The ID of the extensible map.

name
string

The name of the extensible map. This variable includes the source object definition name and the destination object definition name, separated by a hyphen.

processId
string

The ID of the process.

Request samples

Content type
{
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
  • "Map": {
    • "BrowseSettings": {
      }
    }
}

Response samples

Content type
{
  • "@type": "EnvironmentMapExtension",
  • "name": "Account - Customer",
  • "mapId": "01234567890123456789012345",
  • "processId": "789abcde-f012-3456-789a-bcdef0123456",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
  • "extensionGroupId": "",
  • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
  • "Map": {
    • "SourceProfile": {
      },
    • "DestinationProfile": {
      },
    • "ExtendedFunctions": {
      },
    • "ExtendedMappings": {
      },
    • "BrowseSettings": {
      },
    • "SourceProfileExtensions": {
      },
    • "DestinationProfileExtensions": null
    }
}