FLflowable
History PlanItem

List of historic plan item instances

get/cmmn-history/historic-planitem-instances

Request

Query parameters

planItemInstanceIdstring

The id of the historic planItem instance.

planItemInstanceNamestring

The name of the historic planItem instance.

planItemInstanceStatestring

The state of the historic planItem instance.

caseDefinitionIdstring

The id of the definition of the case were the historic planItem instance is defined.

caseInstanceIdstring

The id of the case instance were the historic planItem instance existed.

caseInstanceIdsstring

The ids of the case instances were the historic planItem instance existed.

stageInstanceIdstring

The id of the stage were the historic planItem instance was contained.

elementIdstring

The id of the planItem model of the historic planItem instance.

planItemDefinitionIdstring

The id of the planItem model definition of the historic planItem instance.

planItemDefinitionTypestring

The type of planItem of the historic planItem instance.

createdBeforeunknown

Return only historic planItem instances that were created before this date.

createdAfterunknown

Return only historic planItem instances that were created after this date.

lastAvailableBeforeunknown

Return only historic planItem instances that were last in available before this date.

lastAvailableAfterunknown

Return only historic planItem instances that were last in available state after this date.

lastEnabledBeforeunknown

Return only historic planItem instances that were last in enabled state before this date.

lastEnabledAfterunknown

Return only historic planItem instances that were last in enabled state after this date.

lastDisabledBeforeunknown

Return only historic planItem instances that were last in disable state before this date.

lastDisabledAfterunknown

Return only historic planItem instances that were last in disabled state after this date.

lastStartedBeforeunknown

Return only historic planItem instances that were last in active state before this date.

lastStartedAfterunknown

Return only historic planItem instances that were last in active state after this date.

lastSuspendedBeforeunknown

Return only historic planItem instances that were last in suspended state before this date.

lastSuspendedAfterunknown

Return only historic planItem instances that were last in suspended state after this date.

completedBeforeunknown

Return only historic planItem instances that were completed before this date.

completedAfterunknown

Return only historic planItem instances that were completed after this date.

terminatedBeforeunknown

Return only historic planItem instances that were terminated before this date.

terminatedAfterunknown

Return only historic planItem instances that were terminated after this date.

occurredBeforeunknown

Return only historic planItem instances that occurred before this date.

occurredAfterunknown

Return only historic planItem instances that occurred after after this date.

exitBeforeunknown

Return only historic planItem instances that exit before this date.

exitAfterstring date-time

Return only historic planItem instances that exit after this date.

endedBeforestring date-time

Return only historic planItem instances that ended before this date.

endedAfterstring date-time

Return only historic planItem instances that ended after this date.

startUserIdstring date-time

Return only historic planItem instances that were started by this user.

referenceIdstring

The id of process that was referenced by this historic planItem instance.

referenceTypestring

The type of reference to the process referenced by this historic planItem instance.

tenantIdstring

Only return instances with the given tenantId.

withoutTenantIdboolean

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

Response

Indicates that historic planItem instances could be queried.

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.