Get Variable Instance Count (POST)

Queries for historic variable instances that fulfill the given parameters. This method takes the same message body as the Get Variable Instances (POST) method and therefore it is more powerful regarding variable values than the Get Variable Instance Count method.

Method

POST /history/variable-instance/count

Parameters

Request Body

A JSON object with the following properties:

Name Description
variableName Filter by variable name.
variableNameLike Restrict to variables with a name like the parameter.
variableValue Filter by variable value. May be String, Number or Boolean.
includeDeleted Include variables that has already been deleted during the execution.
processInstanceId Filter by the process instance the variable belongs to.
processInstanceIdIn Only include historic variable instances which belong to one of the passed process instance ids.
executionIdIn Only include historic variable instances which belong to one of the passed execution ids.
caseInstanceId Filter by the case instance the variable belongs to.
caseExecutionIdIn Only include historic variable instances which belong to one of the passed case execution ids.
caseActivityIdIn Only include historic variable instances which belong to one of the passed case activity ids.
taskIdIn Only include historic variable instances which belong to one of the passed task ids.
activityInstanceIdIn Only include historic variable instances which belong to one of the passed activity instance ids.
tenantIdIn Only include historic variable instances which belong to one of the passed and comma-separated tenant ids.

Result

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

Name Value Description
count Number The number of matching historic variable 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

POST /history/variable-instance/count

Request Body:

{
  "variableName": "someVariable",
  "variableValue": 42
}

Response

{
  "count": 1
}

On this Page: