Boomi Platform API Reference (1.0.0) - Deployment

Toggle Pane

• Deployment (Legacy deployment, Deprecated)
  • postCreates a Deployment object
  • getRetrieves an instance of a Deployment object
  • postRetrieves multiple Deployment objects by identifier
  • postQueries for a Deployment object(s)
  • postRetrieves additional results for a Deployment query

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Deployment (Legacy deployment, Deprecated)

The Deployment object represents a component deployment. caution The Deployment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Packaged Component and Deployed Package objects 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 cannot deploy processes that contain Process Route components as a unit with the API. You must deploy the parent process, the Process Route component, and any subprocesses that the process route calls independently.

Creates a Deployment object

The Deployment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Packaged Component and Deployed Package objects instead.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

componentId required	string
componentType required	string
deployedBy required	string
deployedOn required	string <date-time>
digest required	string
environmentId required	string
id required	string
notes required	string
processId required	string
current	boolean
listenerStatus	string Enum: "RUNNING" "PAUSED"
message	string
version	integer <int32>

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

componentId required	string
componentType required	string
deployedBy required	string
deployedOn required	string <date-time>
digest required	string
environmentId required	string
id required	string
notes required	string
processId required	string
current	boolean
listenerStatus	string Enum: "RUNNING" "PAUSED"
message	string
version	integer <int32>

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}/Deployment

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
• "componentId": "789abcde-f012-3456-789a-bcdef0123456",
• "notes": "via RESTish request: Re-deployment of version 54"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Deployment",
• "id": "89abcdef-0123-4567-89ab-cdef01234567",
• "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
• "processId": "789abcde-f012-3456-789a-bcdef0123456",
• "componentId": "789abcde-f012-3456-789a-bcdef0123456",
• "componentType": "process",
• "current": true,
• "notes": "via RESTish request: Re-deployment of version 54",
• "version": 55,
• "deployedOn": "2013-09-23T16:33:53.413Z",
• "deployedBy": "user123@company.biz"

}

Retrieves an instance of a Deployment object

The Deployment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Packaged Component and Deployed Package objects instead.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

componentId required	string
componentType required	string
deployedBy required	string
deployedOn required	string <date-time>
digest required	string
environmentId required	string
id required	string
notes required	string
processId required	string
current	boolean
listenerStatus	string Enum: "RUNNING" "PAUSED"
message	string
version	integer <int32>

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}/Deployment/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Deployment",
• "id": "89abcdef-0123-4567-89ab-cdef01234567",
• "digest": "abb98d1a5b659afbe77cc361cb255c8b",
• "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
• "processId": "789abcde-f012-3456-789a-bcdef0123456",
• "componentId": "789abcde-f012-3456-789a-bcdef0123456",
• "componentType": "process",
• "current": true,
• "notes": "Added Message step",
• "version": 54,
• "deployedOn": "2013-08-13T17:13:46Z",
• "deployedBy": "user123@company.biz"

}

Retrieves multiple Deployment objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (Deployment) index integer <int32> id string statusCode integer <int32> errorMessage 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}/Deployment/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "request": [

  • {

    • "id": "56789abc-def0-1234-5678-9abcdef01234"

    }

  ],
• "type": "GET"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "response": [

  • {

    • "Result": {

      • "componentId": "789abcde-f012-3456-789a-bcdef0123456",
      • "componentType": "string",
      • "current": "true",
      • "deployedBy": "user123company.biz",
      • "deployedOn": "2013-08-13T17:13:46Z",
      • "digest": "abb98d1a5b659afbe77cc361cb255c8b",
      • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
      • "id": "89abcdef-0123-4567-89ab-cdef01234567",
      • "listenerStatus": "RUNNING",
      • "message": "string",
      • "notes": "Added Message step",
      • "processId": "string",
      • "version": "54"

      },
    • "index": 0,
    • "id": "string",
    • "statusCode": 0,
    • "errorMessage": "string"

    }

  ]

}

Queries for a Deployment 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, processId, componentId, componentType, current

required

object

required DeploymentSimpleExpression (object) or DeploymentGroupingExpression (object) (DeploymentExpression) 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" "componentId" "componentType" "current" 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 (Deployment)

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

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

      • {

        • "argument": [

          • "456789ab-cdef-0123-4567-89abcdef0123"

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

        },
      • {

        • "argument": [

          • "789abcde-f012-3456-789a-bcdef0123456"

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

        },
      • {

        • "argument": [

          • false

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

        }

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "Deployment",
    • "id": "89abcdef-0123-4567-89ab-cdef01234567",
    • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
    • "processId": "789abcde-f012-3456-789a-bcdef0123456",
    • "componentId": "789abcde-f012-3456-789a-bcdef0123456",
    • "componentType": "process",
    • "current": false,
    • "notes": "Initial",
    • "version": 1,
    • "deployedOn": "2012-09-23T11:48:27Z",
    • "deployedBy": "user123@company.biz"

    },
  • {

    • "@type": "Deployment",
    • "id": "76543210-fedc-ba98-7654-3210fedcba98",
    • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
    • "processId": "789abcde-f012-3456-789a-bcdef0123456",
    • "componentId": "789abcde-f012-3456-789a-bcdef0123456",
    • "componentType": "process",
    • "current": false,
    • "notes": "Added process properties",
    • "version": 50,
    • "deployedOn": "2013-07-29T13:01:14Z",
    • "deployedBy": "user123@company.biz"

    }

  ]

}

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

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "Deployment",
    • "id": "89abcdef-0123-4567-89ab-cdef01234567",
    • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
    • "processId": "789abcde-f012-3456-789a-bcdef0123456",
    • "componentId": "789abcde-f012-3456-789a-bcdef0123456",
    • "componentType": "process",
    • "current": false,
    • "notes": "Initial",
    • "version": 1,
    • "deployedOn": "2012-09-23T11:48:27Z",
    • "deployedBy": "user123@company.biz"

    },
  • {

    • "@type": "Deployment",
    • "id": "76543210-fedc-ba98-7654-3210fedcba98",
    • "environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
    • "processId": "789abcde-f012-3456-789a-bcdef0123456",
    • "componentId": "789abcde-f012-3456-789a-bcdef0123456",
    • "componentType": "process",
    • "current": false,
    • "notes": "Added process properties",
    • "version": 50,
    • "deployedOn": "2013-07-29T13:01:14Z",
    • "deployedBy": "user123@company.biz"

    }

  ]

}