Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AccountGroup

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AccountGroup

The Account Group object represents an account group. For each account group, you can:

  • Retrieve the properties and resources
  • Query by name
  • Create new account groups
  • Update the properties of existing account groups

Note:

  • To facilitate the operations on this object in an integration process, use the Boomi Enterprise Platform Partner API connector instead of the Boomi Enterprise Platform API connector.
  • Resources information is returned only for the Get operation, not the Query operation.

Required Privileges

Read and Write access

  • API — Use the Boomi Platform API to access account data.
  • ACCOUNT_ADMIN — Account configuration and administration.

Creates an AccountGroup object

Creates an account group based on the supplied name.

Authorizations:
basicAuth
Request Body schema:
optional
object (Resources)
accountId
string

The ID of the primary account under which the account group exists.

autoSubscribeAlertLevel
string
Enum: "none" "info" "warning" "error"

The severity level of email alerts sent to member users in the account group.

defaultGroup
boolean

true — The account group is All Accounts, which the system creates automatically.
false — The account group is not All Accounts.

id
string

The ID of the account group.

name
string

The name of the account group as displayed on the Account Information tab of the Setup page.

Responses

Response Schema:
object (Resources)
accountId
string

The ID of the primary account under which the account group exists.

autoSubscribeAlertLevel
string
Enum: "none" "info" "warning" "error"

The severity level of email alerts sent to member users in the account group.

defaultGroup
boolean

true — The account group is All Accounts, which the system creates automatically.
false — The account group is not All Accounts.

id
string

The ID of the account group.

name
string

The name of the account group as displayed on the Account Information tab of the Setup page.

Request samples

Content type
{
  • "accountId": "*accountId*",
  • "name": "TestGroup",
  • "autoSubscribeAlertLevel": "none",
  • "defaultGroup": false,
  • "Resources": {
    • "@type": "Resources",
    • "Resource": [
      ]
    }
}

Response samples

Content type
{
  • "@type": "AccountGroup",
  • "autoSubscribeAlertLevel": "none",
  • "defaultGroup": false,
  • "name": "TestGroup",
  • "accountId": "account-123456",
  • "id": "fedcba98-7654-3210-fedc-ba9876543210",
  • "Resources": {
    • "@type": "Resources",
    • "Resource": [
      ]
    }
}

Retrieves an instance of an AccountGroup object

Returns a single Account Group object based on the supplied account group ID.

Note: Resources information is returned only for the Get operation, not the Query operation.

Authorizations:
basicAuth
path Parameters
id
required
string

The ID of the account group.

Responses

Response Schema:
object (Resources)
accountId
string

The ID of the primary account under which the account group exists.

autoSubscribeAlertLevel
string
Enum: "none" "info" "warning" "error"

The severity level of email alerts sent to member users in the account group.

defaultGroup
boolean

true — The account group is All Accounts, which the system creates automatically.
false — The account group is not All Accounts.

id
string

The ID of the account group.

name
string

The name of the account group as displayed on the Account Information tab of the Setup page.

Response samples

Content type
{
  • "@type": "AccountGroup",
  • "id": "fedcba98-7654-3210-fedc-ba9876543210",
  • "accountId": "account-123456",
  • "name": "Analyst Accounts",
  • "autoSubscribeAlertLevel": "none",
  • "defaultGroup": false,
  • "Resources": {
    • "@type": "Resources",
    • "Resource": [
      ]
    }
}

Modifies or updates an AccountGroup object

Updates an account group based on the supplied account group ID.

Authorizations:
basicAuth
path Parameters
id
required
string

The ID of the account group.

Request Body schema:
optional
object (Resources)
accountId
string

The ID of the primary account under which the account group exists.

autoSubscribeAlertLevel
string
Enum: "none" "info" "warning" "error"

The severity level of email alerts sent to member users in the account group.

defaultGroup
boolean

true — The account group is All Accounts, which the system creates automatically.
false — The account group is not All Accounts.

id
string

The ID of the account group.

name
string

The name of the account group as displayed on the Account Information tab of the Setup page.

Responses

Response Schema:
object (Resources)
accountId
string

The ID of the primary account under which the account group exists.

autoSubscribeAlertLevel
string
Enum: "none" "info" "warning" "error"

The severity level of email alerts sent to member users in the account group.

defaultGroup
boolean

true — The account group is All Accounts, which the system creates automatically.
false — The account group is not All Accounts.

id
string

The ID of the account group.

name
string

The name of the account group as displayed on the Account Information tab of the Setup page.

Request samples

Content type
{
  • "id": "fedcba98-7654-3210-fedc-ba9876543210",
  • "name": "TestGroupRenamed",
  • "accountId": "account-123456",
  • "autoSubscribeAlertLevel": "none",
  • "defaultGroup": false,
  • "Resources": {
    • "@type": "Resources",
    • "Resource": [
      ]
    }
}

Response samples

Content type
{
  • "@type": "AccountGroup",
  • "id": "fedcba98-7654-3210-fedc-ba9876543210",
  • "accountId": "account-123456",
  • "name": "TestGroupRenamed",
  • "autoSubscribeAlertLevel": "none",
  • "defaultGroup": false,
  • "Resources": {
    • "@type": "Resources",
    • "Resource": [
      ]
    }
}

Retrieves multiple AccountGroup 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 (AccountGroup)
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 AccountGroup 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: id, accountId, name, defaultGroup, autoSubscribeAlertLevel

required
object
required
AccountGroupSimpleExpression (object) or AccountGroupGroupingExpression (object) (AccountGroupExpression)
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: "id" "accountId" "name" "defaultGroup" "autoSubscribeAlertLevel"
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 (AccountGroup)

Request samples

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

Response samples

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

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

Response samples

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