Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - GlobalVariableUpdateTransaction

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.

GlobalVariableUpdateTransaction

The GlobalVariableUpdateTransaction object manages the creation and retrieval of update transactions for Global Variable value assignments. Each transaction records a batch of variable value changes for a specific environment, including what values were set, what they replaced, and who made the change.

This API is the mechanism by which Global Variable values are assigned to environments. Creating an update transaction is the only way to set or change variable values.

Update transactions are immutable after creation. They cannot be updated or deleted, and serve as the permanent record of all value assignment history. On the creation of a new GlobalVariable, an initial update transaction is automatically generated by the platform.

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_ASSIGN — Assign values to Global Variables for accessible environments
  • OR GLOBAL_VARIABLE_VALUE_VIEW — View non-encrypted values for accessible environments

Note:
- Available on all runtime types.
- Update transactions are write-once or immutable. PUT and DELETE are not supported.
- The updateTransactionId is a compound ID in the format {envId}:{numericTransactionId}, auto-assigned by the platform on creation.
- After a successful CREATE, the platform automatically sends sync messages to all containers in the target environment to propagate the new values.
- The envId field is required on CREATE and is a mandatory filter field on QUERY. An optional varName filter (also EQUALS only) can narrow results to a specific variable.
- No other query operators (for example, LIKE, CONTAINS) are supported.

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.
  • GlobalVariableValue — Read-only view of the current value of a variable per environment. Reflects the result of the most recent update transaction.

Retrieves a GlobalVariableUpdateTransaction object

Retrieves a single update transaction by its compound ID.

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

The compound ID of the update transaction. Format: {envId}:{numericTransactionId}. Provided as a path parameter.

Responses

Response Schema:
updateTransactionId
string

Compound ID assigned by the platform. Format: {envId}:{numericTransactionId}. Used as the path parameter for GET requests.

envId
string

The ID of the environment for which variable values are being assigned. Required on CREATE and mandatory filter on QUERY.

transactionNote
string

Optional free-text note describing the purpose of the value assignment. Max 1024 characters.

createdBy
string

Username/email of the user who created the transaction. Set by the platform.

createdDate
string <date-time>

ISO 8601 timestamp of when the transaction was created. Set by the platform.

Array of objects (GlobalVariableUpdateTransaction_SimpleVariableValue)

One or more variable value entries included in this transaction. Each entry references a variable by name and specifies the new value.

Response samples

Content type
{
  • "@type": "GlobalVariableUpdateTransaction",
  • "updateTransactionId": "3456789a-bcde-f012-3456-789abcdef012:42",
  • "envId": "3456789a-bcde-f012-3456-789abcdef012",
  • "transactionNote": "Updated API key for production",
  • "createdBy": "user@example.com",
  • "createdDate": "2025-06-01T12:00:00Z",
  • "UpdateValue": [
    • {
      }
    ]
}

Creates a GlobalVariableUpdateTransaction object

Creates a new update transaction, assigning values to one or more variables in an environment.

Authorizations:
basicAuth
Request Body schema:
optional
envId
string

The ID of the environment for which variable values are being assigned. Required on CREATE and mandatory filter on QUERY.

transactionNote
string

Optional free-text note describing the purpose of the value assignment. Max 1024 characters.

Array of objects (GlobalVariableUpdateTransaction_SimpleVariableValue)

One or more variable value entries included in this transaction. Each entry references a variable by name and specifies the new value.

Responses

Response Schema:
updateTransactionId
string

Compound ID assigned by the platform. Format: {envId}:{numericTransactionId}. Used as the path parameter for GET requests.

envId
string

The ID of the environment for which variable values are being assigned. Required on CREATE and mandatory filter on QUERY.

transactionNote
string

Optional free-text note describing the purpose of the value assignment. Max 1024 characters.

createdBy
string

Username/email of the user who created the transaction. Set by the platform.

createdDate
string <date-time>

ISO 8601 timestamp of when the transaction was created. Set by the platform.

Array of objects (GlobalVariableUpdateTransaction_SimpleVariableValue)

One or more variable value entries included in this transaction. Each entry references a variable by name and specifies the new value.

Request samples

Content type
{
  • "envId": "3456789a-bcde-f012-3456-789abcdef012",
  • "transactionNote": "Updated API key for production",
  • "UpdateValue": [
    • {
      }
    ]
}

Response samples

Content type
{
  • "@type": "GlobalVariableUpdateTransaction",
  • "updateTransactionId": "3456789a-bcde-f012-3456-789abcdef012:42",
  • "envId": "3456789a-bcde-f012-3456-789abcdef012",
  • "transactionNote": "Updated API key for production",
  • "createdBy": "user@example.com",
  • "createdDate": "2025-06-01T12:00:00Z",
  • "UpdateValue": [
    • {
      }
    ]
}

Retrieves multiple GlobalVariableUpdateTransaction objects by identifier

Retrieves multiple update transactions 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 GlobalVariableUpdateTransaction identifiers to retrieve.

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

Responses

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

Queries update transactions with filters. envId is a mandatory filter using the EQUALS operator. No other query operators (for example, LIKE, CONTAINS) are supported. 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 GlobalVariableUpdateTransaction 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 (GlobalVariableUpdateTransaction)

Request samples

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

Response samples

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

Retrieves additional results for a GlobalVariableUpdateTransaction 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 (GlobalVariableUpdateTransaction)

Request samples

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

Response samples

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