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

Variable Instance

Get Variable Instances

Query for variable instances that fulfill given parameters. Parameters may be the properties of variable instances, such as the name or type. The size of the result set can be retrieved by using the Get Variable Instance Count method.

get/variable-instance

Request

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

sortBy'variableName' | 'variableType' | 'activityInstanceId' | '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.

processDefinitionIdstring nullable

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

processInstanceIdstring nullable

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

executionIdstring nullable

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

caseInstanceIdstring nullable

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

caseExecutionIdstring nullable

The id of the case execution that this variable instance belongs to.

taskIdstring nullable

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

batchIdstring nullable

The id of the batch that this variable instance belongs to.<

activityInstanceIdstring nullable

The id of the activity instance that this 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.

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.