Account Group object

The Account Group object represents an account group.

For each account group, you can:

Retrieve the properties and resources
Query by name
Create new account groups
Update the properties of existing account groups

note

Resources information is returned only for the Get operation, not the Query operation.

Structure

<AccountGroup defaultGroup=""autoSubscribeAlertLevel=""name=""accountId=""id="">
<Resources><Resource resourceId="" resourceName="" objectType=""/></Resources>
</AccountGroup>

Field	Type	Description
defaultGroup	boolean	true — The account group is All Accounts, which the system creates automatically. false — The account group is not All Accounts.
autoSubscribeAlertLevel	string	The severity level of email alerts sent to member users in the account group.
name	string	The name of the account group as displayed on the Account Information tab of the Setup page.
accountId	string	The ID of the primary account under which the account group exists.
id	string	The ID of the account group.
resourceId	string	Account group resource ID
resourceName	string	Account group resource name
objectType	objectType	Resource object type details. Possible values: Cloud Connector Role Published Process Integration Pack Data Hub Model

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Supported	Supported	Supported	Supported	Not supported	Not supported

Notes:

The ordinary GET operation returns a single Account Group object based on the supplied account group ID. The bulk GET operation returns multiple Account Group objects based on the supplied account group IDs, to a maximum of 100.
You can use the following fields as QUERY filters for the Account Group object:

Field Allowed values
name Any string value.

The operators allowed for the Account Group object filters are:
- BETWEEN
- EQUALS
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- IS_NULL
- IS_NOT_NULL
- LESS_THAN
- LESS_THAN_OR_EQUAL
- LIKE
- NOT_EQUALS
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 creates an account group based on the supplied name.
The UPDATE operation updates an account group based on the supplied account group ID.

Field	Allowed values
name	Any string value.

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

GET 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>BOOMI_USER_NAME</wsse:Username>
       <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">BOOMI_PASSWORD</wsse:Password>
     </wsse:UsernameToken>
   </wsse:Security>
</soapenv:Header>
<soapenv:Body>
   <api:get>
      <api:objectType>AccountGroup</api:objectType>        <api:objectId>fedcba98-7654-3210-fedc-ba9876543210</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:AccountGroup" defaultGroup="false" autoSubscribeAlertLevel="none" name="All Accounts" accountId="account-123456" id="fedcba98-7654-3210-fedc-ba9876543210">
  	<bns:Resources>
    <bns:resource resourceId="ffd7622d-1f6f-4f08-9bf7-5f2f6eabbf30" objectType="Integration Pack" resourceName="Test Integration Pack"/>
     </bns:Resources>
        </bns:result>	
      </bns:getResponse>
 </S:Body>
 </S:Envelope>

note

Resources information is returned only for the Get operation, not the Query operation.

QUERY operation

The following example query returns the account group named Admins.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <api:query>
         <api:objectType>AccountGroup</api:objectType>
         <api:queryConfig>
            <api:QueryFilter>
               <api:expression operator="EQUALS" property="name"
                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                   <api:argument>Admins</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="1">
            <bns:result xsi:type="bns:AccountGroup" defaultGroup="true" autoSubscribeAlertLevel="none" name="Admins" accountId="account-123456" id="fedcba98-7654-3210-fedc-ba9876543210"/>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

CREATE operation

The following example creates an account group named TestGroup.

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:AccountGroup" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          name="TestGroup" accountId="account-123456">
        </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:AccountGroup" defaultGroup="false" autoSubscribeAlertLevel="none" name="TestGroup" accountId="account-123456" id="fedcba98-7654-3210-fedc-ba9876543210"/>
      </bns:createResponse>
   </S:Body>
</S:Envelope>

UPDATE operation

This example updates the account group name to TestGroupRenamed.

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:update>
               <object xsi:type="api:AccountGroup" name="TestGroupRenamed"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" accountId ="account-123456" id="fedcba98-7654-3210-fedc-ba9876543210"> 
               </object>
      </api:update>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <result xsi:type="bns:AccountGroup" defaultGroup="false" autoSubscribeAlertLevel="none" name="TestGroupRenamed" accountId="account-123456" id="fedcba98-7654-3210-fedc-ba9876543210"/>
      </bns:updateResponse>
   </S:Body>
</S:Envelope>

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation