Boomi Platform API Reference (1.0.0) - PublisherIntegrationPack

Toggle Pane

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

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

PublisherIntegrationPack

The PublisherIntegrationPack object represents the integration packs created in a parent or publisher account. Using the PublisherIntegrationPack object, you can retrieve details of integration packs and packaged components available to the publisher account.

You can perform the following operations using the PublisherIntegrationPack object:

• create, retrieve, update, query, and delete the integration packs
• retrieve and update the packaged components.

  Note: To use the PublisherIntegrationPack API, the account-level features, Publisher Integration Pack and Integration Pack must be enabled. For more information, contact your Boomi representative.

Creates a PublisherIntegrationPack object

Creates a single attachment or multiple attachment integration pack.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

Description required	string
	object (PublisherPackagedComponents)
id	string A unique ID assigned by the system to the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
name	string The name of the integration pack.
operationType	string Enum: "ADD" "DELETE" Specifies the type of operation (ADD or DELETE) to perform when updating the packaged component to the integration pack. This field is mandatory for the Update operation and is not available for other operations

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

Description required	string
	object (PublisherPackagedComponents)
id	string A unique ID assigned by the system to the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
name	string The name of the integration pack.
operationType	string Enum: "ADD" "DELETE" Specifies the type of operation (ADD or DELETE) to perform when updating the packaged component to the integration pack. This field is mandatory for the Update operation and is not available for other operations

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "installationType": "SINGLE",
• "name": "IPACK-JSON",
• "Description": "Single Ipack"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "PublisherIntegrationPack",
• "Description": "Single Ipack",
• "id": "2e8e7a47-eb93-4292-82f9-1b95dc8daa53",
• "name": "IPACK-JSON",
• "installationType": "SINGLE",
• "operationType": "ADD",
• "PublisherPackagedComponents": {

  • "@type": "PublisherPackagedComponents",
  • "PublisherPackagedComponent": [

    • {

      • "@type": "PublisherPackagedComponent",
      • "componentId": "76742659-845c-45e4-bb9f-d63ff998f658",
      • "componentName": "New Process 4",
      • "componentType": "process",
      • "currentVersion": "1.0",
      • "pendingVersion": "",
      • "deleted": true,
      • "latestVersion": ""

      },
    • {

      • "@type": "PublisherPackagedComponent",
      • "componentId": "fa0211d4-d417-4230-b695-c78846c6e83d",
      • "componentName": "New Process 2",
      • "componentType": "process",
      • "currentVersion": "1.0",
      • "pendingVersion": "",
      • "deleted": true,
      • "latestVersion": ""

      }

    ]

  }

}

Retrieves an instance of a PublisherIntegrationPack object

Retrieves the details of the integration pack and packaged components. The standard GET operation retrieves the properties of the integration pack with a specified ID. The bulk GET operation retrieves the properties of the integration packs with the specified IDs to a maximum of 100.

Authorizations:

basicAuth

path Parameters

id required

string A unique ID assigned by the system to the integration pack.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

Description required	string
	object (PublisherPackagedComponents)
id	string A unique ID assigned by the system to the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
name	string The name of the integration pack.
operationType	string Enum: "ADD" "DELETE" Specifies the type of operation (ADD or DELETE) to perform when updating the packaged component to the integration pack. This field is mandatory for the Update operation and is not available for other operations

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "PublisherIntegrationPack",
• "Description": "",
• "PublisherPackagedComponents": {

  • "@type": "PublisherPackagedComponents",
  • "PublisherPackagedComponent": [

    • {

      • "@type": "PublisherPackagedComponent",
      • "componentId": "76742659-845c-45e4-bb9f-d63ff998f658",
      • "componentName": "New Process 4",
      • "componentType": "process",
      • "currentVersion": "1.0",
      • "pendingVersion": "",
      • "deleted": true,
      • "latestVersion": ""

      },
    • {

      • "@type": "PublisherPackagedComponent",
      • "componentId": "fa0211d4-d417-4230-b695-c78846c6e83d",
      • "componentName": "New Process 2",
      • "componentType": "process",
      • "currentVersion": "1.0",
      • "pendingVersion": "",
      • "deleted": true,
      • "latestVersion": ""

      }

    ]

  },
• "id": "d7c16f5d-3311-417e-a149-3c55436f7d8d",
• "name": "perf testing ipack",
• "installationType": "MULTI",
• "operationType": "ADD"

}

Modifies or updates a PublisherIntegrationPack object

The Update operation adds or removes the packaged components from the publisher integration pack. It also updates the description field of single and multiple attachment integration packs and the name field only for a single attachment integration pack.

Note: When updating an integration pack, you must include all the packaged components associated with it in the request body. If a packaged component is not included, it will be deleted upon updating an integration pack. For example, include all packaged components while updating the integration pack name.

Authorizations:

basicAuth

path Parameters

id required

string

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

Description required	string
	object (PublisherPackagedComponents)
id	string A unique ID assigned by the system to the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
name	string The name of the integration pack.
operationType	string Enum: "ADD" "DELETE" Specifies the type of operation (ADD or DELETE) to perform when updating the packaged component to the integration pack. This field is mandatory for the Update operation and is not available for other operations

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

Description required	string
	object (PublisherPackagedComponents)
id	string A unique ID assigned by the system to the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
name	string The name of the integration pack.
operationType	string Enum: "ADD" "DELETE" Specifies the type of operation (ADD or DELETE) to perform when updating the packaged component to the integration pack. This field is mandatory for the Update operation and is not available for other operations

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "Description": "description update",
• "PublisherPackagedComponents": {

  • "PublisherPackagedComponent": [

    • {

      • "componentId": "6d7c05f6-cb29-41c7-8bac-b9e57b3b9783"

      }

    ]

  },
• "id": "e7b60a7c-559a-4904-9a52-d724f2d967b4",
• "name": "single_Ipack",
• "installationType": "SINGLE",
• "operationType": "ADD"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "PublisherIntegrationPack",
• "Description": "description update",
• "PublisherPackagedComponents": {

  • "@type": "PublisherPackagedComponents",
  • "PublisherPackagedComponent": [

    • {

      • "@type": "PublisherPackagedComponent",
      • "componentId": "6d7c05f6-cb29-41c7-8bac-b9e57b3b9783",
      • "componentName": "New Process 7",
      • "componentType": "process",
      • "currentVersion": "",
      • "pendingVersion": "1.0",
      • "deleted": true,
      • "latestVersion": ""

      },
    • {

      • "@type": "PublisherPackagedComponent",
      • "componentId": "c7d8653d-81ff-4fcc-b814-49e148fc4024",
      • "componentName": "Cleanse",
      • "componentType": "process",
      • "currentVersion": "",
      • "pendingVersion": "cleanse process",
      • "deleted": true,
      • "latestVersion": ""

      },
    • {

      • "@type": "PublisherPackagedComponent",
      • "componentId": "b2780aad-f5af-44e8-9b5b-f4823b363284",
      • "componentName": "New Process 3",
      • "componentType": "process",
      • "currentVersion": "",
      • "pendingVersion": "test",
      • "deleted": true,
      • "latestVersion": ""

      }

    ]

  },
• "id": "e7b60a7c-559a-4904-9a52-d724f2d967b4",
• "name": "single_Ipack",
• "installationType": "SINGLE",
• "operationType": "ADD"

}

Deletes a PublisherIntegrationPack object

Deletes the publisher integration pack having a specified ID from the requesting account. The deleted integration pack is automatically uninstalled from all accounts where it was installed. Any Runtimes or environments attached to the integration pack are also detached.

Authorizations:

basicAuth

path Parameters

id required

string A unique ID assigned by the system to the integration pack.

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

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

}

Retrieves multiple PublisherIntegrationPack objects by identifier

The bulk GET operation returns multiple objects based on the supplied account IDs, to a maximum of 100. To learn more about bulk, refer to 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/xmlexampleapplication/json

	Array of objects
Array required object (PublisherIntegrationPack) 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}/PublisherIntegrationPack/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "type": "GET",
• "request": [

  • {

    • "id": "b9875167-ddbd-4c5f-a77d-327589b52bf8"

    },
  • {

    • "id": "not_a_real_package_id"

    }

  ]

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlexampleapplication/json

{

• "@type": "BulkResult",
• "response": [

  • {

    • "@type": "BulkResponse",
    • "Result": {

      • "@type": "PublisherIntegrationPack",
      • "Description": "",
      • "PublisherPackagedComponents": {

        • "@type": "PublisherPackagedComponents",
        • "PublisherPackagedComponent": [

          • {

            • "@type": "PublisherPackagedComponent",
            • "componentId": "c7d8653d-81ff-4fcc-b814-49e148fc4024",
            • "componentName": "Cleanse",
            • "componentType": "process",
            • "currentVersion": "",
            • "pendingVersion": "cleanse process",
            • "deleted": true,
            • "latestVersion": ""

            },
          • {

            • "@type": "PublisherPackagedComponent",
            • "componentId": "b2780aad-f5af-44e8-9b5b-f4823b363284",
            • "componentName": "New Process 3",
            • "componentType": "process",
            • "currentVersion": "",
            • "pendingVersion": "test",
            • "deleted": true,
            • "latestVersion": ""

            }

          ]

        },
      • "id": "b9875167-ddbd-4c5f-a77d-327589b52bf8",
      • "name": "test multi",
      • "installationType": "MULTI",
      • "operationType": "ADD"

      },
    • "statusCode": 200

    },
  • {

    • "@type": "BulkResponse",
    • "id": "not_a_real_package_id",
    • "statusCode": 400,
    • "errorMessage": "Integration pack ID not_a_real_package_id is invalid. Provide a valid integration pack ID to complete this action."

    }

  ]

}

