Boomi Platform API Reference (1.0.0) - AccountGroupIntegrationPack

Toggle Pane

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

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AccountGroupIntegrationPack

The AccountGroupIntegrationPack object represents an integration pack resource for existing account groups. You can retrieve, add, query, or remove the publisher integration packs from the account groups.

Required Privileges

Read and Write access

• API Publisher Integration Pack
• Integration Pack
• Account Group Management

Creates an AccountGroupIntegrationPack object

Adds an integration pack to the requesting account group.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

accountGroupId	string The ID of the account group.
id	string A unique ID assigned by the system to the integration pack. This field populates only if you add the integration pack to an account group.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
integrationPackId	string A unique ID assigned by the system to the integration pack.
integrationPackName	string The name of the integration pack.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

accountGroupId	string The ID of the account group.
id	string A unique ID assigned by the system to the integration pack. This field populates only if you add the integration pack to an account group.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
integrationPackId	string A unique ID assigned by the system to the integration pack.
integrationPackName	string The name of the 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}/AccountGroupIntegrationPack

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "integrationPackId": "fc32f440-9a53-45ce-bd6b-014755dadb64",
• "accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AccountGroupIntegrationPack",
• "id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE",
• "integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
• "integrationPackName": "test integration pack",
• "installationType": "SINGLE",
• "accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"

}

Retrieves an instance of an AccountGroupIntegrationPack object

The ordinary GET operation retrieves the properties of the AccountGroupIntegrationPack with the specified ID. The bulk GET operation retrieves the properties of the AccountGroupIntegrationPack with the specified IDs to a maximum of 100. You can obtain AccountGroupIntegrationPack IDs from the QUERY operation.

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

accountGroupId	string The ID of the account group.
id	string A unique ID assigned by the system to the integration pack. This field populates only if you add the integration pack to an account group.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
integrationPackId	string A unique ID assigned by the system to the integration pack.
integrationPackName	string The name of the 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}/AccountGroupIntegrationPack/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AccountGroupIntegrationPack",
• "id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE",
• "integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
• "integrationPackName": "test integration pack",
• "installationType": "SINGLE",
• "accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"

}

Deletes an AccountGroupIntegrationPack object

Removes the integration pack with a specified ID from the requesting account group. You can obtain this ID from a QUERY operation.

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

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

}

Retrieves multiple AccountGroupIntegrationPack 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/xmlapplication/json

	Array of objects
Array required object (AccountGroupIntegrationPack) 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}/AccountGroupIntegrationPack/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": {

      • "accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
      • "id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE",
      • "installationType": "SINGLE",
      • "integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
      • "integrationPackName": "test integration pack"

      },
    • "index": "123",
    • "id": "string",
    • "statusCode": "200",
    • "errorMessage": "string"

    }

  ]

}

Queries for an AccountGroupIntegrationPack object(s)

Retrieves all integration packs available to the requesting account group ID.

For general information about the structure of QUERY filters and how to handle paged results, refer to the Query filters and Query paging topics.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

Possible properties include: accountGroupId

required

object

required AccountGroupIntegrationPackSimpleExpression (object) or AccountGroupIntegrationPackGroupingExpression (object) (AccountGroupIntegrationPackExpression) 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 Value: "accountGroupId" argument Array of strings id string A unique ID assigned by the system to the integration pack. This field populates only if you add the integration pack to an account group. name string The name of the integration pack. 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 (AccountGroupIntegrationPack)

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "argument": [

      • "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"

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

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "AccountGroupIntegrationPack",
    • "accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
    • "integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
    • "integrationPackName": "test integration pack",
    • "installationType": "SINGLE",
    • "id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE"

    },
  • {

    • "@type": "AccountGroupIntegrationPack",
    • "accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
    • "integrationPackId": "fc32f440-9a53-45ce-bd6b-014755dadb64",
    • "integrationPackName": "New update Ipac",
    • "installationType": "MULTI",
    • "id": "MTJ8Y2QxN2Y4NjYtYzI0Ny00YzU0LWExYTEtZWE4ZjhmODZhMWQx"

    }

  ],
• "numberOfResults": 2

}

Retrieves additional results for an AccountGroupIntegrationPack 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 (AccountGroupIntegrationPack)

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "AccountGroupIntegrationPack",
    • "accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
    • "integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
    • "integrationPackName": "test integration pack",
    • "installationType": "SINGLE",
    • "id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE"

    },
  • {

    • "@type": "AccountGroupIntegrationPack",
    • "accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
    • "integrationPackId": "fc32f440-9a53-45ce-bd6b-014755dadb64",
    • "integrationPackName": "New update Ipac",
    • "installationType": "MULTI",
    • "id": "MTJ8Y2QxN2Y4NjYtYzI0Ny00YzU0LWExYTEtZWE4ZjhmODZhMWQx"

    }

  ],
• "numberOfResults": 2

}