Boomi Platform API Reference (1.0.0) - DeployedPackage

Toggle Pane

• DeployedPackage
  • postCreates a DeployedPackage object
  • getRetrieves an instance of a DeployedPackage object
  • delDeletes a DeployedPackage object
  • postRetrieves multiple DeployedPackage objects by identifier
  • postQueries for a DeployedPackage object(s)
  • postRetrieves additional results for a DeployedPackage query

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

DeployedPackage

The Deployed Package object represents a packaged component deployed to an environment.

You must have the Packaged Component Deployment privilege (formerly known as the Process Deployment privilege) to use the Deployed Package object. If you want to use the CREATE operation to create a packaged component and deploy it in a single operation, you must also have the Packaged Component Management privilege (formerly known as the Package Management privilege).

Required Privileges

You need these privileges in the target environment:

Write access

• API — Use the Boomi Platform API to access account data.
• DEPLOY — Deploy processes and other packaged components to environments.

Read access

• N/A

Creates a DeployedPackage object

You can use the CREATE operation in two ways:

• With environmentId and packageId, CREATE deploys the specified packaged component to the identified environment.
• With environmentId and componentId, CREATE packages with the specified component and deploys the package to the specified environment.

  Note: By default, deployment of listener processes are in a running state. To deploy a packaged listener process in a paused state, include the listenerStatus field with a value of PAUSED.

Only fields explicitly marked “Valid in request body” may be included in requests. All other fields are read-only and are returned by the API in responses.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

active	boolean Identifies if the packaged component is actively deployed.
branchName	string
componentId	string (Valid in request body) The ID of the component. You can use the componentId to create and deploy a new packaged component. The component ID is available in the Revision History dialog, which you can access from the Build page in the user interface.
componentType	string The type of component: - certificate - customlibrary - flowservice - process - processroute - tpgroup - webservice
componentVersion	integer <int32> The Revision History number assigned to each saved configuration change made to a component on the Build tab. The component version is available in the Revision History dialog, which you can access from the Build page in the service.
deployedBy	string The user ID of the user who deployed the packaged component.
deployedDate	string <date-time> The date and time you deployed the packaged component.
deploymentId	string The ID of the deployment.
environmentId	string (Valid in request body) The ID of the environment.
listenerStatus	string Enum: "RUNNING" "PAUSED" (Valid in request body) (Optional, for packaged listener processes only) The status of a listener process as RUNNING or PAUSED. If you do not specify listenerStatus (or you specify an invalid value), the current status remains unchanged. By default, the deployment of listener processes are in a running state. Important: This field is only available for the CREATE operation. To retrieve the status of deployed listeners, use the Listener Status object.
message	string This tag is returned with the following message only when a successful additional deployment is performed after utilizing all the available connections in the account for CREATE operation: <bns:message>Your packaged components were successfully deployed. You have exceeded the usage count in your current connection licenses by 15. Contact a Boomi representative to purchase a higher connection licenses count.</bns:message>
notes	string (Valid in request body) Notes that describe the deployment.
packageId	string (Valid in request body) The ID of the packaged component. You can use packageId to deploy an existing packaged component. The packaged component ID is available from the: - Packaged Component object - The Packaged Component Details page on the Deploy > Packaged Components page in the user interface.
packageVersion	string The user-defined version of the packaged component.
version	integer <int32> The version number generated automatically for a deployment.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

active	boolean Identifies if the packaged component is actively deployed.
branchName	string
componentId	string (Valid in request body) The ID of the component. You can use the componentId to create and deploy a new packaged component. The component ID is available in the Revision History dialog, which you can access from the Build page in the user interface.
componentType	string The type of component: - certificate - customlibrary - flowservice - process - processroute - tpgroup - webservice
componentVersion	integer <int32> The Revision History number assigned to each saved configuration change made to a component on the Build tab. The component version is available in the Revision History dialog, which you can access from the Build page in the service.
deployedBy	string The user ID of the user who deployed the packaged component.
deployedDate	string <date-time> The date and time you deployed the packaged component.
deploymentId	string The ID of the deployment.
environmentId	string (Valid in request body) The ID of the environment.
listenerStatus	string Enum: "RUNNING" "PAUSED" (Valid in request body) (Optional, for packaged listener processes only) The status of a listener process as RUNNING or PAUSED. If you do not specify listenerStatus (or you specify an invalid value), the current status remains unchanged. By default, the deployment of listener processes are in a running state. Important: This field is only available for the CREATE operation. To retrieve the status of deployed listeners, use the Listener Status object.
message	string This tag is returned with the following message only when a successful additional deployment is performed after utilizing all the available connections in the account for CREATE operation: <bns:message>Your packaged components were successfully deployed. You have exceeded the usage count in your current connection licenses by 15. Contact a Boomi representative to purchase a higher connection licenses count.</bns:message>
notes	string (Valid in request body) Notes that describe the deployment.
packageId	string (Valid in request body) The ID of the packaged component. You can use packageId to deploy an existing packaged component. The packaged component ID is available from the: - Packaged Component object - The Packaged Component Details page on the Deploy > Packaged Components page in the user interface.
packageVersion	string The user-defined version of the packaged component.
version	integer <int32> The version number generated automatically for a 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}/DeployedPackage

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "environmentId": "e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2",
• "packageId": "e5f2896e-5988-4d98-920e-4fb9750b469d",
• "componentId": "58c53139-1e34-477f-be05-1ef8e3336adf",
• "notes": "Package deployment via Rest request"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "DeployedPackage",
• "deploymentId": "d0340bcd-066f-4ed3-a096-91e96b062d43",
• "version": 4,
• "packageId": "f478349c-2974-4795-81ba-e24b0b98975d",
• "packageVersion": "6.0",
• "environmentId": "e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2",
• "componentId": "58c53139-1e34-477f-be05-1ef8e3336adf",
• "componentVersion": "2.0",
• "componentType": "webservice",
• "deployedDate": "2017-11-01T16:44:26Z",
• "deployedBy": "admin@boomi.com",
• "notes": "Package deployment via Rest request",
• "active": true,
• "branchName": "test-branch1",
• "listenerStatus": "RUNNING",
• "message": "success message"

}

