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:

Name Description
value The variable's value. For variables of type Object, the serialized value has to be submitted as a String value.

For variables of type File the value has to be submitted as Base64 encoded string.

type The value type of the variable.
valueInfo A JSON object containing additional, value-type-dependent properties.

For serialized variables of type Object, the following properties can be provided:

  • objectTypeName: A string representation of the object's type name.
  • serializationDataFormat: The serialization format used to store the variable.

For serialized variables of type File, the following properties can be provided:

  • filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
  • mimetype: The mime type of the file that is being uploaded.
  • encoding: The encoding of the file that is being uploaded.

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.

On this Page: