Queries for the number of process instances that fulfill given parameters. Takes the same parameters as the Get Instances method.

Method

GET /process-instance/count

Parameters

Query Parameters

Name	Description
processInstanceIds	Filter by a comma-separated list of process instance ids.
businessKey	Filter by process instance business key.
businessKeyLike	Filter by process instance business key that the parameter is a substring of.
caseInstanceId	Filter by case instance id.
processDefinitionId	Filter by the process definition the instances run on.
processDefinitionKey	Filter by the key of the process definition the instances run on.
processDefinitionKeyIn	Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys.
processDefinitionKeyNotIn	Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys.
deploymentId	Filter by the deployment the id belongs to.
superProcessInstance	Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.
subProcessInstance	Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id.
superCaseInstance	Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
subCaseInstance	Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id.
active	Only include active process instances. Value may only be true, as false is the default behavior.
suspended	Only include suspended process instances. Value may only be true, as false is the default behavior.
incidentId	Filter by the incident id.
incidentType	Filter by the incident type. See the User Guide for a list of incident types.
incidentMessage	Filter by the incident message. Exact match.
incidentMessageLike	Filter by the incident message that the parameter is a substring of.
tenantIdIn	Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids.
withoutTenantId	Only include process instances which belong to no tenant. Value may only be true, as false is the default behavior.
activityIdIn	Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids.
rootProcessInstances	Restrict the query to all process instances that are top level process instances.
processDefinitionWithoutTenantId	Only include process instances which process definition has no tenant id.
variables	Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side. Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters.

Result

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

Name	Type	Description
count	Number	The number of matching process instances.

Response Codes

Code	Media type	Description
200	application/json	Request successful.
400	application/json	Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy, or if an invalid operator for variable comparison is used. See the Introduction for the error response format.

Example

Request

GET /process-instance/count?variables=myVariable_eq_camunda

Response

{"count": 1}