Process Instance

Update Process Variable

Sets a variable of a given process instance by id.

put/process-instance/{id}/variables/{varName}

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-instance/{id}/variables/{varName}
  • Auth: HTTP basic

Path parameters

idstring required

The id of the process instance to set the variable for.

varNamestring required

The name of the variable to set.

Request body

valueunknown
typestring nullable

The value type of the variable.

valueInfoobject

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. (Not applicable for decision-definition, /process-instance/variables-async, and /migration/executeAsync endpoints)

Response

Request successful.

Changes

No recorded changes to this operation across all 1 revision of this API.