Boomi Platform API Reference (1.0.0) - ComponentAtomAttachment

Toggle Pane

• ComponentAtomAttachment (Legacy deployment, Deprecated)
  • postCreates a ComponentAtomAttachment object
  • postQueries for a ComponentAtomAttachment object(s)
  • postRetrieves additional results for a ComponentAtomAttachment query
  • delDeletes a ComponentAtomAttachment object

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ComponentAtomAttachment (Legacy deployment, Deprecated)

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

Caution: The Component Atom Attachment (Legacy) object is a deprecated API and should no longer be used. removed the non-environment functionality from the , and all accounts are changed to utilize Environments. Therefore, Boomi recommends that you take advantage of the API functionality provided by the Component Environment Attachment (Legacy) object instead. For more information about Boomi's API object deprecation status, refer to the topic API deprecation and versioning policy.

Creates a ComponentAtomAttachment object

Attaches a component with a specific ID to the Runtime with a specific ID. You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot attach components.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

atomId	string
componentId	string
componentType	string
id	string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

atomId	string
componentId	string
componentType	string
id	string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentAtomAttachment

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "atomId": "3456789a-bcde-f012-3456-789abcdef012",
• "componentId": "56789abc-def0-1234-5678-9abcdef01234"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Component",
• "folderFullPath": "Boomi/Admin",
• "componentId": "bb302dbb-2e30-41a8-9e59-035f491e6da6",
• "version": "1",
• "name": "Process A",
• "type": "process",
• "createdDate": "2023-07-05T15:43:18Z",
• "createdBy": "adminboomi.com",
• "modifiedDate": "2023-07-05T15:43:18Z",
• "modifiedBy": "adminboomi.com",
• "deleted": "false",
• "currentVersion": "true",
• "folderName": "Admin",
• "folderId": "RjozMDk2OQ",
• "encryptedValues": null,
• "object": {

  • "process": {

    • "xmlns": "",
    • "allowSimultaneous": "false",
    • "enableUserLog": "false",
    • "processLogOnErrorOnly": "false",
    • "purgeDataImmediately": "false",
    • "updateRunDates": "true",
    • "workload": "general",
    • "shapes": {

      • "shape": [

        • {

          • "image": "start",
          • "name": "shape1",
          • "shapetype": "start",
          • "userlabel": "",
          • "x": "96.0",
          • "y": "94.0",
          • "configuration": {

            • "noaction": null

            },
          • "dragpoints": {

            • "dragpoint": {

              • "name": "shape1.dragpoint1",
              • "toShape": "shape2",
              • "x": "240.0",
              • "y": "120.0"

              }

            }

          },
        • {

          • "image": "map_icon",
          • "name": "shape2",
          • "shapetype": "map",
          • "userlabel": "",
          • "x": "256.0",
          • "y": "112.0",
          • "configuration": {

            • "map": null

            },
          • "dragpoints": {

            • "dragpoint": {

              • "name": "shape2.dragpoint1",
              • "toShape": "shape3",
              • "x": "368.0",
              • "y": "120.0"

              }

            }

          },
        • {

          • "image": "stop_icon",
          • "name": "shape3",
          • "shapetype": "stop",
          • "userlabel": "",
          • "x": "384.0",
          • "y": "112.0",
          • "configuration": {

            • "stop": {

              • "continue": "true"

              }

            },
          • "dragpoints": null

          }

        ]

      }

    }

  },
• "processOverrides": null

}

Queries for a ComponentAtomAttachment 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:

application/jsonapplication/xmlapplication/json

optional

Possible properties include: atomId, componentId, componentType

required

object

required ComponentAtomAttachmentSimpleExpression (object) or ComponentAtomAttachmentGroupingExpression (object) (ComponentAtomAttachmentExpression) 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" "componentId" "componentType" argument Array of strings

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

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 (ComponentAtomAttachment)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentAtomAttachment/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "argument": [

      • "3456789a-bcde-f012-3456-789abcdef012"

      ],
    • "operator": "EQUALS",
    • "property": "atomId"

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "numberOfResults": 2,
• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "ComponentAtomAttachment",
    • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
    • "componentId": "56789abc-def0-1234-5678-9abcdef01234",
    • "componentType": "process",
    • "atomId": "3456789a-bcde-f012-3456-789abcdef012"

    },
  • {

    • "@type": "ComponentAtomAttachment",
    • "id": "b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA",
    • "componentId": "6789abcd-ef01-2345-6789-abcdef012345",
    • "atomId": "3456789a-bcde-f012-3456-789abcdef012"

    }

  ]

}

Retrieves additional results for a ComponentAtomAttachment query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:

basicAuth

Request Body schema: text/plain

required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

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 (ComponentAtomAttachment)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentAtomAttachment/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "numberOfResults": 2,
• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "ComponentAtomAttachment",
    • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
    • "componentId": "56789abc-def0-1234-5678-9abcdef01234",
    • "componentType": "process",
    • "atomId": "3456789a-bcde-f012-3456-789abcdef012"

    },
  • {

    • "@type": "ComponentAtomAttachment",
    • "id": "b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA",
    • "componentId": "6789abcd-ef01-2345-6789-abcdef012345",
    • "atomId": "3456789a-bcde-f012-3456-789abcdef012"

    }

  ]

}

Deletes a ComponentAtomAttachment object

Detaches a component from a Runtime where the attachment is specified by the conceptual Component 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. You must have the Runtime Management privilege to perform the DELETE operation.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentAtomAttachment/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}