Case Instances
Query

Query case instances

The request body can contain all possible filters that can be used in the List case instances URL query. On top of these, it’s possible to provide an array of variables to include in the query, with their format described here.

The general paging and sorting query-parameters can be used for this URL.

post/cmmn-query/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
caseInstanceStartedBystring
caseInstanceStartedBeforestring date-time
caseInstanceStartedAfterstring date-time
caseInstanceStatestring
involvedUserstring
caseInstanceCallbackIdstring
caseInstanceCallbackIdsstring[]
caseInstanceCallbackTypestring
parentCaseInstanceIdstring
parentProcessInstanceIdstring
caseInstanceReferenceIdstring
caseInstanceReferenceTypestring
caseInstanceLastReactivatedBystring
caseInstanceLastReactivatedBeforestring date-time
caseInstanceLastReactivatedAfterstring date-time
includeCaseVariablesboolean
includeCaseVariablesNamesstring[]
activePlanItemDefinitionIdstring
activePlanItemDefinitionIdsstring[]
tenantIdstring
tenantIdLikestring
tenantIdLikeIgnoreCasestring
withoutTenantIdboolean

Response

Indicates request was successful and the case instances are returned

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "187",
      "name": "processName",
      "url": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4",
      "businessKey": "myBusinessKey",
      "businessStatus": "myBusinessStatus",
      "startTime": "2019-04-17T10:17:43.902+0000",
      "startUserId": "aUserId",
      "state": "active",
      "caseDefinitionId": "oneTaskCase:1:158",
      "caseDefinitionUrl": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4",
      "caseDefinitionName": "aCaseDefinitionName",
      "caseDefinitionDescription": "A case definition description",
      "parentId": "123",
      "callbackId": "123",
      "callbackType": "cmmn-1.1-to-cmmn-1.1-child-case",
      "referenceId": "123",
      "referenceType": "event-to-cmmn-1.1-case",
      "variables": [
        {
          "name": "myVariable",
          "type": "string",
          "valueUrl": "http://...."
        }
      ],
      "tenantId": "null"
    }
  ]
}

Changes

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