Get Cleanable Case Instance Report Count

Queries for the number of report results about a case definition and finished case instances relevant to history cleanup (see History cleanup). Takes the same parameters as the Get Cleanable Case Instance Report method.

Method

GET /history/case-definition/cleanable-case-instance-report/count

Parameters

Query Parameters

Name Description
caseDefinitionIdIn Filter by case definition ids. Must be a comma-separated list of case definition ids.
caseDefinitionKeyIn Filter by case definition keys. Must be a comma-separated list of case definition keys.
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 case instance 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/case-definition/cleanable-case-instance-report/count

Response

{
  "count": 1
}

On this Page: