Get Case Executions Count

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

Method

GET /case-execution/count

Parameters

Query Parameters

Name Description
caseExecutionId Filter by a case execution id.
caseInstanceId Filter by a case instance id.
businessKey Filter by the business key of the case instances the case executions belong to.
caseDefinitionId Filter by the case definition the case executions run on.
caseDefinitionKey Filter by the key of the case definition the case executions run on.
activityId Filter by the id of the activity the case execution currently executes.
required Only include required case executions. Value may only be true, as false is the default behavior.
repeatable Only include repeatable case executions. Value may only be true, as false is the default behavior.
repetition Only include case executions which are repetitions. Value may only be true, as false is the default behavior.
active Only include active case executions. Value may only be true, as false is the default behavior.
enabled Only include enabled case executions. Value may only be true, as false is the default behavior.
disabled Only include disabled case executions. Value may only be true, as false is the default behavior.
variables Only include case executions 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.
caseInstanceVariables Only include case executions that belong to a case instance with 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 Value Description
count Number The number of matching case executions.

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 an invalid operator for variable comparison is used. See the Introduction for the error response format.

Example

Request

GET /case-execution/count?variables=myVariable_eq_camunda

Response

{
  "count": 1
}

On this Page: