Skip to main content
POST
/
variable-instance
/
count
Get Variable Instance Count (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/variable-instance/count \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "variableValues": [
    {
      "name": "amount",
      "operator": "gteq",
      "value": "5"
    },
    {
      "name": "amount",
      "operator": "lteq",
      "value": 200
    }
  ],
  "processInstanceIdIn": [
    "aProcessInstanceId",
    "anotherProcessInstanceId"
  ]
}'
{
  "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.

Body

application/json

A variable instance query which defines a list of variable instances

​
variableName
string | null

Filter by variable instance name.

​
variableNameLike
string | null

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[] | null

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

​
executionIdIn
string[] | null

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

​
caseInstanceIdIn
string[] | null

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

​
caseExecutionIdIn
string[] | null

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

​
taskIdIn
string[] | null

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

​
batchIdIn
string[] | null

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

​
activityInstanceIdIn
string[] | null

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

​
tenantIdIn
string[] | null

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

​
variableValues
object[] | null

An array to only include variable instances that have the certain values. The array consists of objects with the three properties name, operator and value. name (String) is the variable name, operator (String) is the comparison operator to be used and value the variable value. value may be String, Number or Boolean.

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

​
variableNamesIgnoreCase
boolean | null

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

​
variableValuesIgnoreCase
boolean | null

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

​
variableScopeIdIn
string[] | null

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

​
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.