Sign in
Historic Variable Instance

Get Variable Instance Count (POST)

Queries for historic variable instances that fulfill the given parameters. This method takes the same message body as the Get Variable Instances (POST) method and therefore it is more powerful regarding variable values than the Get Variable Instance Count method.

post/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

Request body

variableNamestring nullable

Filter by variable name.

variableNameLikestring nullable

Restrict to variables with a name like the parameter.

variableValueobject

Filter by variable value. May be String, Number or Boolean.

variableNamesIgnoreCaseboolean nullable

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

variableValuesIgnoreCaseboolean nullable

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

variableTypeInstring[] nullable

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 nullable

Include variables that has already been deleted during the execution.

processInstanceIdstring nullable

Filter by the process instance the variable belongs to.

processInstanceIdInstring[] nullable

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

processDefinitionIdstring nullable

Filter by the process definition the variable belongs to.

processDefinitionKeystring nullable

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

executionIdInstring[] nullable

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

caseInstanceIdstring nullable

Filter by the case instance the variable belongs to.

caseExecutionIdInstring[] nullable

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

caseActivityIdInstring[] nullable

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

taskIdInstring[] nullable

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

activityInstanceIdInstring[] nullable

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

tenantIdInstring[] nullable

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

withoutTenantIdboolean nullable

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

variableNameInstring[] nullable

Only include historic variable instances which belong to one of the passed 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.