FLflowable
Plan Item Instances

List of plan item instances

get/cmmn-runtime/plan-item-instances

Request

Query parameters

idstring

Only return models with the given version.

caseDefinitionIdstring

Only return plan item instances with the given case definition id.

caseInstanceIdstring

Only return plan item instances which are part of the case instance with the given id.

caseInstanceIdsstring

Only return plan item instances which are part of the case instance with the given ids.

stageInstanceIdstring

Only return plan item instances which are part of the given stage instance.

planItemDefinitionIdstring

Only return plan item instances which have the given plan item definition id.

planItemDefinitionTypestring

Only return plan item instances which have the given plan item definition type.

planItemDefinitionTypesstring

Only return plan item instances which have any of the given plan item definition types. Comma-separated string e.g. humantask, stage

statestring

Only return plan item instances which have the given state.

namestring

Only return plan item instances which have the given name.

elementIdstring

Only return plan item instances which have the given element id.

referenceIdstring

Only return plan item instances which have the given reference id.

referenceTypestring

Only return plan item instances which have the given reference type.

createdBeforeunknown

Only return plan item instances which are created before the given date.

createdAfterunknown

Only return plan item instances which are created after the given date.

startUserIdstring

Only return plan item instances which are started by the given user id.

includeEndedboolean

Define if ended plan item instances should be included.

includeLocalVariablesboolean

Indication to include local variables in the result.

tenantIdstring

Only return plan item instances with the given tenantId.

withoutTenantIdboolean

If true, only returns plan item instances without a tenantId set. If false, the withoutTenantId parameter is ignored.

sort'name' | 'createTime' | 'startTime'

Property to sort on, to be used together with the order.

Response

Indicates request was successful and the executions 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.