Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - EnvironmentExtensions

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

EnvironmentExtensions

The Environment Extensions object represents the extension (process override) values for an environment.

The Environment Extensions object supports the ability to retrieve and update environment extension values. The functionality provided in the Environment Extensions object mimics the actions you can perform from the Runtime Management > Environment Management > Environment Extensions dialog in the Boomi Enterprise Platform.

This topic covers the basics for using the Environment Extensions object. To learn more intricate details of using this object, such as working with encrypted fields, overriding extension values, working with multi-install integration pack extensions, and working with custom properties fields, refer to the topic Working with the Environment Extensions object.

Environment Extension options

The following table details the components that you can retrieve or update extension values for.

XML Element Integration Component Notes for consideration Partial update behavior
connections Connection component Available fields vary by the individual connector. You can perform a partial update per individual field within a connection component.
operations Web Services Server operation This property is only applicable to Web Services Server (WSS) listeners used in a multi-install integration pack. It allows you to override the WSS operation’s object name so you can have a unique URL per each installed instance of the integration pack. You can perform a partial update per individual field within an operation component.
tradingPartner Trading Partner component Trading partner component communication method fields, EDI document standard fields, or both. Available fields vary by individual communication method and standard. You can perform a partial update per individual field within a Trading Partner component.
sharedCommunication Communication Channel component Available fields vary by the individual communication method. You can perform a partial update per individual field within a Shared Communication component.
crossReferences Cross Reference table component Available columns vary by individual cross reference table configurations. You can perform a partial update per individual Cross Reference Table component, but you must provide the values for all rows in the component.
properties Dynamic Process Property You can use the dynamic process property’s name as the extension field ID. You can perform a partial update per individual Dynamic Process Property component.
PGPCertificate PGP certificate component Use an existing PGP certificate’s component ID in your requests. It is not possible to use the Environment Extensions object to upload a new certificate directly. You can perform a partial update per individual PGP Certificate component.
processProperty Process Property component Available fields vary based on the properties defined within a given process property component. The property’s key is used as the extension field ID. You can perform a partial update per individual property within a Process Property component.

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 EnvironmentExtensions object

Retrieves the extension values for the environment having the specified ID (except for encrypted values).

Note: For all the process properties, the GET operation response returns values for the value field only when you perform an UPDATE operation from the API or save the extensions on the UI.

Authorizations:
basicAuth
path Parameters
id
required
string

The ID of the object. This can be either of the following:

  1. The value of environmentId.
  2. A conceptual ID synthesized from the environment ID (environmentId) and the ID of the multi-install integration pack to which the extension values apply (extensionGroupId).

Responses

Response Schema:
required
object (PGPCertificates)
required
object (Connections)
required
object (CrossReferences)
required
object (Operations)
required
object (OverrideProcessProperties)
required
object (Properties)
required
object (SharedCommunications)
required
object (TradingPartners)
environmentId
string

The ID of the environment.

extensionGroupId
string

The synthesized ID of the process belonging to a multi-install integration pack to which the extension values apply, if applicable. For more information, refer to the section in the Working with Environment Extensions subtopic about multi-install integration packs.

id
string

The ID of the object. This can be either of the following:
1. The value of environmentId.
2. A conceptual ID synthesized from the environment ID (environmentId) and the ID of the multi-install integration pack to which the extension values apply (extensionGroupId).

partial
boolean

Supplied only in an UPDATE operation.
- If set to true, indicates that the request includes only a subset of environment extension values to update.
- If set to false, indicates that the request includes the full set of environment extension values to update. Values not included in the request are reset to use their default values.

Response samples

Content type
{
  • "@type": "EnvironmentExtensions",
  • "connections": {
    • "@type": "Connections",
    • "connection": [
      ]
    },
  • "tradingPartners": {
    • "@type": "TradingPartners",
    • "tradingPartner": [
      ]
    },
  • "crossReferences": {
    • "@type": "CrossReferences",
    • "crossReference": [
      ]
    },
  • "processProperties": {
    • "@type": "OverrideProcessProperties",
    • "ProcessProperty": [
      ]
    },
  • "properties": {
    • "@type": "",
    • "property": [
      ]
    },
  • "PGPCertificates": {
    • "@type": "PGPCertificates",
    • "PGPCertificate": [
      ]
    },
  • "environmentId": "4f607d09...",
  • "extensionGroupId": "",
  • "id": "4f607d09..."
}

Modifies or updates an EnvironmentExtensions object

Updates the extension values for the environment having the specified ID. When updating extension values, you must perform either a partial update to update only those extension values requiring modification in the request, or a full update to update the full set of environment extensions in a single request. A partial update is typically recommended because it results in smaller payloads and more targeted updates.

Warning: The UPDATE operation does not support running multiple map extensions requests concurrently. Some map extensions might not get updated properly.

For GCP secret manager, the secret reference must be in the following format: projects/${project-id}/secrets/${secret-id}/versions/${version-id}. If the passed secret reference is valid, a success message is displayed. For an invalid secret reference, an error message “Invalid Secret Reference Value” is displayed.

Note: The user must have ADC set up on the system where the atom runtime is installed and running. For more information on GCP, refer to the Set up ADC for a local development environment topic.

Performing a partial update

To perform a partial update, set partial to true and then provide only the extension fields and values that you wish to update in the request.

Note: For cross reference tables, you can update a single cross reference table. However, you must provide all values for the entire table. You cannot update individual rows within a table.

  • For process property components, you can update a single process property component but you must provide the values for all properties in the component.

  • When performing a partial update, if useDefault is set to false, you must provide values to the value field. Otherwise, the previously overridden values will continue to be used.

