Sign in
Variable Instance

Get Variable Instance Count

Query for the number of variable instances that fulfill given parameters. Takes the same parameters as the Get Variable Instances method.

get/variable-instance/count

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/variable-instance/count
  • Auth: HTTP basic

Query parameters

variableNamestring

Filter by variable instance name.

variableNameLikestring

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%).

processInstanceIdInstring

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

executionIdInstring

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

caseInstanceIdInstring

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

caseExecutionIdInstring

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

taskIdInstring

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

batchIdInstring

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

activityInstanceIdInstring

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

tenantIdInstring

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

variableValuesstring

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.

variableNamesIgnoreCaseboolean

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

variableValuesIgnoreCaseboolean

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

variableScopeIdInstring

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

Response

Request successful.

countinteger

The number of matching instances.

Changes

No recorded changes to this operation across all 1 revision of this API.