Skip to main content
POST
/
history
/
activity-instance
/
count
Get List Count (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/history/activity-instance/count \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "activityType": "userTask"
}'
{
  "count": 1
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

A historic activity instance query which defines a group of historic activity instances

​
activityInstanceId
string | null

Filter by activity instance id.

​
processInstanceId
string | null

Filter by process instance id.

​
processDefinitionId
string | null

Filter by process definition id.

​
executionId
string | null

Filter by the id of the execution that executed the activity instance.

​
activityId
string | null

Filter by the activity id (according to BPMN 2.0 XML).

​
activityName
string | null

Filter by the activity name (according to BPMN 2.0 XML).

​
activityType
string | null

Filter by activity type.

​
taskAssignee
string | null

Only include activity instances that are user tasks and assigned to a given user.

​
finished
boolean | null

Only include finished activity instances. Value may only be true, as false behaves the same as when the property is not set.

​
unfinished
boolean | null

Only include unfinished activity instances. Value may only be true, as false behaves the same as when the property is not set.

​
canceled
boolean | null

Only include canceled activity instances. Value may only be true, as false behaves the same as when the property is not set.

​
completeScope
boolean | null

Only include activity instances which completed a scope. Value may only be true, as false behaves the same as when the property is not set.

​
startedBefore
string<date-time> | null

Restrict to instances that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
startedAfter
string<date-time> | null

Restrict to instances that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
finishedBefore
string<date-time> | null

Restrict to instances that were finished before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
finishedAfter
string<date-time> | null

Restrict to instances that were finished after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

​
tenantIdIn
string[] | null

Must be a JSON array of Strings. An activity instance must have one of the given tenant ids.

​
withoutTenantId
boolean | null

Only include historic activity instances that belong to no tenant. Value may only be true, as false is the default behavior.

​
sorting
object[] | null

Apply sorting of the result

Response

Request successful.

​
count
integer

The number of matching instances.