Waiting for engine...
Skip to main content

Boomi Platform Partner API Reference (1.0.0) - Account

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Account

The Account object provides information about an account, including the associated users, connector licensing information, and general information.

Note: The ability to create and delete accounts is available only through the Platform Partner API.

Creates an Account object

  • The CREATE operation creates an account based on the supplied name and trial expiration date (maximum of 90 days in the future).

  • CREATE is available only through the Partner API; you cannot use the accountId override parameter. The Partner API also supports a separate Account Provision operation for provisioning sub-accounts with specified features.

Note: You cannot use the CREATE operation to provision or dictate the number of Runtime clusters available on an account.

Authorizations:
basicAuth
query Parameters
overrideAccount
string

Makes the inquiry on a child account

Request Body schema:
optional
accountId
string

The ID of the account.

dateCreated
string

The creation date of the account.

expirationDate
string

The scheduled expiration date of the account.

object (Licensing)

Indicates the number of connections used and purchased in each of the connector type and production/test classifications. The classifications include standard, smallBusiness, enterprise, and tradingPartner.

object (Molecule)

Indicates the number of Runtime clusters available on an account and the number of Runtime clusters currently in use.

name
string

The name of the account.

overDeployed
boolean

Indicates the state of an account if one or more additional deployments are made after all available connection licenses have been used for any of the connector class.

status
string
Enum: "trial" "active" "suspended" "deleted" "unlimited"

The status of the account. The allowed values are active or deleted.

suggestionsEnabled
boolean

Identifies whether this account has the Boomi Suggest feature enabled.

supportAccess
boolean

Identifies whether this account allows support user access.

supportLevel
string
Enum: "standard" "premier"

The level of support for this account. The allowed values are standard *or premier.

widgetAccount
boolean

Responses

Response Schema:
accountId
string

The ID of the account.

dateCreated
string

The creation date of the account.

expirationDate
string

The scheduled expiration date of the account.

object (Licensing)

Indicates the number of connections used and purchased in each of the connector type and production/test classifications. The classifications include standard, smallBusiness, enterprise, and tradingPartner.

object (Molecule)

Indicates the number of Runtime clusters available on an account and the number of Runtime clusters currently in use.

name
string

The name of the account.

overDeployed
boolean

Indicates the state of an account if one or more additional deployments are made after all available connection licenses have been used for any of the connector class.

status
string
Enum: "trial" "active" "suspended" "deleted" "unlimited"

The status of the account. The allowed values are active or deleted.

suggestionsEnabled
boolean

Identifies whether this account has the Boomi Suggest feature enabled.

supportAccess
boolean

Identifies whether this account allows support user access.

supportLevel
string
Enum: "standard" "premier"

The level of support for this account. The allowed values are standard *or premier.

widgetAccount
boolean

Request samples

Content type
{
  • "name": "Test Account",
  • "expirationDate": "2016-02-13T05:00:00Z"
}

Response samples

Content type
{
  • "Account": {
    • "supportLevel": "standard",
    • "supportAccess": "true",
    • "dateCreated": "2015-02-06T15:42:10Z",
    • "status": "active",
    • "expirationDate": "2016-02-13T05:00:00Z",
    • "name": "Test Account",
    • "accountId": "testaccount-W4N2RM",
    • "licensing": null
    }
}

Retrieves multiple Account objects by identifier

The bulk GET operation returns multiple Account objects based on the supplied account IDs, to a maximum of 100. To learn more about bulk, refer to Bulk GET operations.

Authorizations:
basicAuth
query Parameters
overrideAccount
string

Makes the inquiry on a child account

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

Responses

Response Schema:
Array of objects
Array
required
object (Account)
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 Account object(s)

The maximum number of results returned per QUERY response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.

Authorizations:
basicAuth
query Parameters
overrideAccount
string

Makes the inquiry on a child account

Request Body schema:
optional

Possible properties include: ACCOUNTID, DATECREATED, EXPIRATIONDATE, NAME, STATUS, WIDGETACCOUNT, OVERDEPLOYED

required
object
required
AccountSimpleExpression (object) or AccountGroupingExpression (object) (AccountExpression)
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: "ACCOUNTID" "DATECREATED" "EXPIRATIONDATE" "NAME" "STATUS" "WIDGETACCOUNT" "OVERDEPLOYED"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string
Array of objects (Account)

Request samples

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

Response samples

Content type
{
  • "QueryResult": {
    • "numberOfResults": "100",
    • "queryToken": "EXAMPLE_QUERY_TOKEN",
    • "result": [
      ]
    }
}

Retrieves additional results for an Account query

To learn about using queryMore, refer to Query paging.

Authorizations:
basicAuth
query Parameters
overrideAccount
string

Makes the inquiry on a child account

Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string
Array of objects (Account)

Response samples

Content type
{
  • "QueryResult": {
    • "numberOfResults": "100",
    • "queryToken": "EXAMPLE_QUERY_TOKEN",
    • "result": [
      ]
    }
}

Retrieves an instance of an Account object

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

Authorizations:
basicAuth
path Parameters
id
required
string
query Parameters
overrideAccount
string

Makes the inquiry on a child account

Responses

Response Schema:
accountId
string

The ID of the account.

dateCreated
string

The creation date of the account.

expirationDate
string

The scheduled expiration date of the account.

object (Licensing)

Indicates the number of connections used and purchased in each of the connector type and production/test classifications. The classifications include standard, smallBusiness, enterprise, and tradingPartner.

object (Molecule)

Indicates the number of Runtime clusters available on an account and the number of Runtime clusters currently in use.

name
string

The name of the account.

overDeployed
boolean

Indicates the state of an account if one or more additional deployments are made after all available connection licenses have been used for any of the connector class.

status
string
Enum: "trial" "active" "suspended" "deleted" "unlimited"

The status of the account. The allowed values are active or deleted.

suggestionsEnabled
boolean

Identifies whether this account has the Boomi Suggest feature enabled.

supportAccess
boolean

Identifies whether this account allows support user access.

supportLevel
string
Enum: "standard" "premier"

The level of support for this account. The allowed values are standard *or premier.

widgetAccount
boolean

Response samples

Content type
{
  • "Account": {
    • "accountId": "boomiqa-T7KIDU",
    • "name": "BoomiQA",
    • "status": "active",
    • "dateCreated": "2022-09-02T20:16:28Z",
    • "widgetAccount": "false",
    • "supportAccess": "true",
    • "supportLevel": "standard",
    • "licensing": {
      },
    • "molecule": {
      }
    }
}

Deletes an Account object

  • The DELETE operation deletes an account based on the supplied account ID.

  • The DELETE operation is available only through the Partner API; you cannot use the accountId override parameter.

Authorizations:
basicAuth
path Parameters
id
required
string
query Parameters
overrideAccount
string

Makes the inquiry on a child account

Responses

Response samples

Content type
{
  • "message": "Operation completed successfully."
}