Retrieves an instance of a DeployedPackage object

Returns a single Deployed Package object based on the deployment ID.

Authorizations:

basicAuth

path Parameters

id required

string The Deployed Package object you are attempting to DELETE.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

active	boolean Identifies if the packaged component is actively deployed.
branchName	string
componentId	string (Valid in request body) The ID of the component. You can use the componentId to create and deploy a new packaged component. The component ID is available in the Revision History dialog, which you can access from the Build page in the user interface.
componentType	string The type of component: - certificate - customlibrary - flowservice - process - processroute - tpgroup - webservice
componentVersion	integer <int32> The Revision History number assigned to each saved configuration change made to a component on the Build tab. The component version is available in the Revision History dialog, which you can access from the Build page in the service.
deployedBy	string The user ID of the user who deployed the packaged component.
deployedDate	string <date-time> The date and time you deployed the packaged component.
deploymentId	string The ID of the deployment.
environmentId	string (Valid in request body) The ID of the environment.
listenerStatus	string Enum: "RUNNING" "PAUSED" (Valid in request body) (Optional, for packaged listener processes only) The status of a listener process as RUNNING or PAUSED. If you do not specify listenerStatus (or you specify an invalid value), the current status remains unchanged. By default, the deployment of listener processes are in a running state. Important: This field is only available for the CREATE operation. To retrieve the status of deployed listeners, use the Listener Status object.
message	string This tag is returned with the following message only when a successful additional deployment is performed after utilizing all the available connections in the account for CREATE operation: <bns:message>Your packaged components were successfully deployed. You have exceeded the usage count in your current connection licenses by 15. Contact a Boomi representative to purchase a higher connection licenses count.</bns:message>
notes	string (Valid in request body) Notes that describe the deployment.
packageId	string (Valid in request body) The ID of the packaged component. You can use packageId to deploy an existing packaged component. The packaged component ID is available from the: - Packaged Component object - The Packaged Component Details page on the Deploy > Packaged Components page in the user interface.
packageVersion	string The user-defined version of the packaged component.
version	integer <int32> The version number generated automatically for a 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}/DeployedPackage/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "DeployedPackage",
• "deploymentId": "75bdf0f7-e9d5-46f7-b90f-37e77df03c0a",
• "version": 3,
• "packageId": "7f436a84-f9dd-4417-ac3e-ee01a1343a3b",
• "packageVersion": "3.0",
• "environmentId": "e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2",
• "componentId": "5b4746bc-6a3e-4b18-838c-57887dae41e3",
• "componentVersion": "2.0",
• "componentType": "process",
• "deployedDate": "2017-04-04T15:15:36Z",
• "deployedBy": "admin@boomi.com",
• "notes": "Deployment through API\nDeployment of version 1 from environment Test_acct_envDeployment through API\nDeployment of version 1 from environment Test_acct_env",
• "active": false,
• "branchName": "test-branch1",
• "listenerStatus": "RUNNING",
• "message": "success message"

}

Deletes a DeployedPackage object

Removes the packaged component from the environment each with a specific IDs.

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

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

}

