REST API - getAvailableProcessInstanceVariables

The table summarizes the REST API - getAvailableProcessInstanceVariables.

Request

Format 
GET <baseurl>/process/instance/variables/<processid>
Path parameters
  • processid: Unique ID of the process instance. 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
  • variable=string (0..n): Name of the variable for which a value should be returned. If this parameter is omitted, data is returned for all variables available to the specified process instance.

Response

JSON Returns a JSON representation of the content of the availableProcessInstanceVariables element.
XML Returns the content of the availableProcessInstanceVariables element (from the ProcessManagement schema).

Example

Request 
GET <baseurl>/process/instance/variables/pvm:0a12k?variable=Result
Response 
{
  "proc:variable": {
    "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",
    "proc:name": "Result",
    "proc:Type": "double"
  }
}