Put Task Variable
Sets a visible from the task. 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. If a variable visible from the task with the given name already exists, it is overwritten. Otherwise, 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 |
type | The value type of the variable. |
valueInfo |
A JSON object containing additional, value-type-dependent properties.
For serialized variables of type
For serialized variables of type
The following property can be provided for all value types:
|
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" : "a b ",
"type" : "Object",
"valueInfo" : {
"objectTypeName": "com.example.MyObject",
"serializationDataFormat": "application/xml"
}
}
Response
Status 204. No content.