Skip to main content
GET
/
process-instance
/
{id}
/
variables
/
{varName}
Get Process Variable
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-instance/{id}/variables/{varName} \
  --header 'Authorization: Basic <encoded-value>'
{
  "value": {
    "prop1": "a",
    "prop2": "b"
  },
  "type": "Object",
  "valueInfo": {
    "objectTypeName": "com.example.MyObject",
    "serializationDataFormat": "application/xml"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the process instance to retrieve the variable for.

​
varName
string
required

The name of the variable to retrieve.

Query Parameters

​
deserializeValue
boolean
default:true

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.

​
value
any

Can be any value - string, number, boolean, array or object. Note: Not every endpoint supports every type.

​
type
string | null

The value type of the variable.

​
valueInfo
object

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)