Get Cleanable Batch Report Count

Queries for the number of report results about a historic batch operations relevant to history cleanup (see History cleanup). Takes the same parameters as the Get Cleanable Batch Report method.

Method

GET /history/batch/cleanable-batch-report/count

Parameters

Query Parameters

Name Description
sortBy Sort the results by a given criterion. Valid value is finished. Must be used in conjunction with the sortOrder parameter.
sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.
firstResult Pagination of results. Specifies the index of the first result to return.
maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Result

A JSON array containing finished batch operations information relevant to history cleanup. Each report result has the following properties:

Name Value Description
count Number The number of report results.

Response Codes

Code Media type Description
200 application/json Request successful.
500 application/json See the Introduction for the error response format.

Examples

Request

GET /history/batch/cleanable-batch-report/count

Response

{
  "count": 10
}

On this Page: