Waiting for engine...
Skip to main content

GlobalVariableUpdateTransaction object

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.

Endpoint​

All objects and operations share a single SOAP endpoint per account.

POST:

  • US: https://api.boomi.com/api/soap/v1/<accountId>
  • GB: https://api.platform.gb.boomi.com/api/soap/v1/<accountId>

Where accountId is the ID of the authenticating account for the request.

Structure​

<GlobalVariableUpdateTransaction envId="" transactionNote="" createdBy="" createdDate="" updateTransactionId="">
   <UpdateValue variableValue="" previousValue="" variableValueId="">
      <SimpleGlobalVariable name="" encrypted=""/>
   </UpdateValue>
</GlobalVariableUpdateTransaction>
FieldTypeDescription
updateTransactionIdstringCompound ID assigned by the platform. Format: {envId}:{numericTransactionId}.
envIdstringThe ID of the environment for which variable values are being assigned. Required on CREATE and mandatory filter on QUERY.
transactionNotestringOptional free-text note describing the purpose of the value assignment. Max 1024 characters.
createdBystringUsername or email of the user who created the transaction. Set by the platform..
createdDatedateTimeISO 8601 timestamp of when the transaction was created. Set by the platform.
UpdateValue (repeatable child element)listOne entry per variable changed in this transaction — each with variableValue, previousValue, variableValueId, and a nested SimpleGlobalVariable.

Supported operations​

GETQUERYqueryMoregetBulkCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedSupportedSupportedNot supportedNot supportedNot supported

CREATE is the only supported operation for setting a Global Variable value, and it works by creating a transaction. UPDATE and DELETE are not supported, because transactions are write-once: once created, they are immutable and cannot be edited or removed.

Using the GET operation​

  • The GET operation retrieves a specific update transaction. Provide the compound ID in the format {envId}:{transactionId} as the object ID.

Using the CREATE operation​

  • The CREATE operation creates a new update transaction, assigning one or more variable values in an environment. Each UpdateValue entry must reference the target variable by name in the nested SimpleGlobalVariable element. CREATE is the only way to assign or change a Global Variable's value.

Using the QUERY operation​

  • envId with the EQUALS operator is a mandatory filter for this operation. Queries that omit an envId filter are rejected.

  • varName is an optional filter that narrows results to a specific variable.

  • For more information about the structure of QUERY filters, refer to Query filters topic.

Using the queryMore operation​

  • Use the queryMore operation to retrieve subsequent pages of results from a previous QUERY call. Pass the queryToken returned in the prior QUERY (or queryMore) response. For more information, refer to the Query paging topic.

Using the Bulk operation​

  • The getBulk operation retrieves multiple update transactions in a single request. Provide each transaction's compound ID in the format {envId}:{transactionId}. Each requested ID is returned as a separate result with its own statusCode, so an ID that doesn't exist doesn't fail the whole request.

