Update/Delete Case Execution Variables
Updates or deletes the variables of a case execution by id. Please note: deletion precedes update.
Method
POST /case-execution/{id}/variables
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the case execution to set variables for. |
Request Body
A JSON object with the following properties:
Name | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
modifications | A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object with the following properties:
| ||||||||
deletions | An array of String keys of variables to be deleted. |
Result
This method returns no content.
Response Codes
Code | Media type | Description |
---|---|---|
204 | Request successful. | |
400 | application/json | The variable value or type is invalid, for example if the value could not be parsed to an Integer value or the passed variable type is not supported. See the Introduction for the error response format. |
500 | application/json | Update or deletion could not be executed, for example because the case execution does not exist. |
Example
Request
POST /case-execution/aCaseExecutionId/variables
Request Body:
{
"modifications":
{
"aVariable":
{
"value": "aValue"
},
"anotherVariable":
{
"value": 42
}
},
"deletions":
[
"aThirdVariable",
"FourthVariable"
]
}
Response
Status 204. No content.