Get Case Instance Count (POST)

Queries for the number of case instances that fulfill the given parameters. This method takes the same message body as the Get Case Instance (POST) method and therefore it is slightly more powerful than the Get Case Instance Count method.

Method

POST /case-instance/count

Parameters

Request Body

A JSON object with the following properties:

Name Description
caseInstanceId Filter by a case instance id.
businessKey Filter by case instance business key.
caseDefinitionId Filter by the case definition the case instances run on.
caseDefinitionKey Filter by the key of the case definition the case instances run on.
deploymentId Filter by the deployment the id belongs to.
superProcessInstance Restrict query to all case instances that are sub case instances of the given process instance. Takes a process instance id.
subProcessInstance Restrict query to all case instances that have the given process instance as a sub process instance. Takes a process instance id.
superCaseInstance Restrict query to all case instances that are sub case instances of the given case instance. Takes a case instance id.
subCaseInstance Restrict query to all case instances that have the given case instance as a sub case instance. Takes a case instance id.
active Only include active case instances. Value may only be true, as false is the default behavior.
completed Only include completed case instances. Value may only be true, as false is the default behavior.
tenantIdIn Filter by a list of tenant ids. A case instance must have one of the given tenant ids. Must be a JSON array of Strings.
withoutTenantId Only include case instances which belong to no tenant. Value may only be true, as false is the default behavior.
variables A JSON array to only include case instances that have variables with certain values.
The array consists of objects with the three properties name, operator and value. name (String) is the variable name, operator (String) is the comparison operator to be used and value the variable value.
value may be String, Number or Boolean.
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.
variableNamesIgnoreCase Match all variable names provided in variables case-insensitively. If set to true variableName and variablename are treated as equal.
variableValuesIgnoreCase Match all variable values provided in variables case-insensitively. If set to true variableValue and variablevalue are treated as equal.
sortBy Sort the results lexicographically by a given criterion. Valid values are caseInstanceId, caseDefinitionKey and caseDefinitionId. Must be used in conjunction with the sortOrder parameter.
sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Result

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

Name Type Description
count Number The number of matching case 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 an invalid operator for variable comparison is used. See the Introduction for the error response format.

Example

Request

POST /case-instance/count

Request body:

{
  "variables":
    [
      {
        "name" : "myVariable",
        "operator" : "eq",
        "value" : "camunda"
      },
      {
        "name" : "mySecondVariable",
        "operator" : "neq",
        "value" : 124
      }
    ],
  "caseDefinitionId" : "acaseDefinitionId"
}

Response

{
  "count" : 1
}

On this Page: