Edit on Github

Put Task Variable

Updates a process variable that is visible from the Task scope. A variable is visible from the task if it is a local task variable, or declared in a parent scope of the task. See the documentation on variable scopes and visibility.

Note: If a variable doesn’t exist, the variable is created in the top-most scope visible from the task.

Method

PUT /task/{id}/variables/{varName}

Parameters

Path Parameters

Name Description
id The id of the task to set the variable for.
varName The name of the variable to set.

Request Body

A JSON 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.

The following property can be provided for all value types:

  • transient: Indicates whether the variable should be transient or not. See documentation for more informations.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json The variable name, 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 or a new transient variable has the name that is already persisted. See the Introduction for the error response format.
500 application/json The variable name is null. Task id is null or does not exist. See the Introduction for the error response format.

Example 1

Request

PUT /task/aTaskId/variables/aVarName

{"value" : "someValue", "type": "String"}

Response

Status 204. No content.

Example 2

Request

PUT /task/aTaskId/variables/aVarName

{
  "value" : "ab",
  "type" : "Object",
  "valueInfo" : {
    "objectTypeName": "com.example.MyObject",
    "serializationDataFormat": "application/xml"
  }
}

Response

Status 204. No content.

On this Page: