Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ProcessAtomAttachment

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ProcessAtomAttachment (Legacy deployment, Deprecated)

The Process Atom Attachment object enables the attachment or detachment of a process to or from a particular Runtime. caution The Process Atom Attachment object (Legacy) is a deprecated API and should no longer be used. Non-environment functionality was removed from the , and all accounts are changed to utilize Environments. Therefore, Boomi recommends that you take advantage of the API functionality provided by the Process Environment Attachment object instead. For more information about Boomi's API object deprecation status, refer to the topic API deprecation and versioning policy.

You can use the Process Atom Attachment object only for processes. For other components, use the Component Atom Attachment object.

Creates a ProcessAtomAttachment object

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

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

Responses

Response Schema:
atomId
string
componentType
string
id
string
processId
string

Request samples

Content type
{
  • "processId": "56789abc-def0-1234-5678-9abcdef01234",
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012"
}

Response samples

Content type
{
  • "@type": "ProcessAtomAttachment",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
  • "processId": "56789abc-def0-1234-5678-9abcdef01234",
  • "componentType": "process",
  • "atomId": "3456789a-bcde-f012-3456-789abcdef012"
}

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

required
object
required
ProcessAtomAttachmentSimpleExpression (object) or ProcessAtomAttachmentGroupingExpression (object) (ProcessAtomAttachmentExpression)
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" "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 (ProcessAtomAttachment)

Request samples

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

Response samples

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

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

Response samples

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

Deletes a ProcessAtomAttachment object

Detaches a process from a Runtime where the attachment is specified by the conceptual Process Atom Attachment object ID.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response samples

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