FLflowable
Plan Item Instances
Query

Query plan item instances

The request body can contain all possible filters that can be used in the List plan item instances URL query. On top of these, it’s possible to provide an array of variables and caseInstanceVariables to include in the query, with their format described here.

The general paging and sorting query-parameters can be used for this URL.

post/cmmn-query/plan-item-instances

Request

Request body

startinteger
sizeinteger
sortstring
orderstring
idstring
elementIdstring
namestring
caseInstanceIdstring
caseInstanceIdsstring[]
caseDefinitionIdstring
stageInstanceIdstring
planItemDefinitionIdstring
planItemDefinitionTypestring
planItemDefinitionTypesstring[]
statestring
createdBeforestring date-time
createdAfterstring date-time
startUserIdstring
referenceIdstring
referenceTypestring
includeEndedboolean
includeLocalVariablesboolean
tenantIdstring
withoutTenantIdboolean

Response

Indicates request was successful and the plan item instances are returned.

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "5",
      "url": "http://localhost:8182/cmmn-runtime/plan-item-instances/5",
      "tenantId": "null",
      "localVariables": [
        {
          "name": "myVariable",
          "type": "string",
          "valueUrl": "http://...."
        }
      ]
    }
  ]
}

Changes

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