Edit on Github

Update/Delete Process Variables

Updates or deletes the variables of a process instance by id. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.

Method

POST /process-instance/{id}/variables

Parameters

Path Parameters

Name	Description
id	The id of the process instance 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. 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.

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 if 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, for example because the process instance does not exist.

Example

Request

POST /process-instance/aProcessInstanceId/variables

Request Body:

{"modifications":
    {"aVariable": {"value": "aValue"},
    "anotherVariable": {"value": 42}},
"deletions": [
    "aThirdVariable", "FourthVariable"
]}

Response

Status 204. No content.

Options