SOAP implementation​

  • GET operation

    The following example retrieves transaction txn-abc123 in environment 19569e90-5f45-4a3a-88f3-6bebee3b68d5, using the compound ID format {envId}:{transactionId}.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:get>
             <api:objectType>GlobalVariableUpdateTransaction</api:objectType>
             <api:objectId>19569e90-5f45-4a3a-88f3-6bebee3b68d5:txn-abc123</api:objectId>
          </api:get>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:result xsi:type="bns:GlobalVariableUpdateTransaction"
                envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                transactionNote="Transaction Note Test"
                createdBy="user@boomi.com"
                createdDate="2026-07-01T00:00:00Z"
                updateTransactionId="txn-abc123">
                <bns:UpdateValue variableValue="First Value" previousValue="defaultValue" variableValueId="c1d2e3f4-5678-90ab-cdef-1234567890ab">
                   <bns:SimpleGlobalVariable name="MY_VARIABLE" encrypted="false"/>
                </bns:UpdateValue>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation

    The following example creates an update transaction that assigns a new value to MY_VARIABLE in environment 19569e90-5f45-4a3a-88f3-6bebee3b68d5. This is the only way to assign or change a Global Variable's value.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:create>
             <object xsi:type="api:GlobalVariableUpdateTransaction" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                transactionNote="Updated API key for production">
                <api:UpdateValue variableValue="new-secret-value">
                   <api:SimpleGlobalVariable name="MY_VARIABLE"/>
                </api:UpdateValue>
             </object>
          </api:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:createResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <result xsi:type="bns:GlobalVariableUpdateTransaction"
                envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                transactionNote="Updated API key for production"
                createdBy="user@boomi.com"
                createdDate="2026-07-01T00:00:00Z"
                updateTransactionId="txn-abc123">
                <bns:UpdateValue variableValueId="c1d2e3f4-5678-90ab-cdef-1234567890ab" variableValue="new-secret-value" previousValue="old-secret-value">
                   <bns:SimpleGlobalVariable name="MY_VARIABLE" encrypted="true"/>
                </bns:UpdateValue>
             </result>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example queries all update transactions in environment 19569e90-5f45-4a3a-88f3-6bebee3b68d5. envId with EQUALS is a mandatory filter; varName is an optional filter.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:query>
             <api:objectType>GlobalVariableUpdateTransaction</api:objectType>
             <api:queryConfig>
                <api:QueryFilter>
                   <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
                      <api:nestedExpression operator="EQUALS" property="envId"
                         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                         <api:argument>19569e90-5f45-4a3a-88f3-6bebee3b68d5</api:argument>
                      </api:nestedExpression>
                   </api:expression>
                </api:QueryFilter>
             </api:queryConfig>
          </api:query>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:results numberOfResults="1">
                <bns:result xsi:type="bns:GlobalVariableUpdateTransaction"
                   envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                   createdBy="user@boomi.com"
                   createdDate="2026-07-01T00:00:00Z"
                   updateTransactionId="txn-abc123">
                   <bns:UpdateValue variableValue="First Value" variableValueId="c1d2e3f4-5678-90ab-cdef-1234567890ab">
                      <bns:SimpleGlobalVariable name="MY_VARIABLE" encrypted="false"/>
                   </bns:UpdateValue>
                </bns:result>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • queryMore operation

    The following example retrieves the next page of transactions using a queryToken returned by a previous QUERY call.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:queryMore>
             <api:queryToken>a1b2c3d4-query-token-example</api:queryToken>
          </api:queryMore>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:queryMoreResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:results numberOfResults="1">
                <bns:result xsi:type="bns:GlobalVariableUpdateTransaction"
                   envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                   createdBy="user@boomi.com"
                   createdDate="2026-07-02T00:00:00Z"
                   updateTransactionId="txn-def456">
                   <bns:UpdateValue variableValue="Second Value" variableValueId="d2e3f4a5-6789-01bc-def2-234567890abc">
                      <bns:SimpleGlobalVariable name="OTHER_VARIABLE" encrypted="false"/>
                   </bns:UpdateValue>
                </bns:result>
             </bns:results>
          </bns:queryMoreResponse>
       </S:Body>
    </S:Envelope>

  • getBulk operation

    The following example retrieves transactions txn-abc123 and txn-def456 in environment 19569e90-5f45-4a3a-88f3-6bebee3b68d5 in a single request, using the compound ID format {envId}:{transactionId}.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
             <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>user@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:getBulk xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <api:objectType>GlobalVariableUpdateTransaction</api:objectType>
             <api:bulkObject type="GET">
                <api:request xsi:type="api:BulkId" id="19569e90-5f45-4a3a-88f3-6bebee3b68d5:txn-abc123"/>
                <api:request xsi:type="api:BulkId" id="19569e90-5f45-4a3a-88f3-6bebee3b68d5:txn-def456"/>
             </api:bulkObject>
          </api:getBulk>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:getBulkResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:results>
                <bns:response index="0" id="19569e90-5f45-4a3a-88f3-6bebee3b68d5:txn-abc123" statusCode="200">
                   <bns:Result xsi:type="bns:GlobalVariableUpdateTransaction" envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                      createdBy="user@boomi.com" createdDate="2026-07-01T00:00:00Z" updateTransactionId="txn-abc123">
                      <bns:UpdateValue variableValue="First Value" variableValueId="c1d2e3f4-5678-90ab-cdef-1234567890ab">
                         <bns:SimpleGlobalVariable name="MY_VARIABLE" encrypted="false"/>
                      </bns:UpdateValue>
                   </bns:Result>
                </bns:response>
                <bns:response index="1" id="19569e90-5f45-4a3a-88f3-6bebee3b68d5:txn-def456" statusCode="200">
                   <bns:Result xsi:type="bns:GlobalVariableUpdateTransaction" envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                      createdBy="user@boomi.com" createdDate="2026-07-02T00:00:00Z" updateTransactionId="txn-def456">
                      <bns:UpdateValue variableValue="Second Value" variableValueId="d2e3f4a5-6789-01bc-def2-234567890abc">
                         <bns:SimpleGlobalVariable name="OTHER_VARIABLE" encrypted="false"/>
                      </bns:UpdateValue>
                   </bns:Result>
                </bns:response>
             </bns:results>
          </bns:getBulkResponse>
       </S:Body>
    </S:Envelope>
On this Page