Boomi Platform API Reference (1.0.0) - PackagedComponent

Toggle Pane

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

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

PackagedComponent

The Packaged Component object represents a component packaged for deployment to an environment. You can use the Packaged Component object to create, query, or restore deleted packaged components. In addition to processes, you can convert the following types of components into packaged components and deploy them to an environment independently:

• API Proxy
• API Service
• Certificate (public X.509)
• Custom Library
• Flow Service
• Process Route
• Processing Group

Required Privileges

Read and Write access

• API — Use the Boomi Platform API to access account data.
• PACKAGE_MANAGEMENT — Create and manage packaged components.

Creates a PackagedComponent object

• You can use the CREATE operation to perform two different actions. For example, you can create a new packaged component from a specific component ID, or you can restore a deleted packaged component. Both actions use the same object endpoint. However, the information required in the request body differs.
  • To create a new packaged component, you must include a component ID in the request body. You create a packaged component for the specified componentId. Optionally, you can specify a packageVersion value and notes about the package version.

    Note: You cannot add package versions and notes after creating the packaged component. However, if not specified, automatically assigns a numerical version number to your new packaged component.

  • To restore or recover a deleted packaged component, you must specify the packageId, componentId, and packageVersion. You can query the Packaged Component object for a list of deleted packaged components.
• Specify a branchName to create a packaged component on a particular branch. If branchName is not provided, the default working branch is used.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

branchName required	string The name of the branch on which you want to create a packaged component.
componentId required	string The ID of the component.The component ID is available on the Revision History dialog, which you can access from the Build page in the user interface.
componentType required	string The type of component: - certificate - customlibrary - flowservice - process - processroute - tpgroup - webservice
createdBy required	string The user ID of the person who created the packaged component.
createdDate required	string <date-time> The creation date and time of the packaged component.
notes required	string Notes that describe the packaged component.
packageId required	string The ID of the packaged component.
packageVersion required	string The user-defined version of the packaged component. Generates a value automatically based on the component's revision number if you do not specify a packaged component version.
componentVersion	integer <int32> When you save the component configuration change on the Build tab, this is the assigned Revision History number. You can find the component version in the Revision History dialog, which you can access from the Build page in the service.
deleted	boolean
fullyPubliclyConsumable	boolean
shareable	boolean (For processes and API Service components only) Identifies whether you can share the packaged component in the Process Library or as part of an integration pack. Note: You cannot share processes that contain Process Route components in the Process Library or as part of an integration pack.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

branchName required	string The name of the branch on which you want to create a packaged component.
componentId required	string The ID of the component.The component ID is available on the Revision History dialog, which you can access from the Build page in the user interface.
componentType required	string The type of component: - certificate - customlibrary - flowservice - process - processroute - tpgroup - webservice
createdBy required	string The user ID of the person who created the packaged component.
createdDate required	string <date-time> The creation date and time of the packaged component.
notes required	string Notes that describe the packaged component.
packageId required	string The ID of the packaged component.
packageVersion required	string The user-defined version of the packaged component. Generates a value automatically based on the component's revision number if you do not specify a packaged component version.
componentVersion	integer <int32> When you save the component configuration change on the Build tab, this is the assigned Revision History number. You can find the component version in the Revision History dialog, which you can access from the Build page in the service.
deleted	boolean
fullyPubliclyConsumable	boolean
shareable	boolean (For processes and API Service components only) Identifies whether you can share the packaged component in the Process Library or as part of an integration pack. Note: You cannot share processes that contain Process Route components in the Process Library or as part of an integration pack.

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
• "packageVersion": "1.2",
• "notes": "Package for deployment"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "PackagedComponent",
• "packageId": "357f7a90-7708-45f9-9f28-a83bc74d49a6",
• "packageVersion": "1.3",
• "componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
• "componentVersion": "2.0",
• "componentType": "process",
• "createdDate": "2017-11-01T18:40:55Z",
• "createdBy": "user@boomi.com",
• "shareable": true

}

Retrieves an instance of a PackagedComponent object

Retrieves the packaged component with the specified ID.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

