Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - GlobalVariableValue

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

GlobalVariableValue

The GlobalVariableValue object provides read-only access to the current value of a Global Variable for a specific environment. It allows retrieval and querying of per-environment variable values as they exist at the time of the request.

This API is read-only. Values are assigned through the GlobalVariableUpdateTransaction API, not directly via this endpoint.

Each VariableValue record represents the most recent assignment of a variable in an environment, and includes the current value, the previous value it replaced, a reference to the parent variable definition, and metadata about who made the last update and when. The object ID (variableValueId) is a compound ID in the format {envId}:{variableName}.

Account requirement: The GLOBAL_VARIABLES feature must be enabled on the account for this API to work. If it is not, all operations return 403 Forbidden with the message "Global Variable is inactive". To enable the feature, contact your Boomi Account representative.

Required privileges

You need these privileges in the target environment:

Write access

  • GLOBAL_VARIABLE_ASSIGN — Assign values to Global Variables for accessible environments

Read access

  • GLOBAL_VARIABLE_VALUE_VIEW — View non-encrypted values for accessible environments.

Note:
- Available on all runtime types.
- CREATE, PUT, and DELETE are not supported. To assign or update values, use the GlobalVariableUpdateTransaction API.
- A VariableValue record will only exist for a given variable or environment combination once a value has been explicitly assigned. Variables with no assigned value in an environment will not appear in query results.
- Encrypted variable values are not returned in plaintext — the variableValue field is masked for encrypted variables.

For more information, refer to the related APIs:

Retrieves an instance of a GlobalVariableValue object

Retrieves the current value of a specific variable in a specific environment.

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 3456789a-bcde-f012-3456-789abcdef012:MY_API_KEY

The compound ID of the variable value. Format: {envId}:{variableName}.

Responses

Response Schema:
required
object (GlobalVariableValue_SimpleGlobalVariable)

Reference to the parent GlobalVariable definition.

envId
string

The ID of the environment this value belongs to. Mandatory filter field on QUERY.

previousValue
string

The value that was in place before the most recent update transaction.

updateTransactionId
string

Compound ID of the GlobalVariableUpdateTransaction that last set this value. Format: {envId}:{numericTransactionId}.

updatedBy
string

Username/email of the user who last assigned a value via an update transaction.

updatedDate
string <date-time>

ISO 8601 timestamp of the most recent value assignment.

variableValue
string

The current value of the variable in this environment. Masked for encrypted variables.

variableValueId
string

Compound ID uniquely identifying this variable-environment pairing. Format: {envId}:{variableName}. Used as the path parameter for GET requests.

Response samples

Content type
{
  • "@type": "VariableValue",
  • "variableValueId": "3456789a-bcde-f012-3456-789abcdef012:MY_API_KEY",
  • "envId": "3456789a-bcde-f012-3456-789abcdef012",
  • "variableValue": "current-secret-value",
  • "previousValue": "old-secret-value",
  • "updateTransactionId": "3456789a-bcde-f012-3456-789abcdef012:42",
  • "updatedBy": "user@example.com",
  • "updatedDate": "2025-06-01T12:00:00Z",
  • "SimpleGlobalVariable": {
    • "name": "MY_API_KEY",
    • "encrypted": true
    }
}

Retrieves multiple GlobalVariableValue objects by identifier

Retrieves multiple variable values by compound ID in a single request. To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:
basicAuth
Request Body schema:
optional

List of GlobalVariableValue identifiers to retrieve.

Array of objects (BulkId)
type
string
Enum: "CREATE" "DELETE" "GET" "UPDATE"

Responses

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

Request samples

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

Response samples

Content type
{
  • "@type": "BulkResult",
  • "response": [
    • {
      },
    • {
      }
    ]
}

Queries for a GlobalVariableValue object(s)

Queries variable values across an environment with optional filters. envId is a mandatory filter using the EQUALS operator; queries without it are rejected. 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

Filter criteria for the GlobalVariableValue query.

required
object
object

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 (GlobalVariableValue_VariableValue)

Request samples

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

Response samples

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

Retrieves additional results for a GlobalVariableValue query

Retrieves the next page of query results. To learn about using queryMore, refer to the topic Query paging.

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

Query token from the previous query response used to retrieve the next page of results.

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 (GlobalVariableValue_VariableValue)

Request samples

Content type
text/plain
/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a....

Response samples

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