Get Process Variables
Retrieves all variables of a given process instance by id.
Method
GET /process-instance/{id}/variables
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the process instance to retrieve the variables from. |
Query Parameters
Name | Description |
---|---|
deserializeValues |
Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true ).
If set to If set to Note: While |
Result
A JSON object of variables key-value pairs. Each key is a variable name and each value a variable value object that has the following properties:
Name | Value | Description |
---|---|---|
value | String / Number / Boolean / Object |
The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter.
|
type | String | The value type of the variable. |
valueInfo | Object |
A JSON object containing additional, value-type-dependent properties.
For variables of type
|
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
500 | application/json | Process instance with given id does not exist. See the Introduction for the error response format. |
Example 1
Request
GET /process-instance/aProcessInstanceId/variables
Response
{
"aVariableKey": {
"value" : {"prop1" : "a", "prop2" : "b"},
"type" : "Object",
"valueInfo" : {
"objectTypeName": "com.example.MyObject",
"serializationDataFormat": "application/xml"
}
}
}
Example 2
Request
GET /process-instance/aProcessInstanceId/variables?deserializeValues=false
Response
{
"aVariableKey": {
"value" : "ab",
"type" : "Object",
"valueInfo" : {
"objectTypeName": "com.example.MyObject",
"serializationDataFormat": "application/xml"
}
}
}