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

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 instance name.

​
variableNameLike
string

Filter by the variable instance name. The parameter can include the wildcard % to express like-strategy such as: starts with (%name), ends with (name%) or contains (%name%).

​
processInstanceIdIn
string

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

​
executionIdIn
string

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

​
caseInstanceIdIn
string

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

​
caseExecutionIdIn
string

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

​
taskIdIn
string

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

​
batchIdIn
string

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

​
activityInstanceIdIn
string

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

​
tenantIdIn
string

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

​
variableValues
string

Only include variable instances that have the certain values. Value filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

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. key and value may not contain underscore or comma characters.

​
variableNamesIgnoreCase
boolean

Match all variable names provided in variableValues case-insensitively. If set to true variableName and variablename are treated as equal.

​
variableValuesIgnoreCase
boolean

Match all variable values provided in variableValues case-insensitively. If set to true variableValue and variablevalue are treated as equal.

​
variableScopeIdIn
string

Only include variable instances which belong to one of passed scope ids.

Response

Request successful.

​
count
integer<int64>

The number of matching instances.