Retrieves multiple DeployedPackage 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 (DeployedPackage) 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}/DeployedPackage/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": {

      • "active": true,
      • "branchName": "string",
      • "componentId": "string",
      • "componentType": "string",
      • "componentVersion": 0,
      • "deployedBy": "string",
      • "deployedDate": "2019-08-24T14:15:22Z",
      • "deploymentId": "string",
      • "environmentId": "string",
      • "listenerStatus": "RUNNING",
      • "message": "string",
      • "notes": "string",
      • "packageId": "string",
      • "packageVersion": "string",
      • "version": 0

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

    }

  ]

}

Queries for a DeployedPackage 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: uid, notes, current, packageNotes, active, componentId, componentVersion, componentName, componentType, deployedBy, deployedDate, deploymentId, environmentId, environmentName, packageId, packageVersion, version, accountId, branch

required

object

required DeployedPackageSimpleExpression (object) or DeployedPackageGroupingExpression (object) (DeployedPackageExpression) 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: "uid" "notes" "current" "packageNotes" "active" "componentId" "componentVersion" "componentName" "componentType" "deployedBy" "deployedDate" "deploymentId" "environmentId" "environmentName" "packageId" "packageVersion" "version" "accountId" "branch" 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 (DeployedPackage)

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

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

      • {

        • "argument": [

          • "983870bd-3e41-4fcc-a622-c3cb6042d9c2"

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

        },
      • {

        • "argument": [

          • "process"

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

        },
      • {

        • "argument": [

          • true

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

        }

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "DeployedPackage",
    • "deploymentId": "8720160b-ad1a-4fcf-a36c-ed9e9a14b626",
    • "version": 1,
    • "packageId": "1ee2411e-00b9-4223-9882-b211ec3629f4",
    • "packageVersion": "6.0",
    • "environmentId": "983870bd-3e41-4fcc-a622-c3cb6042d9c2",
    • "componentId": "5b4746bc-6a3e-4b18-838c-57887dae41e3",
    • "componentVersion": "2.0",
    • "componentType": "process",
    • "deployedDate": "2017-04-04T15:20:46Z",
    • "deployedBy": "admin@boomi.com",
    • "notes": "Deployment of version 1 from environment Test_acct_envDeployment of version 1 from environment Test_acct_env",
    • "active": true,
    • "branchName": "test-branch1",
    • "listenerStatus": "RUNNING",
    • "message": "success message"

    },
  • {

    • "@type": "DeployedPackage",
    • "deploymentId": "90d14e55-fbcc-4121-b8c5-d37bd754abab",
    • "version": 4,
    • "packageId": "3a069907-4f55-46b4-90e8-27663d28112c",
    • "packageVersion": "6.0",
    • "environmentId": "983870bd-3e41-4fcc-a622-c3cb6042d9c2",
    • "componentId": "1fa6c6c7-4847-4c57-8db2-587ea53afe33",
    • "componentVersion": "2.0",
    • "componentType": "process",
    • "deployedDate": "2017-11-16T16:04:51Z",
    • "deployedBy": "admin@boomi.com",
    • "notes": "Package deployment via Rest request",
    • "active": true,
    • "branchName": "test-branch1",
    • "listenerStatus": "RUNNING",
    • "message": "success message"

    }

  ],
• "numberOfResults": 100

}

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

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "DeployedPackage",
    • "deploymentId": "8720160b-ad1a-4fcf-a36c-ed9e9a14b626",
    • "version": 1,
    • "packageId": "1ee2411e-00b9-4223-9882-b211ec3629f4",
    • "packageVersion": "6.0",
    • "environmentId": "983870bd-3e41-4fcc-a622-c3cb6042d9c2",
    • "componentId": "5b4746bc-6a3e-4b18-838c-57887dae41e3",
    • "componentVersion": "2.0",
    • "componentType": "process",
    • "deployedDate": "2017-04-04T15:20:46Z",
    • "deployedBy": "admin@boomi.com",
    • "notes": "Deployment of version 1 from environment Test_acct_envDeployment of version 1 from environment Test_acct_env",
    • "active": true,
    • "branchName": "test-branch1",
    • "listenerStatus": "RUNNING",
    • "message": "success message"

    },
  • {

    • "@type": "DeployedPackage",
    • "deploymentId": "90d14e55-fbcc-4121-b8c5-d37bd754abab",
    • "version": 4,
    • "packageId": "3a069907-4f55-46b4-90e8-27663d28112c",
    • "packageVersion": "6.0",
    • "environmentId": "983870bd-3e41-4fcc-a622-c3cb6042d9c2",
    • "componentId": "1fa6c6c7-4847-4c57-8db2-587ea53afe33",
    • "componentVersion": "2.0",
    • "componentType": "process",
    • "deployedDate": "2017-11-16T16:04:51Z",
    • "deployedBy": "admin@boomi.com",
    • "notes": "Package deployment via Rest request",
    • "active": true,
    • "branchName": "test-branch1",
    • "listenerStatus": "RUNNING",
    • "message": "success message"

    }

  ],
• "numberOfResults": 100

}