FLflowable
History
Query

Query for historic variable instances

All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic process instances, but passed in as JSON-body arguments rather than URL-parameters to allow for more advanced querying and preventing errors with request-uri’s that are too long. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here.

post/cmmn-query/historic-variable-instances

Request

Query parameters

sort'caseInstanceId' | 'variableName'

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

Request body

startinteger
sizeinteger
sortstring
orderstring
excludeTaskVariablesboolean
taskIdstring
planItemInstanceIdstring
caseInstanceIdstring
variableNamestring
variableNameLikestring
excludeLocalVariablesboolean

Response

Indicates request was successful and the tasks are returned

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.