Document Count Account object

The Document Count Account object represents data corresponding to the data that is accessible through the Document Count gadget in the Account Dashboard.

The data is the total number of documents processed under the querying account on a particular date. Calculating the document count occurs by adding the total number of inbound documents and the total number of outbound documents.  QUERY operations retrieve the data as XML by default. After retrieving the data, you can import it into a reporting tool for analysis.

Note: Retrieved document counts are raw data that might differ from the counts reported by the Document Count gadget.

Structure

<DocumentCountAccount value="" date="" accountId="" atomId=""/>

Field	Type	Description
Filter	Filter	Filter
value	long	The count of processed documents.
date	string — yyyy-MM-dd (for example, 2016-01-31)	The processing date of the documents. The time zone is UTC±00:00.
accountId	string	The ID of the account that processed the documents.
atomId	string	The ID of the Runtime that processed the documents.

Supported operations

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

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

Field	Allowed values
environmentId	Any string value.
atomId	Any string value.
processDate	String specifying a date in the format yyyy-MM-dd. The implied time zone is UTC±00:00. One way to specify a date range is to use the BETWEEN operator with two arguments, one representing the start date and the other representing the end date.

The operators allowed for the Document Count Account object filters are:

• BETWEEN

• EQUALS

• GREATER_THAN

• GREATER_THAN_OR_EQUAL

• LESS_THAN

• LESS_THAN_OR_EQUAL

However, you can use the EQUALS operator only with the environmentId filter parameter.

The authenticating user for a QUERY operation must have the Dashboard privilege.

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

SOAP implementation

The following example query returns the total number of documents processed each day within an account on the Atom whose ID is 3456789a-bcde-f0123-4567-89abcdef012 between May 1, 2016, and August 31, 2016.

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>DocumentCountAccount</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="atomId" xsi:type="api:SimpleExpression">
                       <api:argument>3456789a-bcde-f0123-4567-89abcdef012</api:argument>
                    </api:nestedExpression>
                    <api:nestedExpression operator="BETWEEN" property="processDate" xsi:type="api:SimpleExpression">
                        <api:argument>2016-05-01</api:argument>
                        <api:argument>2016-08-31</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:DocumentCountAccount" value="2844"
                date="2016-05-14" accountId="account-123456"
                atomId="3456789a-bcde-f0123-4567-89abcdef012"/>
               ...
            <bns:result xsi:type="bns:DocumentCountAccount" value="606"
                date="2016-08-21" accountId="account-123456"
                atomId="3456789a-bcde-f0123-4567-89abcdef012"/>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

The maximum number of results returned per QUERY response is 100. This 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.