Skip to main content
GET
/
history
/
variable-instance
/
count
Get Variable Instance Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/variable-instance/count \
  --header 'Authorization: Basic <encoded-value>'
{
  "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.

Query Parameters

​
variableName
string

Filter by variable name.

​
variableNameLike
string

Restrict to variables with a name like the parameter.

​
variableValue
object

Filter by variable value. Is treated as a String object on server side.

​
variableNamesIgnoreCase
boolean

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

​
variableValuesIgnoreCase
boolean

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

​
variableTypeIn
string

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

Include variables that has already been deleted during the execution.

​
processInstanceId
string

Filter by the process instance the variable belongs to.

​
processInstanceIdIn
string

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

​
processDefinitionId
string

Filter by the process definition the variable belongs to.

​
processDefinitionKey
string

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

​
executionIdIn
string

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

​
caseInstanceId
string

Filter by the case instance the variable belongs to.

​
caseExecutionIdIn
string

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

​
caseActivityIdIn
string

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

​
taskIdIn
string

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

​
activityInstanceIdIn
string

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

​
tenantIdIn
string

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

​
withoutTenantId
boolean

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

​
variableNameIn
string

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

Response

Request successful.

​
count
integer

The number of matching instances.