Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - DocumentCountAccount

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

DocumentCountAccount

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.

Required Privileges

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.
  • DASHBOARD — Access the integration account dashboards.

Queries for a DocumentCountAccount object(s)

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

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: environmentId, atomId, processDate

required
object
required
DocumentCountAccountSimpleExpression (object) or DocumentCountAccountGroupingExpression (object) (DocumentCountAccountExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"

You can use the EQUALS operator only with the environmentId filter parameter. The authenticating user for a QUERY operation must have the Dashboard privilege.

property
required
string
Enum: "environmentId" "atomId" "processDate"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (DocumentCountAccount)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "numberOfResults": 100,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}

Retrieves additional results for a DocumentCountAccount query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (DocumentCountAccount)

Response samples

Content type
{
  • "numberOfResults": 100,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}