Waiting for engine...
Skip to main content

Account object

The Account object provides information about a account, including the associated users, connector licensing information, and general information.

note

The ability to create and delete accounts is available only through the Boomi Enterprise Platform Partner API.

Structure​


<Account
        supportLevel=""
        supportAccess=""
        suggestionsEnabled=""
        dateCreated=""
        expirationDate=""
        status=""
        name=""
        accountId="">
    <licensing>
        <standard used="0" purchased="0"/>
        <smallBusiness used="0" purchased="0"/>
        <enterprise used="0" purchased="0"/>
        <tradingPartner used="0" purchased="0"/>
        <standardTest used="0" purchased="0"/>
        <smallBusinessTest used="0" purchased="0"/>
        <enterpriseTest used="0" purchased="0"/>
        <tradingPartnerTest used="0" purchased="0"/>
    </licensing>
    <molecule used="0" purchased="0"/>
</Account>
FieldTypeDescription
accountIdstringThe ID of the account.
namestringThe name of the account.
statusstringThe status of the account. The allowed values are active or deleted.
dateCreatedstring with the format yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00ZThe creation date of the account.
expirationDatestring with the format yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00ZThe scheduled expiration date of the account.
suggestionsEnabledbooleanIdentifies whether this account has the Boomi Suggest feature enabled.
supportAccessbooleanIdentifies whether this account allows support user access.
supportLevelstringThe level of support for this account. The allowed values are standard *or premier.
licensingstringIndicates the number of connections used and purchased in each of the connector type and production/test classifications. The classifications include standard, smallBusiness, enterprise, and tradingPartner.
molecule used, purchasedstringIndicates the number of Runtime clusters available on an account and the number of Runtime clusters currently in use.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedNot supportedNot supportedSupported

Operations​

Using the GET operation​

The ordinary GET operation returns a single Account object based on the supplied account ID. The bulk GET operation returns multiple Account objects based on the supplied account IDs, to a maximum of 100.

Using the QUERY operation​

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

    FieldAllowed values
    accountIdAny string value.
    dateCreatedDate using the format: yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00Z.
    expirationDateDate using the format: yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00Z.
    nameAny string value.
    statusactive or deleted.

  • The operators allowed for the Account 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, refer to the Query filters and Query paging topics.

Using the CREATE operation​

  • The CREATE operation creates an account based on the supplied name and trial expiration date (maximum of 90 days in the future).

  • CREATE is available only through the Partner API; you cannot use the accountId override parameter. The Partner API also supports a separate Account Provision operation for provisioning sub-accounts with specified features.

    note

    You cannot use the CREATE operation to provision or dictate the number of Runtime clustersavailable on an account.

Using the DELETE operation​

  • The DELETE operation deletes an account based on the supplied account ID.

  • The DELETE operation is available only through the Partner API; you cannot use the accountId override parameter.

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>ATOMSPHERE_USERNAME</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:get>
            <!--Optional:→
            <api:objectType>Account</api:objectType>
            <!--Optional:→
            <api:objectId>accountId</api:objectId>
         </api:get>
      </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <?xml version='1.0' encoding='UTF-8'?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
           <bns:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
               <bns:result xsi:type="bns:Account" accountId="deepikaqa-T7KIDU" name="DeepikaQA" status="active" dateCreated="2022-09-02T20:16:28Z" widgetAccount="false" supportAccess="true" supportLevel="standard">
                   <bns:licensing>
                       <bns:standard purchased="1000000" used="60"/>
                       <bns:smallBusiness purchased="1000000" used="0"/>
                       <bns:enterprise purchased="1000000" used="0"/>
                       <bns:tradingPartner purchased="100000" used="3"/>
                       <bns:standardTest purchased="1000" used="0"/>
                       <bns:smallBusinessTest purchased="1000" used="0"/>
                       <bns:enterpriseTest purchased="1000" used="0"/>
                       <bns:tradingPartnerTest purchased="1000" used="0"/>
                   </bns:licensing>
                   <bns:molecule purchased="10" used="0"/>
               </bns:result>
           </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example query returns all accounts that were not deleted and created between 1/1/14 and 1/1/16.

    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>
             <api:objectType>Account</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="NOT_EQUALS" property="status"
                       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                       <api:argument>deleted</api:argument>
                     </api:nestedExpression>
                     <api:nestedExpression operator="BETWEEN" property="dateCreated"
                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                       <api:argument>2014-01-01T00:00:00Z</api:argument>
                       <api:argument>2016-01-01T00:00:00Z</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="100">
                <bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
                <bns:result xsi:type="bns:Account" supportLevel="standard" supportAccess="true" suggestionsEnabled="false"
                  dateCreated="2010-02-22T15:43:03Z" expirationDate="2016-03-18T05:00:00Z" 
                  status="active" name="ABC Co" accountId="abc-H566GG" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                   <bns:licensing>
                      <bns:standard used="0" purchased="0"/>
                      <bns:smallBusiness used="0" purchased="0"/>
                      <bns:enterprise used="0" purchased="0"/>
                      <bns:tradingPartner used="0" purchased="0"/> 
                      <bns:standardTest used="0" purchased="0"/>
                      <bns:smallBusinessTest used="0" purchased="0"/>
                      <bns:enterpriseTest used="0" purchased="0"/>
                      <bns:tradingPartnerTest used="0" purchased="0"/>
                   </bns:licensing>
                   <bns:molecule purchased="500" used="1"/>
                </bns:result>
                ...
                <bns:result xsi:type="bns:Account" supportLevel="standard" supportAccess="true" 
                  dateCreated="2010-06-07T17:42:18Z" expirationDate="2016-09-07T05:00:00Z" status="active" 
                  name="XYZ Inc" accountId="xyz-V3M1QL" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                   <bns:licensing>
                      <bns:standard used="0" purchased="0"/>
                      <bns:smallBusiness used="0" purchased="0"/>
                      <bns:enterprise used="0" purchased="0"/>
                      <bns:tradingPartner used="0" purchased="0"/>
                      <bns:standardTest used="0" purchased="0"/>
                      <bns:smallBusinessTest used="0" purchased="0"/>
                      <bns:enterpriseTest used="0" purchased="0"/>
                      <bns:tradingPartnerTest used="0" purchased="0"/>
                   </bns:licensing>
                   <bns:molecule purchased="500" used="1"/>
                </bns:result>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

    The response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.

  • CREATE operation

    Request:

    <soapenv:Envelope xmlns:api="http://api.platform.boomi.com/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="http://partner.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>
          <par:create>
             <object xsi:type="par:Account" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              name="Test Account" expirationDate="2016-02-06T05:00:00Z" >
            </object>
          </par:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <bns:Account accountId="testaccount-W4N2RM" name="Test Account" status="active" dateCreated="2015-02-06T15:42:10Z" expirationDate="2021-07-07T18:12:24Z" supportAccess="true" supportLevel="standard" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
       <bns:licensing/>
       <bns:molecule purchased="0" used="0"/>
    </bns:Account>

  • DELETE operation

    Request:

    <soapenv:Envelope xmlns:api="http://api.platform.boomi.com/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="http://partner.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>
          <par:delete>
             <!--Optional:-->
             <par:objectType>Account</par:objectType>
             <!--Optional:-->
             <par:objectId>testaccount-W4N2RM</par:objectId>
          </par:delete>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns4:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" xmlns:ns4="http://partner.api.platform.boomi.com/">
             <result xsi:type="bns:Account" accountId="testaccount-W4N2RM" name="Test Account" status="active" dateCreated="2021-07-06T17:53:18Z" expirationDate="2021-07-07T17:53:18Z" supportAccess="true" supportLevel="standard">
                <bns:licensing/>
                <bns:molecule purchased="0" used="0"/>
             </result>
          </ns4:createResponse>
       </S:Body>
    </S:Envelope>
On this Page