Waiting for engine...
Skip to main content

Account Group Account object

The Account Group Account object represents the linkage between a account and a account group. You can query, add, and remove accounts in an account group.

Structure​

<AccountGroupAccount accountId="" accountGroupId="" id=""/>
FieldTypeDescription
accountIdstringThe ID of the account.
accountGroupIdstringThe ID of the account group.
idstringThe object’s conceptual ID from which the account and account group IDs synthesizes.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Not supportedSupportedSupportedNot supportedNot supportedSupported

  • You can use the following fields as QUERY filters for the Account Group Account object:

    FieldAllowed values
    accountIdAny string value.
    accountGroupIdAny string value.

    The operators allowed for the Account Group Account object filters are:

    • EQUALS

    • LIKE

    • NOT_EQUALS

    • IS_NULL

    • IS_NOT_NULL

    • BETWEEN

    • GREATER_THAN

    • GREATER_THAN_OR_EQUAL

    • LESS_THAN

    • LESS_THAN_OR_EQUAL

    For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

  • The CREATE operation adds an account to an account group.

  • The DELETE operation removes an account from an account group.

Note:
To facilitate these operations on this object in an integration process, use the Boomi Enterprise Platform Partner API connector instead of the Boomi Enterprise Platform API connector.

SOAP implementation​

  • QUERY operation

    The following example query returns the accounts in the account group whose ID is fedcba98-7654-3210-fedc-ba9876543c210.

    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>ATOMSPHERE_USER_NAME</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
    </soapenv:Header>
       <soapenv:Body>
          <api:query>
             <!--Optional:-->
             <api:objectType>AccountGroupAccount</api:objectType>
             <!--Optional:-->
             <api:queryConfig>
                <api:QueryFilter>
                  <api:expression operator="EQUALS" property="accountGroupId"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>fedcba98-7654-3210-fedc-ba9876543c21</api:argument>
                  </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="2">
                <bns:result xsi:type="bns:AccountGroupAccount" accountId="account-123456" accountGroupId="fedcba98-7654-3210-fedc-ba9876543c210" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"/>
                <bns:result xsi:type="bns:AccountGroupAccount" accountId="account-789012" accountGroupId="fedcba98-7654-3210-fedc-ba9876543c210" id="gAb0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1H"/>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • CREATE 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>ATOMSPHERE_USER_NAME</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
             </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:create>
             <object xsi:type="api:AccountGroupAccount" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" accountGroupId="fedcba98-7654-3210-fedc-ba9876543c210" accountId="account-789012">
            </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">
             <bns:result xsi:type="bns:AccountGroupAccount" accountId="account-789012" accountGroupId="fedcba98-7654-3210-fedc-ba9876543c210" id="gAb0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1H"/>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

  • DELETE 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>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:delete>
             <!--Optional:-->
             <objectType>AccountGroupAccount</objectType>
             <!--Optional:-->
             <objectId>gAb0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1H</objectId>
          </api:delete>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:deleteResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:successful>true</bns:successful>
          </bns:deleteResponse>
       </S:Body>
    </S:Envelope>

On this Page