FLflowable
History PlanItem
Query

Query for historic plan item instances

All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic plan item 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.

post/cmmn-query/historic-planitem-instances

Request

Request body

startinteger
sizeinteger
sortstring
orderstring
planItemInstanceIdstring
planItemInstanceNamestring
planItemInstanceStatestring
caseDefinitionIdstring
caseInstanceIdstring
caseInstanceIdsstring[]
stageInstanceIdstring
elementIdstring
planItemDefinitionIdstring
planItemDefinitionTypestring
createdBeforestring date-time
createdAfterstring date-time
lastAvailableBeforestring date-time
lastAvailableAfterstring date-time
lastEnabledBeforestring date-time
lastEnabledAfterstring date-time
lastDisabledBeforestring date-time
lastDisabledAfterstring date-time
lastStartedBeforestring date-time
lastStartedAfterstring date-time
lastSuspendedBeforestring date-time
lastSuspendedAfterstring date-time
completedBeforestring date-time
completedAfterstring date-time
terminatedBeforestring date-time
terminatedAfterstring date-time
occurredBeforestring date-time
occurredAfterstring date-time
exitBeforestring date-time
exitAfterstring date-time
endedBeforestring date-time
endedAfterstring date-time
startUserIdstring
referenceIdstring
referenceTypestring
tenantIdstring
withoutTenantIdboolean
includeLocalVariablesboolean

Response

Indicates request was successful and the plan item instances are returned

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "5",
      "name": "myPlanItemName",
      "state": "completed",
      "caseDefinitionId": "myCaseId%3A1%3A4",
      "caseInstanceId": "12345",
      "stageInstanceId": "stageId",
      "stage": true,
      "elementId": "someElementId",
      "planItemDefinitionId": "someId",
      "planItemDefinitionType": "timerEventListener",
      "createTime": "2013-04-17T10:17:43.902+0000",
      "lastAvailableTime": "2013-04-17T10:17:43.902+0000",
      "lastEnabledTime": "2013-04-17T10:17:43.902+0000",
      "lastDisabledTime": "2013-04-17T10:17:43.902+0000",
      "lastStartedTime": "2013-04-17T10:17:43.902+0000",
      "lastSuspendedTime": "2013-04-17T10:17:43.902+0000",
      "completedTime": "2013-04-17T10:17:43.902+0000",
      "occurredTime": "2013-04-17T10:17:43.902+0000",
      "terminatedTime": "2013-04-17T10:17:43.902+0000",
      "exitTime": "2013-04-17T10:17:43.902+0000",
      "endedTime": "2013-04-17T10:17:43.902+0000",
      "startUserId": "kermit",
      "referenceId": "referenceId",
      "referenceType": "referenceType",
      "tenantId": "null",
      "url": "http://localhost:8182/cmmn-history/historic-planitem-instances/5",
      "caseInstanceUrl": "http://localhost:8182/cmmn-history/historic-case-instances/12345",
      "caseDefinitionUrl": "http://localhost:8182/cmmn-repository/case-definitions/myCaseId%3A1%3A4",
      "localVariables": [
        {
          "name": "myVariable",
          "type": "string",
          "valueUrl": "http://...."
        }
      ]
    }
  ]
}

Changes

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