Update/Delete Local Task Variables
Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
Method
POST /task/{id}/localVariables
Parameters
Path Parameters
Name | Description |
---|---|
id | The id of the task 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 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 delete could not be executed because the task is null or does not exist. |
Example
Request
POST /task/aTaskId/localVariables
Request Body:
{
"modifications": {
"aVariable": { "value": "aValue", "type": "String" },
"anotherVariable": { "value": 42, "type": "Integer" }
},
"deletions": [
"aThirdVariable", "FourthVariable"
]
}
Response
Status 204. No content.