Get Variable Instance Count
Queries for the number of historic variable instances that fulfill the given parameters. Takes the same parameters as the Get Variable Instances method.
Method
GET /history/variable-instance/count
Parameters
Query Parameters
| Name | Description |
|---|---|
| variableName | Filter by variable name. |
| variableNameLike | Restrict to variables with a name like the parameter. |
| variableValue | Filter by variable value. Is treated as a String object on server side. |
| variableValue | Filter by variable value. Is treated as a String object on server side. |
| variableNamesIgnoreCase | Match the variable name provided in variableName and variableNameLike case-insensitively. If set to true variableName and variablename are treated as equal. |
| variableValuesIgnoreCase | Match the variable value provided in variableValue case-insensitively. If set to true variableValue and variablevalue are treated as equal. |
| 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. |
| processDefinitionId | Filter by the process definition the variable belongs to. |
| executionIdIn | Only include historic variable instances which belong to one of the passed and comma-separated 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 and comma-separated case execution ids. |
| caseActivityIdIn | Only include historic variable instances which belong to one of the passed and comma-separated case activity ids. |
| taskIdIn | Only include historic variable instances which belong to one of the passed and comma-separated task ids. |
| activityInstanceIdIn | Only include historic variable instances which belong to one of the passed and comma-separated activity instance ids. |
| tenantIdIn | Only include historic variable instances which belong to one of the passed and comma-separated tenant ids. |
| withoutTenantId | Only include historic variable instances that belong to no tenant. Value may only be
true, as false is the default behavior. |
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. |
Example
Request
GET /history/variable-instance/count?variableName=my_variable
Response
{
"count": 1
}