Waiting for engine...
Skip to main content

GlobalVariableValue object

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:

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​

<VariableValue envId="" updateTransactionId="" updatedBy="" updatedDate=""
   variableValue="" previousValue="" variableValueId="">
   <SimpleGlobalVariable name="" encrypted=""/>
</VariableValue>
FieldTypeDescription
variableValueIdstringThe compound ID of the variable value. Format: {envId}:{variableName}. For example: 3456789a-bcde-f012-3456-789abcdef012:MY_API_KEY
envIdstringThe ID of the environment this value belongs to. Mandatory filter field on QUERY.
variableValuestringThe current value of the variable in this environment. Masked for encrypted variables.
previousValuestringThe value that was in place before the most recent update transaction.
updateTransactionIdstringCompound ID of the GlobalVariableUpdateTransaction that last set this value. Format: {envId}:{numericTransactionId}.
updatedBystringUsername or email of the user who last assigned a value using an update transaction.
updatedDatedateTimeISO 8601 timestamp of the most recent value assignment.
SimpleGlobalVariable (child element)objectContains name and encrypted for the parent Global Variable. This is a child element, not an attribute. Do not flatten it onto the parent tag.

Supported operations​

GETQUERYqueryMoregetBulkCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedSupportedNot supportedNot supportedNot supportedNot supported

CREATE, UPDATE, and DELETE are not supported. To assign or change a value, create a GlobalVariableUpdateTransaction instead.

Using the GET operation​

  • The GET operation retrieves the value assigned to a Global Variable in an environment. Provide the compound ID in the format {envId}:{variableName} as the object ID.

Using the QUERY operation​

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

  • 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 getBulk operation​

  • The getBulk operation retrieves multiple Global Variable values by compound ID ({envId}:{variableName}) in a single request. 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 the value assigned to MY_VARIABLE in environment 19569e90-5f45-4a3a-88f3-6bebee3b68d5, using the compound ID format {envId}:{variableName}.

    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>GlobalVariableValue</api:objectType>
             <api:objectId>19569e90-5f45-4a3a-88f3-6bebee3b68d5:MY_VARIABLE</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:VariableValue"
                envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                variableValue="First Value"
                previousValue="defaultValue"
                variableValueId="c1d2e3f4-5678-90ab-cdef-1234567890ab"
                updateTransactionId="txn-abc123"
                updatedBy="user@boomi.com"
                updatedDate="2026-07-01T00:00:00Z">
                <bns:SimpleGlobalVariable name="MY_VARIABLE" encrypted="false"/>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example queries all Global Variable values assigned in environment 19569e90-5f45-4a3a-88f3-6bebee3b68d5. envId with EQUALS is a mandatory filter for this operation.

    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>GlobalVariableValue</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:VariableValue"
                   envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                   variableValue="First Value"
                   variableValueId="c1d2e3f4-5678-90ab-cdef-1234567890ab">
                   <bns:SimpleGlobalVariable name="MY_VARIABLE" encrypted="false"/>
                </bns:result>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • queryMore operation

    The following example retrieves the next page of values 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:VariableValue"
                   envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                   variableValue="Second Value"
                   variableValueId="d2e3f4a5-6789-01bc-def2-234567890abc">
                   <bns:SimpleGlobalVariable name="OTHER_VARIABLE" encrypted="false"/>
                </bns:result>
             </bns:results>
          </bns:queryMoreResponse>
       </S:Body>
    </S:Envelope>

  • getBulk operation

    The following example retrieves the values for MY_VARIABLE and DB_PASSWORD in environment 19569e90-5f45-4a3a-88f3-6bebee3b68d5 in a single request, using the compound ID format {envId}:{variableName}.

    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>GlobalVariableValue</api:objectType>
             <api:bulkObject type="GET">
                <api:request xsi:type="api:BulkId" id="19569e90-5f45-4a3a-88f3-6bebee3b68d5:MY_VARIABLE"/>
                <api:request xsi:type="api:BulkId" id="19569e90-5f45-4a3a-88f3-6bebee3b68d5:DB_PASSWORD"/>
             </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:MY_VARIABLE" statusCode="200">
                   <bns:Result xsi:type="bns:VariableValue" envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                      variableValue="First Value" variableValueId="c1d2e3f4-5678-90ab-cdef-1234567890ab">
                      <bns:SimpleGlobalVariable name="MY_VARIABLE" encrypted="false"/>
                   </bns:Result>
                </bns:response>
                <bns:response index="1" id="19569e90-5f45-4a3a-88f3-6bebee3b68d5:DB_PASSWORD" statusCode="200">
                   <bns:Result xsi:type="bns:VariableValue" envId="19569e90-5f45-4a3a-88f3-6bebee3b68d5"
                      variableValue="********" variableValueId="e3f4a5b6-7890-12cd-ef34-34567890abcd">
                      <bns:SimpleGlobalVariable name="DB_PASSWORD" encrypted="true"/>
                   </bns:Result>
                </bns:response>
             </bns:results>
          </bns:getBulkResponse>
       </S:Body>
    </S:Envelope>
On this Page