Skip to main content
POST
/
process-instance
/
{id}
/
variables
Update/Delete Process Variables
curl --request POST \
  --url http://{host}:{port}/{contextPath}/process-instance/{id}/variables \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "modifications": {
    "aVariable": {
      "value": "aValue",
      "type": "String"
    },
    "anotherVariable": {
      "value": 42,
      "type": "Integer"
    }
  },
  "deletions": [
    "aThirdVariable",
    "FourthVariable"
  ]
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the process instance to set variables for.

Body

application/json
​
modifications
object

A JSON object containing variable key-value pairs.

​
deletions
string[] | null

An array of String keys of variables to be deleted.

Response

Request successful.