Skip to main content
POST
/
history
/
variable-instance
/
count
Get Variable Instance Count (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/history/variable-instance/count \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "variableName": "someVariable",
  "variableValue": 42
}'
{
  "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 Variable Instance instance query which defines a list of Historic Variable Instance instances

​
variableName
string | null

Filter by variable name.

​
variableNameLike
string | null

Restrict to variables with a name like the parameter.

​
variableValue
object

Filter by variable value. May be String, Number or Boolean.

​
variableNamesIgnoreCase
boolean | null

Match the variable name provided in variableName and variableNameLike case- insensitively. If set to true variableName and variablename are treated as equal.

​
variableValuesIgnoreCase
boolean | null

Match the variable value provided in variableValue case-insensitively. If set to true variableValue and variablevalue are treated as equal.

​
variableTypeIn
string[] | null

Only include historic variable instances which belong to one of the passed and comma- separated variable types. A list of all supported variable types can be found here. Note: All non-primitive variables are associated with the type 'serializable'.

​
includeDeleted
boolean | null

Include variables that has already been deleted during the execution.

​
processInstanceId
string | null

Filter by the process instance the variable belongs to.

​
processInstanceIdIn
string[] | null

Only include historic variable instances which belong to one of the passed process instance ids.

​
processDefinitionId
string | null

Filter by the process definition the variable belongs to.

​
processDefinitionKey
string | null

Filter by a key of the process definition the variable belongs to.

​
executionIdIn
string[] | null

Only include historic variable instances which belong to one of the passed and execution ids.

​
caseInstanceId
string | null

Filter by the case instance the variable belongs to.

​
caseExecutionIdIn
string[] | null

Only include historic variable instances which belong to one of the passed and case execution ids.

​
caseActivityIdIn
string[] | null

Only include historic variable instances which belong to one of the passed and case activity ids.

​
taskIdIn
string[] | null

Only include historic variable instances which belong to one of the passed and task ids.

​
activityInstanceIdIn
string[] | null

Only include historic variable instances which belong to one of the passed and activity instance ids.

​
tenantIdIn
string[] | null

Only include historic variable instances which belong to one of the passed and comma- separated tenant ids.

​
withoutTenantId
boolean | null

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

​
variableNameIn
string[] | null

Only include historic variable instances which belong to one of the passed variable names.

​
sorting
object[] | null

An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Sorting has no effect for count endpoints

Response

Request successful.

​
count
integer

The number of matching instances.