FLflowable
History Case

List of historic case instances

For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').

get/cmmn-history/historic-case-instances

Request

Query parameters

caseInstanceIdstring

An id of the historic case instance.

caseInstanceIdsstring

Only return historic case instances with the given comma-separated ids.

caseDefinitionKeystring

The case definition key of the historic case instance.

caseDefinitionKeyLikestring

Only return historic case instances like the given case definition key.

caseDefinitionKeyLikeIgnoreCasestring

Only return historic case instances like the given case definition key, ignoring case.

caseDefinitionIdstring

The case definition id of the historic case instance.

caseDefinitionCategorystring

Only return historic case instances with the given case definition category.

caseDefinitionCategoryLikestring

Only return historic case instances like the given case definition category.

caseDefinitionCategoryLikeIgnoreCasestring

Only return historic case instances like the given case definition category, ignoring case.

caseDefinitionNamestring

Only return historic case instances with the given case definition name.

caseDefinitionNameLikestring

Only return historic case instances like the given case definition name.

caseDefinitionNameLikeIgnoreCasestring

Only return historic case instances like the given case definition name, ignoring case.

namestring

Only return historic case instances with the given name.

nameLikestring

Only return historic case instances like the given name.

nameLikeIgnoreCasestring

Only return historic case instances like the given name ignoring case.

rootScopeIdstring

Only return case instances which have the given root scope id (that can be a process or case instance ID).

rootScopeIdsstring

Only return case instances which have one of the given root scope ids.

parentScopeIdstring

Only return case instances which have the given parent scope id (that can be a process or case instance ID).

parentScopeIdsstring

Only return case instances which have one of the given parent scope ids.

businessKeystring

The business key of the historic case instance.

businessKeyLikestring

Only return historic case instances like the given business key.

businessKeyLikeIgnoreCasestring

Only return historic case instances like the given business key, ignoring case.

businessStatusstring

The business status of the historic case instance.

businessStatusLikestring

Only return historic case instances like the given business status.

businessStatusLikeIgnoreCasestring

Only return historic case instances like the given business status, ignoring case.

involvedUserstring

An involved user of the historic case instance.

finishedboolean

Indication if the historic case instance is finished.

finishedAfterstring date-time

Return only historic case instances that were finished after this date.

finishedBeforestring date-time

Return only historic case instances that were finished before this date.

startedAfterstring date-time

Return only historic case instances that were started after this date.

startedBeforestring date-time

Return only historic case instances that were started before this date.

startedBystring

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

statestring

Only return historic case instances with the given state.

callbackIdstring

Only return historic case instances which have the given callback id.

callbackTypestring

Only return historic case instances which have the given callback type.

parentCaseInstanceIdstring

Only return historic case instances which have the given parent case instance id.

parentProcessInstanceIdstring

Only return historic case instances started from the given parent process instance id.

referenceIdstring

Only return historic case instances which have the given reference id.

referenceTypestring

Only return historic case instances which have the given reference type.

lastReactivatedBystring

Only return historic case instances last reactived by the given user.

lastReactivatedBeforestring date-time

Only return historic case instances last reactivated before the given date.

lastReactivatedAfterstring date-time

Only return historic case instances last reactivated after the given date.

activePlanItemDefinitionIdstring

Only return historic case instances that have an active plan item instance with the given plan item definition id.

includeCaseVariablesboolean

An indication if the historic case instance variables should be returned as well.

includeCaseVariablesNamestring

Indication to include case variables with the given names in the result.

tenantIdstring

Only return instances with the given tenant id.

tenantIdLikestring

Only return instances like the given tenant id.

tenantIdLikeIgnoreCasestring

Only return instances like the given tenant id, ignoring case.

withoutTenantIdboolean

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

withoutCaseInstanceParentIdboolean

If true, only returns instances without a parent set. If false, the withoutCaseInstanceParentId parameter is ignored.

withoutCaseInstanceCallbackIdboolean

If true, only returns instances without a callbackId set. If false, the withoutCaseInstanceCallbackId parameter is ignored.

Response

Indicates that historic case instances could be queried.

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "5",
      "url": "http://localhost:8182/cmmn-history/historic-case-instances/5",
      "name": "myName",
      "businessKey": "myKey",
      "businessStatus": "myStatus",
      "caseDefinitionId": "oneTaskCase%3A1%3A4",
      "caseDefinitionUrl": "http://localhost:8182/cmmn-repository/case-definitions/oneTaskCaseProcess%3A1%3A4",
      "caseDefinitionName": "aCaseDefinitionName",
      "caseDefinitionDescription": "A case definition description",
      "startTime": "2013-04-17T10:17:43.902+0000",
      "endTime": "2013-04-18T14:06:32.715+0000",
      "startUserId": "kermit",
      "endUserId": "kermit",
      "superProcessInstanceId": "3",
      "variables": [
        {
          "name": "myVariable",
          "type": "string",
          "valueUrl": "http://...."
        }
      ],
      "tenantId": "null",
      "state": "active",
      "callbackId": "123",
      "callbackType": "cmmn-1.1-to-cmmn-1.1-child-case",
      "referenceId": "123",
      "referenceType": "event-to-cmmn-1.1-case"
    }
  ]
}

Changes

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