Boomi Platform API Reference (1.0.0) - GlobalVariableValue
UpdatedDownload OpenAPI Specification: Download
For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.
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 URL-safe Base64-encoded compound ID. The decoded value has the format {envId}:{variableName}. For example, 3456789a-bcde-f012-3456-789abcdef012:MY_API_KEY is encoded as MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOk1ZX0FQSV9LRVk. Pass the encoded value as the id in GET and bulk requests.
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 theGlobalVariableUpdateTransactionAPI.
- 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:
- GlobalVariable — Defines the variable (name, encrypted flag, description, status). Must exist before a value can be assigned.
- GlobalVariableUpdateTransaction — Audit trail of value assignment events.
Retrieves an instance of a GlobalVariableValue object
Retrieves the current value of a specific variable in a specific environment.
Authorizations:
path Parameters
| id required | string Example: MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOk1ZX0FQSV9LRVk The URL-safe Base64-encoded compound ID of the variable value. The decoded value has the format |
Responses
Response Schema:
required | object (GlobalVariableValue_SimpleGlobalVariable) Reference to the parent GlobalVariable definition. |
| updatedDate | string <date-time> ISO 8601 timestamp of the most recent value assignment. |
| updatedBy | string Username/email of the user who last assigned a value via an update transaction. |
| variableValue | string The current value of the variable in this environment. Masked for encrypted variables. |
| variableValueId | string URL-safe Base64-encoded compound ID uniquely identifying this variable-environment pairing. The decoded value has the format |
| envId | string The ID of the environment this value belongs to. Mandatory filter field on QUERY. |
| updateTransactionId | string URL-safe Base64-encoded compound ID of the GlobalVariableUpdateTransaction that last set this value. The decoded value has the format |
| previousValue | string The value that was in place before the most recent update transaction. |
Response samples
- 200
- 403
- 410
- 503
{- "@type": "VariableValue",
- "variableValueId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOk1ZX0FQSV9LRVk",
- "envId": "3456789a-bcde-f012-3456-789abcdef012",
- "variableValue": "current-secret-value",
- "previousValue": "old-secret-value",
- "updateTransactionId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOjQy",
- "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 their Base64-encoded compound IDs in a single request. To learn more about bulk, refer to the topic Bulk GET operations.
Authorizations:
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
| |||||||||||
Request samples
- Payload
{- "type": "GET",
- "request": [
- {
- "id": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOk1ZX0FQSV9LRVk"
}, - {
- "id": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOkRCX1BBU1NXT1JE"
}
]
}Response samples
- 200
- 403
- 410
- 503
{- "@type": "BulkResult",
- "response": [
- {
- "index": 0,
- "id": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOk1ZX0FQSV9LRVk",
- "statusCode": 200,
- "Result": {
- "@type": "VariableValue",
- "variableValueId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOk1ZX0FQSV9LRVk",
- "envId": "3456789a-bcde-f012-3456-789abcdef012",
- "variableValue": "current-secret-value",
- "previousValue": "old-secret-value",
- "updateTransactionId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOjQy",
- "updatedBy": "user@example.com",
- "updatedDate": "2025-06-01T12:00:00Z",
- "SimpleGlobalVariable": {
- "name": "MY_API_KEY",
- "encrypted": true
}
}
}, - {
- "index": 1,
- "id": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOkRCX1BBU1NXT1JE",
- "statusCode": 200,
- "Result": {
- "@type": "VariableValue",
- "variableValueId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOkRCX1BBU1NXT1JE",
- "envId": "3456789a-bcde-f012-3456-789abcdef012",
- "variableValue": "current-db-password",
- "previousValue": "old-db-password",
- "updateTransactionId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOjQz",
- "updatedBy": "user@example.com",
- "updatedDate": "2025-06-02T12:00:00Z",
- "SimpleGlobalVariable": {
- "name": "DB_PASSWORD",
- "encrypted": true
}
}
}
]
}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:
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
- Payload
{- "QueryFilter": {
- "expression": {
- "operator": "EQUALS",
- "property": "envId",
- "argument": [
- "3456789a-bcde-f012-3456-789abcdef012"
]
}
}
}Response samples
- 200
- 403
- 410
- 503
{- "@type": "QueryResult",
- "result": [
- {
- "@type": "VariableValue",
- "variableValueId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOk1ZX0FQSV9LRVk",
- "envId": "3456789a-bcde-f012-3456-789abcdef012",
- "variableValue": "current-secret-value",
- "previousValue": "old-secret-value",
- "updateTransactionId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOjQy",
- "updatedBy": "user@example.com",
- "updatedDate": "2025-06-01T12:00:00Z",
- "SimpleGlobalVariable": {
- "name": "MY_API_KEY",
- "encrypted": true
}
}
], - "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:
Request Body schema: text/plainrequired
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
- Payload
/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a....
Response samples
- 200
- 403
- 410
- 503
{- "@type": "QueryResult",
- "result": [
- {
- "@type": "VariableValue",
- "variableValueId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOk1ZX0FQSV9LRVk",
- "envId": "3456789a-bcde-f012-3456-789abcdef012",
- "variableValue": "current-secret-value",
- "previousValue": "old-secret-value",
- "updateTransactionId": "MzQ1Njc4OWEtYmNkZS1mMDEyLTM0NTYtNzg5YWJjZGVmMDEyOjQy",
- "updatedBy": "user@example.com",
- "updatedDate": "2025-06-01T12:00:00Z",
- "SimpleGlobalVariable": {
- "name": "MY_API_KEY",
- "encrypted": true
}
}
], - "numberOfResults": 1
}