FLflowable
History

List of variable instances

For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').

get/cmmn-runtime/variable-instances

Request

Query parameters

caseInstanceIdstring

The case instance id of the variable instance.

taskIdstring

The task id of the variable instance.

excludeTaskVariablesboolean

Indication to exclude the task variables from the result.

excludeLocalVariablesboolean

Indication to exclude local variables or not.

variableNamestring

The variable name of the variable instance.

variableNameLikestring

The variable name using the like operator for the variable instance.

sort'caseInstanceId' | 'variableName'

The field to sort by. Defaults to 'variableName'.

orderstring

The sort order, either 'asc' or 'desc'. Defaults to 'asc'.

startinteger

Index of the first row to fetch. Defaults to 0.

sizeinteger

Number of rows to fetch, starting from start. Defaults to 10.

Response

Indicates that variable instances could be queried.

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "14",
      "caseInstanceId": "5",
      "caseInstanceUrl": "http://localhost:8182/cmmn-history/historic-case-instances/5",
      "taskId": "6",
      "variable": {
        "name": "myVariable",
        "type": "string",
        "valueUrl": "http://...."
      }
    }
  ]
}

Changes

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