Skip to main content
GET
/
process-instance
/
{id}
/
variables
Get Process Variables
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-instance/{id}/variables \
  --header 'Authorization: Basic <encoded-value>'
{
  "aVariableKey": {
    "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 variables from.

Query Parameters

​
deserializeValues
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.

​
{key}
object