Historic Variable Instance

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.

get/history/variable-instance/count

Request

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

Query parameters

variableNamestring

Filter by variable name.

variableNameLikestring

Restrict to variables with a name like the parameter.

variableValueobject

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

variableNamesIgnoreCaseboolean

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

variableValuesIgnoreCaseboolean

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

variableTypeInstring

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

includeDeletedboolean

Include variables that has already been deleted during the execution.

processInstanceIdstring

Filter by the process instance the variable belongs to.

processInstanceIdInstring

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

processDefinitionIdstring

Filter by the process definition the variable belongs to.

processDefinitionKeystring

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

executionIdInstring

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

caseInstanceIdstring

Filter by the case instance the variable belongs to.

caseExecutionIdInstring

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

caseActivityIdInstring

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

taskIdInstring

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

activityInstanceIdInstring

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

tenantIdInstring

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

withoutTenantIdboolean

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

variableNameInstring

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

Response

Request successful.

countinteger

The number of matching instances.

Changes

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