Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ProcessEnvironmentAttachment

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ProcessEnvironmentAttachment (Legacy deployment, Deprecated)

The Process Environment Attachment object enables the attachment or detachment of a process to or from a particular environment. caution The Process Environment Attachment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Deployed Package object instead. This change is to support the introduction of Packaged Component Deployments, which leverages the way Legacy account users deploy components to environments. For more information about Boomi's API object deprecation status, refer to the topic API deprecation and versioning policy.

Boomi encourages administrators of Legacy deployment accounts to take advantage of the new Packaged Components Deployment by upgrading their accounts. Learn more about the new deployment workflow and how to upgrade Legacy accounts to use the new deployment workflow. In the meantime, do not use the replacement API without first converting your Legacy account. You can use the Process Environment Attachment object only for processes. For other components, use the Component Environment Attachment object.

Creates a ProcessEnvironmentAttachment object

Attaches a process having the specified ID to the environment having the specified ID.

Authorizations:
basicAuth
Request Body schema:
optional
componentType
string
environmentId
string
id
string
processId
string

Responses

Response Schema:
componentType
string
environmentId
string
id
string
processId
string

Request samples

Content type
{
  • "processId": "56789abc-def0-1234-5678-9abcdef01234",
  • "componentType": "process",
  • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}

Response samples

Content type
{
  • "@type": "ProcessEnvironmentAttachment",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
  • "processId": "56789abc-def0-1234-5678-9abcdef01234",
  • "componentType": "process",
  • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}

Queries for a ProcessEnvironmentAttachment 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, processId, componentType

required
object
required
ProcessEnvironmentAttachmentSimpleExpression (object) or ProcessEnvironmentAttachmentGroupingExpression (object) (ProcessEnvironmentAttachmentExpression)
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" "processId" "componentType"
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 (ProcessEnvironmentAttachment)

Request samples

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

Response samples

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

Retrieves additional results for a ProcessEnvironmentAttachment 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 (ProcessEnvironmentAttachment)

Response samples

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

Deletes a ProcessEnvironmentAttachment object

Detaches a process from an environment where the attachment is specified by the conceptual Process Environment Attachment object ID.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response samples

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