Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - EnvironmentAtomAttachment

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

EnvironmentAtomAttachment

The Environment Atom Attachment object enables the attachment or detachment of a Runtime to or from a particular environment.

Required Privileges

You must have the Runtime Management privilege to perform the CREATE or DELETE operation. If you have the Runtime Management Read Access privilege, you cannot attach or detach Runtimes.

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.

Creates an EnvironmentAtomAttachment object

Attaches a Runtime having the specified ID to the environment having the specified ID. Attaching an already attached Runtime moves the Runtime to the environment specified in the request.

Note: For accounts with Basic environment support, you can attach a single Runtime to each environment. For accounts with Unlimited environment support, you can attach have an unlimited number of Runtimes attached in each environment.

Authorizations:
basicAuth
Request Body schema:
optional
atomId
string

The ID of the Runtime.

environmentId
string

The ID of the environment.

id
string

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

Responses

Response Schema:
atomId
string

The ID of the Runtime.

environmentId
string

The ID of the environment.

id
string

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

Request samples

Content type
{
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012",
  • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}

Response samples

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

Queries for an EnvironmentAtomAttachment 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: atomId, environmentId

required
object
required
EnvironmentAtomAttachmentSimpleExpression (object) or EnvironmentAtomAttachmentGroupingExpression (object) (EnvironmentAtomAttachmentExpression)
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: "atomId" "environmentId"
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 (EnvironmentAtomAttachment)

Request samples

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

Response samples

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

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

Response samples

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

Deletes an EnvironmentAtomAttachment object

Detaches a Runtime from an environment where the attachment is specified by the conceptual Environment Atom Attachment object ID. This ID is returned by the CREATE operation that originated the attachment and can also be obtained from a QUERY operation. If you successfully detach the Runtime from the environment, the response is <true/>.

Authorizations:
basicAuth
path Parameters
id
required
string

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

Responses

Response samples

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