branchName required	string The name of the branch on which you want to create a packaged component.
componentId required	string The ID of the component.The component ID is available on the Revision History dialog, which you can access from the Build page in the user interface.
componentType required	string The type of component: - certificate - customlibrary - flowservice - process - processroute - tpgroup - webservice
createdBy required	string The user ID of the person who created the packaged component.
createdDate required	string <date-time> The creation date and time of the packaged component.
notes required	string Notes that describe the packaged component.
packageId required	string The ID of the packaged component.
packageVersion required	string The user-defined version of the packaged component. Generates a value automatically based on the component's revision number if you do not specify a packaged component version.
componentVersion	integer <int32> When you save the component configuration change on the Build tab, this is the assigned Revision History number. You can find the component version in the Revision History dialog, which you can access from the Build page in the service.
deleted	boolean
fullyPubliclyConsumable	boolean
shareable	boolean (For processes and API Service components only) Identifies whether you can share the packaged component in the Process Library or as part of an integration pack. Note: You cannot share processes that contain Process Route components in the Process Library or as part of an integration pack.

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "PackagedComponent",
• "packageId": "e8dbc278-e970-49e5-84bd-af39d7d38140",
• "packageVersion": "2.0",
• "componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
• "componentVersion": "2.0",
• "componentType": "process",
• "createdDate": "2017-03-16T13:34:01Z",
• "createdBy": "user@boomi.com",
• "notes": "Created for component publication with GUID f7f6ddb6-9437-4a90-9655-f01970068ca8 and version 2.",
• "shareable": true,
• "deleted": false

}

Deletes a PackagedComponent object

• The DELETE operation deletes a specific packaged component version. The id that you provide in the endpoint represents a Packaged Component ID. You can retrieve the Packaged Component ID (packageId) using the GET and QUERY operations, or by viewing the Packaged Component History dialog for a specific version in the Integration user interface.

  Note: You can restore deleted packaged components using the CREATE operation. Refer to the section Using the CREATE operation for more details.

• You cannot delete a packaged component if it is already in use. If currently deployed, a packaged component is considered in use if it is used in the Process Library or as part of an integration pack.

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

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

}

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

      • "branchName": "string",
      • "componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
      • "componentType": "process",
      • "componentVersion": "2.0",
      • "createdBy": "userboomi.com",
      • "createdDate": "2017-03-16T13:34:01Z",
      • "deleted": "false",
      • "fullyPubliclyConsumable": true,
      • "notes": "Created for component publication with GUID f7f6ddb6-9437-4a90-9655-f01970068ca8 and version 2.",
      • "packageId": "e8dbc278-e970-49e5-84bd-af39d7d38140",
      • "packageVersion": "2.0",
      • "shareable": "true"

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

    }

  ]

}

Queries for a PackagedComponent 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

required	object
required PackagedComponentSimpleExpression (object) or PackagedComponentGroupingExpression (object) (PackagedComponentExpression) 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 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 (PackagedComponent)

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

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

      • {

        • "argument": [

          • "process"

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

        },
      • {

        • "argument": [

          • "66d665d1-3ec7-479c-9e24-8df3fa728cf8"

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

        },
      • {

        • "argument": [

          • "1.0"

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

        },
      • {

        • "argument": [

          • "true"

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

        },
      • {

        • "argument": [

          • "user@boomi.com"

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

        },
      • {

        • "argument": [

          • "2017-01-01T00:00:00Z",
          • "2017-11-02T00:00:00Z"

          ],
        • "operator": "BETWEEN",
        • "property": "createdDate"

        }

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "PackagedComponent",
    • "packageId": "a4543ff8-5acf-4090-8094-ec8dbb6a7406",
    • "packageVersion": "1.0",
    • "componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
    • "componentVersion": "2.0",
    • "componentType": "process",
    • "createdDate": "2017-01-12T17:29:55Z",
    • "createdBy": "user@boomi.com",
    • "notes": "Created for component publication with GUID xxx",
    • "shareable": true,
    • "deleted": true

    }

  ],
• "numberOfResults": 1

}

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

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "PackagedComponent",
    • "packageId": "a4543ff8-5acf-4090-8094-ec8dbb6a7406",
    • "packageVersion": "1.0",
    • "componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
    • "componentVersion": "2.0",
    • "componentType": "process",
    • "createdDate": "2017-01-12T17:29:55Z",
    • "createdBy": "user@boomi.com",
    • "notes": "Created for component publication with GUID xxx",
    • "shareable": true,
    • "deleted": true

    }

  ],
• "numberOfResults": 1

}