Get Variable Instance
Retrieves a variable by id.
Method
GET /variable-instance/{id}
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the variable instance. |
Query Parameters
Name | Description |
---|---|
deserializeValue |
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 with the following properties:
Name | Value | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | String | The id of the variable instance. | ||||||||||||
name | String | The name of the variable instance. | ||||||||||||
type | String | The value type of the variable. | ||||||||||||
value | String/Number/Boolean/Object |
|
||||||||||||
valueInfo | Object | A JSON object containing additional, value-type-dependent properties.
For variables of type
|
||||||||||||
processInstanceId | String | The id of the process instance that this variable instance belongs to. | ||||||||||||
executionId | String | The id of the execution that this variable instance belongs to. | ||||||||||||
caseInstanceId | String | The id of the case instance that this variable instance belongs to. | ||||||||||||
caseExecutionId | String | The id of the case execution that this variable instance belongs to. | ||||||||||||
taskId | String | The id of the task that this variable instance belongs to. | ||||||||||||
activityInstanceId | String | The id of the activity instance that this variable instance belongs to. | ||||||||||||
tenantId | String | The id of the tenant that this variable instance belongs to. | ||||||||||||
errorMessage | String | An error message in case a Java Serialized Object could not be de-serialized. |
Response Codes
Code | Media type | Description |
---|---|---|
200 | application/json | Request successful. |
404 | application/json | Variable with given id does not exist. See the Introduction for the error response format. |
Example
Request
GET /variable-instance/someId
Response
Status 200.
{
"id": "someId",
"name": "amount",
"type": "Integer",
"variableType": "integer",
"value": 5,
"processInstanceId": "aProcessInstanceId",
"executionId": "b68b71c9-e310-11e2-beb0-f0def1557726",
"taskId": null,
"activityInstanceId": "Task_1:b68b71ca-e310-11e2-beb0-f0def1557726",
"caseExecutionId": null,
"caseInstanceId": null,
"tenantId": null,
"errorMessage": null
}