Get Case Activity Instances Count

Query for the number of historic case activity instances that fulfill the given parameters. Takes the same parameters as the get historic case activity instances method.

Method

GET /history/case-activity-instance/count

Parameters

Query Parameters

Name Description
caseActivityInstanceId Filter by case activity instance id.
caseInstanceId Filter by case instance id.
caseDefinitionId Filter by case definition id.
caseExecutionId Filter by the id of the case execution that executed the case activity instance.
caseActivityId Filter by the case activity id (according to CMMN XML).
caseActivityName Filter by the case activity name (according to CMMN XML).
caseActivityType Filter by the case activity type (according to CMMN XML).
createdBefore Restrict to instances that were created before the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.
createdAfter Restrict to instances that were created after the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.
endedBefore Restrict to instances that ended before the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.
endedAfter Restrict to instances that ended after the given date. The date must have the format yyyy-MM-dd'T'HH:mm:ss, e.g., 2013-01-23T14:42:45.
finished Only include finished case activity instances. Value may only be true, as false is the default behavior.
unfinished Only include unfinished case activity instances. Value may only be true, as false is the default behavior.
required Only include required case activity instances. Value may only be true, as false is the default behavior.
repeatable Only include repeatable case activity instances. Value may only be true, as false is the default behavior.
repetition Only include case activity instances which are repetitions. Value may only be true, as false is the default behavior.
available Only include available case activity instances. Value may only be true, as false is the default behavior.
enabled Only include enabled case activity instances. Value may only be true, as false is the default behavior.
disabled Only include disabled case activity instances. Value may only be true, as false is the default behavior.
active Only include active case activity instances. Value may only be true, as false is the default behavior.
completed Only include completed case activity instances. Value may only be true, as false is the default behavior.
terminated Only include terminated case activity instances. Value may only be true, as false is the default behavior.
tenantIdIn Filter by a list of tenant ids. A case activity instance must have one of the given tenant ids.

Result

A JSON object that contains the count as the only property.

Name Value Description
count Number The number of matching historic activity instances.

Response Codes

Code Media type Description
200 application/json Request successful.
400 application/json Returned if some of the query parameters are invalid. See the Introduction for the error response format.

Example

Request

GET /history/case-activity-instance?caseActivityName=aCaseActivityName&completed=false

Response

{
  "count": 1
}

On this Page: