Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - IntegrationPack

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

IntegrationPack

The Integration Pack object represents an integration pack. You can query the Integration Pack object to determine the integration packs available to a secondary account This object does not return the integration packs created in the primary or publisher account.

Required Privileges

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.

Retrieves an instance of an IntegrationPack object

Retrieves the properties of the integration pack with a specified ID. The ordinary GET operation retrieves the properties of the integration pack with a specified ID. The bulk GET operation retrieves the properties of the integration packs having 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:
Description
required
string

A description of the integration pack.

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-attach
- MULTI — multi-attach

name
string

The name of the integration pack.

Response samples

Content type
{
  • "@type": "IntegrationPack",
  • "Description": "Order Intake Ipack",
  • "id": "89abcdef-0123-4567-89ab-cdef01234567",
  • "name": "Order Intake",
  • "installationType": "SINGLE"
}

Retrieves multiple IntegrationPack objects by identifier

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

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (IntegrationPack)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for an IntegrationPack 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:
optional

Possible properties include: name, id, installationType

required
object
required
IntegrationPackSimpleExpression (object) or IntegrationPackGroupingExpression (object) (IntegrationPackExpression)
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

Responses

Response Schema:
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 (IntegrationPack)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "numberOfResults": 2,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}

Retrieves additional results for an IntegrationPack query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
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 (IntegrationPack)

Response samples

Content type
{
  • "numberOfResults": 2,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}