Boomi Platform API Reference (1.0.0) - ComponentEnvironmentAttachment

Toggle Pane

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

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ComponentEnvironmentAttachment (Legacy deployment, Deprecated)

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

Caution: The Component 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.

Creates a ComponentEnvironmentAttachment object

Attaches a component with a specific ID to the environment with a specific ID.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

componentId	string
componentType	string
environmentId	string
id	string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

componentId	string
componentType	string
environmentId	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}/ComponentEnvironmentAttachment

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "folderFullPath": "Boomi/Admin",
• "version": "1",
• "name": "Process A",
• "type": "process",
• "createdDate": "2023-07-05T14:06:28Z",
• "createdBy": "adminboomi.com",
• "modifiedDate": "2023-07-05T14:06:28Z",
• "modifiedBy": "adminboomi.com",
• "deleted": "false",
• "currentVersion": "true",
• "folderName": "Admin",
• "folderId": "RjozMDk2OQ",
• "encryptedValues": null,
• "description": 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

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ComponentEnvironmentAttachment",
• "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
• "componentId": "56789abc-def0-1234-5678-9abcdef01234",
• "componentType": "process",
• "environmentId": "456789ab-cdef-0123-4567-89abcdef0123"

}

Queries for a ComponentEnvironmentAttachment 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: environmentId, componentId, componentType

required

object

required ComponentEnvironmentAttachmentSimpleExpression (object) or ComponentEnvironmentAttachmentGroupingExpression (object) (ComponentEnvironmentAttachmentExpression) 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" "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 (ComponentEnvironmentAttachment)

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}/ComponentEnvironmentAttachment/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "operator": "and",
    • "nestedExpression": [

      • {

        • "argument": [

          • "e96b6e8a-7835-40c3-9db2-37095f2e3949"

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

        },
      • {

        • "argument": [

          • "20f3a063-e534-4e74-bc29-c2fbca583903"

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

        },
      • {

        • "argument": [

          • "webservice"

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

        }

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "ComponentEnvironmentAttachment",
    • "id": "QVRUQUNIX0NPTVBPTkVOVF9FTlYyMGYzYTA2My1lNTM0LTRlNzQtYmMyOS1jMmZiY2E1ODM5MDM6ZTk2YjZlOGEtNzgzNS00MGMzLTlkYjItMzcwOTVmMmUzOTQ5",
    • "componentId": "20f3a063-e534-4e74-bc29-c2fbca583903",
    • "environmentId": "e96b6e8a-7835-40c3-9db2-37095f2e3949",
    • "componentType": "webservice"

    }

  ],
• "numberOfResults": 1

}

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

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}/ComponentEnvironmentAttachment/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "ComponentEnvironmentAttachment",
    • "id": "QVRUQUNIX0NPTVBPTkVOVF9FTlYyMGYzYTA2My1lNTM0LTRlNzQtYmMyOS1jMmZiY2E1ODM5MDM6ZTk2YjZlOGEtNzgzNS00MGMzLTlkYjItMzcwOTVmMmUzOTQ5",
    • "componentId": "20f3a063-e534-4e74-bc29-c2fbca583903",
    • "environmentId": "e96b6e8a-7835-40c3-9db2-37095f2e3949",
    • "componentType": "webservice"

    }

  ],
• "numberOfResults": 1

}

Deletes a ComponentEnvironmentAttachment object

Detaches a component from an environment where the attachment is specified by the conceptual Component Environment Attachment object ID. This ID is returned by the CREATE operation that originated the attachment and can also be obtained from a QUERY 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}/ComponentEnvironmentAttachment/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

}