Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - IntegrationPackEnvironmentAttachment

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

IntegrationPackEnvironmentAttachment

The Integration Pack Environment Attachment object enables the attachment or detachment of an integration pack instance to or from a particular environment.

Note: The Integration Pack Environment Attachment object type is exposed only for accounts where you enable environments. For accounts where you do not enable environments, it reveals the Integration Pack Atom Attachment object type instead.

Required Privileges

Read and Write access

  • API — Use the Boomi Platform API to access account data.
  • DEPLOY — Deploy processes and other packaged components to environments.

Creates an IntegrationPackEnvironmentAttachment object

Attaches an integration pack instance having the specified ID to the environment having the specified ID.

Authorizations:
basicAuth
Request Body schema:
optional
environmentId
string

A unique ID assigned by the system to the environment.

id
string

The object’s conceptual ID, which is synthesized from the environment and integration pack instance IDs.

integrationPackInstanceId
string

A unique ID assigned by the system to the integration pack instance.

Responses

Response Schema:
environmentId
string

A unique ID assigned by the system to the environment.

id
string

The object’s conceptual ID, which is synthesized from the environment and integration pack instance IDs.

integrationPackInstanceId
string

A unique ID assigned by the system to the integration pack instance.

Request samples

Content type
{
  • "integrationPackInstanceId": "76543210FEDCBA9876543210FEDCBA98",
  • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}

Response samples

Content type
{
  • "@type": "IntegrationPackEnvironmentAttachment",
  • "integrationPackInstanceId": "76543210FEDCBA9876543210FEDCBA98",
  • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}

Queries for an IntegrationPackEnvironmentAttachment 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, integrationPackInstanceId

required
object
required
IntegrationPackEnvironmentAttachmentSimpleExpression (object) or IntegrationPackEnvironmentAttachmentGroupingExpression (object) (IntegrationPackEnvironmentAttachmentExpression)
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" "integrationPackInstanceId"
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 (IntegrationPackEnvironmentAttachment)

Request samples

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

Response samples

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

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

Response samples

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

Deletes an IntegrationPackEnvironmentAttachment object

Detaches an integration pack instance from an environment where the conceptual Integration Pack Environment Attachment object ID specifies the attachment. If you successfully detach the integration pack instance from the environment, the response is true.

Authorizations:
basicAuth
path Parameters
id
required
string

The conceptual Integration Pack Environment Attachment object ID

Responses

Response samples

Content type
{
  • "message": "Access denied due to insufficient permissions."
}