Update/Delete Task Variables
Updates or deletes the variables visible from the task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update. A variable is visible from the task if it is a local task variable or declared in a parent scope of the task. See documentation on visiblity of variables.
Method
POST /task/{id}/variables
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/variables
Request Body:
{
"modifications": {
"aVariable": { "value": "aValue", "type": "String" },
"anotherVariable": { "value": 42, "type": "Integer" }
},
"deletions": [
"aThirdVariable", "FourthVariable"
]
}
Response
Status 204. No content.