Queries for a PublisherIntegrationPack 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: name, id, installationType

required

object

required PublisherIntegrationPackSimpleExpression (object) or PublisherIntegrationPackGroupingExpression (object) (PublisherIntegrationPackExpression) 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: "name" "id" "installationType" argument Array of strings id string name string status string object

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

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "argument": [

      • "SINGLE"

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

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "PublisherIntegrationPack",
    • "Description": "Ipack description",
    • "PublisherPackagedComponents": {

      • "@type": "PublisherPackagedComponents",
      • "PublisherPackagedComponent": [

        • {

          • "@type": "PublisherPackagedComponent",
          • "componentId": "62f7ffb7-5332-4142-893a-8d40d4742ccf",
          • "componentName": "Rate Limit Test",
          • "componentType": "process",
          • "currentVersion": "",
          • "pendingVersion": "1.0",
          • "deleted": true,
          • "latestVersion": ""

          },
        • {

          • "@type": "PublisherPackagedComponent",
          • "componentId": "bb0dae4f-c8f3-47fa-9dee-c3c484f79f71",
          • "componentName": "New Process 4",
          • "componentType": "process",
          • "currentVersion": "",
          • "pendingVersion": "3.0",
          • "deleted": true,
          • "latestVersion": ""

          }

        ]

      },
    • "id": "664cc077-28a8-42cb-ac6e-1cb131c9e0d0",
    • "name": "IPACK-JSON",
    • "installationType": "SINGLE",
    • "operationType": "ADD"

    },
  • {

    • "@type": "PublisherIntegrationPack",
    • "Description": "",
    • "PublisherPackagedComponents": {

      • "@type": "PublisherPackagedComponents",
      • "PublisherPackagedComponent": [

        • {

          • "@type": "PublisherPackagedComponent",
          • "componentId": "62f7ffb7-5332-4142-893a-8d40d4742ccf",
          • "componentName": "Rate Limit Test",
          • "componentType": "process",
          • "currentVersion": "",
          • "pendingVersion": "1.0",
          • "deleted": true,
          • "latestVersion": ""

          },
        • {

          • "@type": "PublisherPackagedComponent",
          • "componentId": "bb0dae4f-c8f3-47fa-9dee-c3c484f79f71",
          • "componentName": "New Process 4",
          • "componentType": "process",
          • "currentVersion": "",
          • "pendingVersion": "3.0",
          • "deleted": true,
          • "latestVersion": ""

          }

        ]

      },
    • "id": "8b80f83b-9836-49a0-8c72-753131a77bae",
    • "name": "test single",
    • "installationType": "SINGLE",
    • "operationType": "ADD"

    }

  ],
• "numberOfResults": 2

}

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

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "PublisherIntegrationPack",
    • "Description": "Ipack description",
    • "PublisherPackagedComponents": {

      • "@type": "PublisherPackagedComponents",
      • "PublisherPackagedComponent": [ ]

      },
    • "id": "664cc077-28a8-42cb-ac6e-1cb131c9e0d0",
    • "name": "IPACK-JSON",
    • "installationType": "SINGLE"

    },
  • {

    • "@type": "PublisherIntegrationPack",
    • "Description": "",
    • "PublisherPackagedComponents": {

      • "@type": "PublisherPackagedComponents",
      • "PublisherPackagedComponent": [

        • {

          • "@type": "PublisherPackagedComponent",
          • "componentId": "62f7ffb7-5332-4142-893a-8d40d4742ccf",
          • "componentName": "Rate Limit Test",
          • "componentType": "process",
          • "currentVersion": "",
          • "pendingVersion": "1.0",
          • "deleted": true,
          • "latestVersion": ""

          },
        • {

          • "@type": "PublisherPackagedComponent",
          • "componentId": "bb0dae4f-c8f3-47fa-9dee-c3c484f79f71",
          • "componentName": "New Process 4",
          • "componentType": "process",
          • "currentVersion": "",
          • "pendingVersion": "3.0",
          • "deleted": true,
          • "latestVersion": ""

          }

        ]

      },
    • "id": "8b80f83b-9836-49a0-8c72-753131a77bae",
    • "name": "test single",
    • "installationType": "SINGLE",
    • "operationType": "ADD"

    }

  ],
• "numberOfResults": 2

}