FLflowable
History Case
Query

Query for historic case instances

All supported JSON parameter fields allowed are exactly the same as the parameters found for getting a collection of historic case 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. On top of that, the query allows for filtering based on process variables. The variables property is a JSON-array containing objects with the format as described here.

post/cmmn-query/historic-case-instances

Request

Request body

startinteger
sizeinteger
sortstring
orderstring
caseInstanceIdstring
caseInstanceIdsstring[]
caseDefinitionIdstring
caseDefinitionKeystring
caseDefinitionKeyLikestring
caseDefinitionKeyLikeIgnoreCasestring
caseDefinitionKeysstring[]
excludeCaseDefinitionKeysstring[]
caseDefinitionCategorystring
caseDefinitionCategoryLikestring
caseDefinitionCategoryLikeIgnoreCasestring
caseDefinitionNamestring
caseDefinitionNameLikestring
caseDefinitionNameLikeIgnoreCasestring
caseBusinessKeystring
caseInstanceNamestring
caseInstanceNameLikestring
caseInstanceNameLikeIgnoreCasestring
caseInstanceRootScopeIdstring
caseInstanceRootScopeIdsstring[]
caseInstanceParentScopeIdstring
caseInstanceParentScopeIdsstring[]
caseInstanceBusinessKeystring
caseInstanceBusinessKeyLikestring
caseInstanceBusinessKeyLikeIgnoreCasestring
caseInstanceBusinessStatusstring
caseInstanceBusinessStatusLikestring
caseInstanceBusinessStatusLikeIgnoreCasestring
caseInstanceParentIdstring
caseInstanceStatestring
caseInstanceCallbackIdstring
caseInstanceCallbackIdsstring[]
caseInstanceCallbackTypestring
parentCaseInstanceIdstring
parentProcessInstanceIdstring
caseInstanceReferenceIdstring
caseInstanceReferenceTypestring
finishedboolean
involvedUserstring
finishedAfterstring date-time
finishedBeforestring date-time
startedAfterstring date-time
startedBeforestring date-time
startedBystring
finishedBystring
lastReactivatedBystring
lastReactivatedBeforestring date-time
lastReactivatedAfterstring date-time
activePlanItemDefinitionIdstring
activePlanItemDefinitionIdsstring[]
includeCaseVariablesboolean
includeCaseVariablesNamesstring[]
tenantIdstring
tenantIdLikestring
tenantIdLikeIgnoreCasestring
withoutTenantIdboolean
withoutCaseInstanceParentIdboolean
withoutCaseInstanceCallbackIdboolean

Response

Indicates request was successful and the case instances are returned

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.