REST API - setAvailableProcessInstanceVariables

The table summarizes the REST API - setAvailableProcessInstanceVariables.

Request

Format 
PUT <baseurl>/process/set/instance/variables/<processid>
Path parameters processid: Unique ID of the halted process instance whose variables are to be set. Can be obtained from queryHaltedProcessInstances .

The specified process instance must be in a HALTED state for the request to be valid. An illegalStateFault is returned if the process instance is in any other state.
Query parameters
  • name=string (1..n): Name of the process instance variable to be set.
  • value=string (1..n): Value of the process instance variable to be set.

    The available variables can be obtained from getAvailableProcessInstanceVariables .

Response

JSON If successful, returns 204 No Content in the response header, and OK in the response body.
XML If successful, returns 204 No Content in the response header, and OK in the response body.

Example

Request 
PUT <baseurl>/process/set/instance/variables/pvm:0a1212?name=RunDivisionByZeroTest&value=false
Response 
OK