Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - Environment

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Environment

The Environment object represents an environment. For accounts with Unlimited environment support, you can classify environments as either Production or Test. For accounts with Basic environment support, the classification of all environments as Production.

Note: The fields in the Environment object correspond to controls in the Environments panel of the Runtime Management page.

Required Privileges

You need these privileges in the target environment:

Write access

  • API — Use the Boomi Platform API to access account data.
  • ATOM_MANAGEMENT — Configure and administer integration runtimes.

Read access

  • API — Use the Boomi Platform API to access account data.
  • ATOM_MANAGEMENT — Configure and administer integration runtimes.
  • ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration.

Creates an Environment object

Creates an environment having the specified name. Environment names must be unique.

Authorizations:
basicAuth
Request Body schema:
optional
classification
string
Enum: "PROD" "TEST"

(Optional) For accounts with Unlimited environment support, the type of environment.The choices are PROD (Production) and TEST. The environment classification determines the type of license used when deploying a process to the environment. The default classification is PROD.
You can assign the value TEST only if the requesting account has Test Connection Licensing enabled.
You can set the classification only when you add an environment. You cannot change the classification later.
Environments added prior to the January 2014 release have their classification set to PROD.

Note: The classification field is invalid for requests from accounts with Basic environment support because all environments are production environments.

id
string

A unique ID assigned by the system to the environment.

name
string

A user-defined name for the environment.

parentAccount
string
parentEnvironment
string

Responses

Response Schema:
classification
string
Enum: "PROD" "TEST"

(Optional) For accounts with Unlimited environment support, the type of environment.The choices are PROD (Production) and TEST. The environment classification determines the type of license used when deploying a process to the environment. The default classification is PROD.
You can assign the value TEST only if the requesting account has Test Connection Licensing enabled.
You can set the classification only when you add an environment. You cannot change the classification later.
Environments added prior to the January 2014 release have their classification set to PROD.

Note: The classification field is invalid for requests from accounts with Basic environment support because all environments are production environments.

id
string

A unique ID assigned by the system to the environment.

name
string

A user-defined name for the environment.

parentAccount
string
parentEnvironment
string

Request samples

Content type
{
  • "name": "My Production Environment",
  • "classification": "PROD"
}

Response samples

Content type
{
  • "@type": "Environment",
  • "id": "456789ab-cdef-0123-4567-89abcdef0123",
  • "name": "My Production Environment",
  • "classification": "PROD"
}

Retrieves an instance of an Environment object

Retrieves the properties of the environment with a specified ID.

Authorizations:
basicAuth
path Parameters
id
required
string

A unique ID assigned by the system to the environment.

Responses

Response Schema:
classification
string
Enum: "PROD" "TEST"

(Optional) For accounts with Unlimited environment support, the type of environment.The choices are PROD (Production) and TEST. The environment classification determines the type of license used when deploying a process to the environment. The default classification is PROD.
You can assign the value TEST only if the requesting account has Test Connection Licensing enabled.
You can set the classification only when you add an environment. You cannot change the classification later.
Environments added prior to the January 2014 release have their classification set to PROD.

Note: The classification field is invalid for requests from accounts with Basic environment support because all environments are production environments.

id
string

A unique ID assigned by the system to the environment.

name
string

A user-defined name for the environment.

parentAccount
string
parentEnvironment
string

Response samples

Content type
{
  • "@type": "Environment",
  • "id": "456789ab-cdef-0123-4567-89abcdef0123",
  • "name": "My Production Environment",
  • "classification": "PROD"
}

Modifies or updates an Environment object

Updates the Environment object having the specified ID. You can edit the name field only.

Authorizations:
basicAuth
path Parameters
id
required
string

A unique ID assigned by the system to the environment.

Request Body schema:
optional
classification
string
Enum: "PROD" "TEST"

(Optional) For accounts with Unlimited environment support, the type of environment.The choices are PROD (Production) and TEST. The environment classification determines the type of license used when deploying a process to the environment. The default classification is PROD.
You can assign the value TEST only if the requesting account has Test Connection Licensing enabled.
You can set the classification only when you add an environment. You cannot change the classification later.
Environments added prior to the January 2014 release have their classification set to PROD.

Note: The classification field is invalid for requests from accounts with Basic environment support because all environments are production environments.

id
string

A unique ID assigned by the system to the environment.

name
string

A user-defined name for the environment.

parentAccount
string
parentEnvironment
string

Responses

Response Schema:
classification
string
Enum: "PROD" "TEST"

(Optional) For accounts with Unlimited environment support, the type of environment.The choices are PROD (Production) and TEST. The environment classification determines the type of license used when deploying a process to the environment. The default classification is PROD.
You can assign the value TEST only if the requesting account has Test Connection Licensing enabled.
You can set the classification only when you add an environment. You cannot change the classification later.
Environments added prior to the January 2014 release have their classification set to PROD.

Note: The classification field is invalid for requests from accounts with Basic environment support because all environments are production environments.

id
string

A unique ID assigned by the system to the environment.

name
string

A user-defined name for the environment.

parentAccount
string
parentEnvironment
string

Request samples

Content type
{
  • "id": "456789ab-cdef-0123-4567-89abcdef0123",
  • "name": "Our Production Environment",
  • "classification": "PROD"
}

Response samples

Content type
{
  • "@type": "Environment",
  • "id": "456789ab-cdef-0123-4567-89abcdef0123",
  • "name": "Our Production Environment",
  • "classification": "PROD"
}

Deletes an Environment object

Deletes the Environment object with a specified ID. It is not possible to delete an environment that has attached Runtimes or integration packs.

Authorizations:
basicAuth
path Parameters
id
required
string

A unique ID assigned by the system to the environment.

Responses

Response samples

Content type
{
  • "message": "Access denied due to insufficient permissions."
}

Retrieves multiple Environment 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 (Environment)
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 Environment 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, classification

required
object
required
EnvironmentSimpleExpression (object) or EnvironmentGroupingExpression (object) (EnvironmentExpression)
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" "classification"
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 (Environment)

Request samples

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

Response samples

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

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

Response samples

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