Sign in
Historic Variable Instance

Get Variable Instance

Retrieves a historic variable by id.

get/history/variable-instance/{id}

Request

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

Path parameters

idstring required

The id of the variable instance.

Query parameters

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.