Performing a full update

To perform a full update, set partial to false and then provide all the environment extension fields and values in the request, regardless if you wish to change only some values but not all.

Caution: Values not included in the request are reset to use their default values. If you omit the partial attribute, the behavior defaults to a full update.

Authorizations:
basicAuth
path Parameters
id
required
string

The ID of the object. This can be either of the following:

  1. The value of environmentId.
  2. A conceptual ID synthesized from the environment ID (environmentId) and the ID of the multi-install integration pack to which the extension values apply (extensionGroupId).
Request Body schema:
optional
required
object (PGPCertificates)
required
object (Connections)
required
object (CrossReferences)
required
object (Operations)
required
object (OverrideProcessProperties)
required
object (Properties)
required
object (SharedCommunications)
required
object (TradingPartners)
environmentId
string

The ID of the environment.

extensionGroupId
string

The synthesized ID of the process belonging to a multi-install integration pack to which the extension values apply, if applicable. For more information, refer to the section in the Working with Environment Extensions subtopic about multi-install integration packs.

id
string

The ID of the object. This can be either of the following:
1. The value of environmentId.
2. A conceptual ID synthesized from the environment ID (environmentId) and the ID of the multi-install integration pack to which the extension values apply (extensionGroupId).

partial
boolean

Supplied only in an UPDATE operation.
- If set to true, indicates that the request includes only a subset of environment extension values to update.
- If set to false, indicates that the request includes the full set of environment extension values to update. Values not included in the request are reset to use their default values.

Responses

Response Schema:
required
object (PGPCertificates)
required
object (Connections)
required
object (CrossReferences)
required
object (Operations)
required
object (OverrideProcessProperties)
required
object (Properties)
required
object (SharedCommunications)
required
object (TradingPartners)
environmentId
string

The ID of the environment.

extensionGroupId
string

The synthesized ID of the process belonging to a multi-install integration pack to which the extension values apply, if applicable. For more information, refer to the section in the Working with Environment Extensions subtopic about multi-install integration packs.

id
string

The ID of the object. This can be either of the following:
1. The value of environmentId.
2. A conceptual ID synthesized from the environment ID (environmentId) and the ID of the multi-install integration pack to which the extension values apply (extensionGroupId).

partial
boolean

Supplied only in an UPDATE operation.
- If set to true, indicates that the request includes only a subset of environment extension values to update.
- If set to false, indicates that the request includes the full set of environment extension values to update. Values not included in the request are reset to use their default values.

Request samples

Content type
{
  • "EnvironmentExtensions": {
    • "id": "456789ab-cdef-0123-4567-89abcdef0123",
    • "extensionGroupId": "2545e8cb-3162-4729-8dff-3a8ccfc48933",
    • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
    • "partial": "false",
    • "connections": {
      },
    • "operations": {
      },
    • "tradingPartners": {
      },
    • "sharedCommunications": {
      },
    • "crossReferences": {
      },
    • "processProperties": {
      },
    • "properties": {
      },
    • "PGPCertificates": {
      }
    }
}

Response samples

Content type
{
  • "EnvironmentExtensions": {
    • "id": "456789ab-cdef-0123-4567-89abcdef0123",
    • "extensionGroupId": "2545e8cb-3162-4729-8dff-3a8ccfc48933",
    • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
    • "partial": "false",
    • "connections": {
      },
    • "operations": {
      },
    • "tradingPartners": {
      },
    • "sharedCommunications": {
      },
    • "crossReferences": {
      },
    • "processProperties": {
      },
    • "properties": {
      },
    • "PGPCertificates": {
      }
    }
}

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

Request samples

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

Response samples

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

Queries for an EnvironmentExtensions 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
EnvironmentExtensionsSimpleExpression (object) or EnvironmentExtensionsGroupingExpression (object) (EnvironmentExtensionsExpression)
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 (EnvironmentExtensions)

Request samples

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

Response samples

Content type
{
  • "@type": "EnvironmentExtensions",
  • "connections": {
    • "@type": "Connections",
    • "connection": [
      ]
    },
  • "tradingPartners": {
    • "@type": "TradingPartners",
    • "tradingPartner": [
      ]
    },
  • "crossReferences": {
    • "@type": "CrossReferences",
    • "crossReference": [
      ]
    },
  • "processProperties": {
    • "@type": "OverrideProcessProperties",
    • "ProcessProperty": [
      ]
    },
  • "properties": {
    • "@type": "",
    • "property": [
      ]
    },
  • "PGPCertificates": {
    • "@type": "PGPCertificates",
    • "PGPCertificate": [
      ]
    },
  • "environmentId": "4f607d09...",
  • "extensionGroupId": "",
  • "id": "4f607d09..."
}

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

Response samples

Content type
{
  • "@type": "EnvironmentExtensions",
  • "connections": {
    • "@type": "Connections",
    • "connection": [
      ]
    },
  • "tradingPartners": {
    • "@type": "TradingPartners",
    • "tradingPartner": [
      ]
    },
  • "crossReferences": {
    • "@type": "CrossReferences",
    • "crossReference": [
      ]
    },
  • "processProperties": {
    • "@type": "OverrideProcessProperties",
    • "ProcessProperty": [
      ]
    },
  • "properties": {
    • "@type": "",
    • "property": [
      ]
    },
  • "PGPCertificates": {
    • "@type": "PGPCertificates",
    • "PGPCertificate": [
      ]
    },
  • "environmentId": "4f607d09...",
  • "extensionGroupId": "",
  • "id": "4f607d09..."
}