Authorization9

Batch7

Condition1

Decision Definition17

Decision Requirements Definition11

Deployment10

Engine1

Event Subscription2

Execution16

External Task18

Filter14

Group13

Historic Activity Instance5

Historic Batch7

Historic Decision Definition2

Historic Decision Instance5

Historic Decision Requirements Definition1

Historic Detail5

Historic External Task Log6

Historic Identity Link Log2

Historic Incident2

Historic Job Log6

Historic Process Definition3

Historic Process Instance10

Historic Task Instance5

Historic User Operation Log4

Historic Variable Instance7

History Cleanup4

Identity4

Incident6

Job15

Job Definition9

Message1

Metrics3

Migration4

Modification2

Process Definition46

Process Instance25

Process Instance Comment4

Schema Log2

Signal1

Task22

Task Attachment5

Task Comment6

Task Identity Link3

Task Local Variable7

Task Variable7

Telemetry3

Tenant14

User10

Variable Instance6

Version1

Historic Variable Instance

Get Variable Instances

Queries for historic variable instances that fulfill the given parameters. The size of the result set can be retrieved by using the Get Variable Instance Count method.

get/history/variable-instance

Request

Base URL: http://localhost:8080/engine-rest
URL: http://localhost:8080/engine-rest/history/variable-instance
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.

sortBy'instanceId' | 'variableName' | 'tenantId'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

deserializeValuesboolean

Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true).

If set to true, a serializable variable will be deserialized on server side and transformed to JSON using Jackson's POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath.

If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML.

Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine.

Response

Request successful.

idstring nullable

The id of the variable instance.

namestring nullable

The name of the variable instance.

processDefinitionKeystring nullable

The key of the process definition the variable instance belongs to.

processDefinitionIdstring nullable

The id of the process definition the variable instance belongs to.

processInstanceIdstring nullable

The process instance id the variable instance belongs to.

executionIdstring nullable

The execution id the variable instance belongs to.

activityInstanceIdstring nullable

The id of the activity instance in which the variable is valid.

caseDefinitionKeystring nullable

The key of the case definition the variable instance belongs to.

caseDefinitionIdstring nullable

The id of the case definition the variable instance belongs to.

caseInstanceIdstring nullable

The case instance id the variable instance belongs to.

caseExecutionIdstring nullable

The case execution id the variable instance belongs to.

taskIdstring nullable

The id of the task the variable instance belongs to.

tenantIdstring nullable

The id of the tenant that this variable instance belongs to.

errorMessagestring nullable

An error message in case a Java Serialized Object could not be de-serialized.

statestring nullable

The current state of the variable. Can be 'CREATED' or 'DELETED'.

createTimestring date-time nullable

The time the variable was inserted. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

removalTimestring date-time nullable

The time after which the variable should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

rootProcessInstanceIdstring nullable

The process instance id of the root process instance that initiated the process containing this variable.

valueunknown

typestring nullable

The value type of the variable.

valueInfoobject

A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided:

objectTypeName: A string representation of the object's type name.
serializationDataFormat: The serialization format used to store the variable.

For serialized variables of type File, the following properties can be provided:

filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
mimetype: The MIME type of the file that is being uploaded.
encoding: The encoding of the file that is being uploaded.

The following property can be provided for all value types:

transient: Indicates whether the variable should be transient or not. See documentation for more informations. (Not applicable for decision-definition, /process-instance/variables-async, and /migration/executeAsync endpoints)

Changes

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