FLflowable
Case Instances

List 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-runtime/case-instances

Request

Query parameters

idstring

Only return case instances with the given id.

idsstring

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

caseDefinitionKeystring

Only return case instances with the given case definition key.

caseDefinitionKeyLikestring

Only return case instances like given case definition key.

caseDefinitionKeyLikeIgnoreCasestring

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

caseDefinitionIdstring

Only return case instances with the given case definition id.

caseDefinitionCategorystring

Only return case instances with the given case definition category.

caseDefinitionCategoryLikestring

Only return case instances like the given case definition category.

caseDefinitionCategoryLikeIgnoreCasestring

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

caseDefinitionNamestring

Only return case instances with the given case definition name.

caseDefinitionNameLikestring

Only return case instances like the given case definition name.

caseDefinitionNameLikeIgnoreCasestring

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

namestring

Only return case instances with the given name.

nameLikestring

Only return case instances like the given name.

nameLikeIgnoreCasestring

Only return 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

Only return case instances with the given business key.

businessKeyLikestring

Only return case instances like the given business key.

businessKeyLikeIgnoreCasestring

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

businessStatusstring

Only return case instances with the given business status.

businessStatusLikestring

Only return case instances like the given business status.

businessStatusLikeIgnoreCasestring

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

caseInstanceParentIdstring

Only return case instances with the given parent id.

startedBystring

Only return case instances started by the given user.

startedBeforestring date-time

Only return case instances started before the given date.

startedAfterstring date-time

Only return case instances started after the given date.

statestring

Only return case instances with the given state.

callbackIdstring

Only return case instances which have the given callback id.

callbackIdsstring

Only return case instances which have the given callback ids.

callbackTypestring

Only return case instances which have the given callback type.

parentCaseInstanceIdstring

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

parentProcessInstanceIdstring

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

referenceIdstring

Only return case instances which have the given reference id.

referenceTypestring

Only return case instances which have the given reference type.

lastReactivatedBystring

Only return case instances last reactivated by the given user.

lastReactivatedBeforestring date-time

Only return case instances last reactivated before the given date.

lastReactivatedAfterstring date-time

Only return case instances last reactivated after the given date.

includeCaseVariablesboolean

Indication to include case variables in the result.

includeCaseVariablesNamestring

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

activePlanItemDefinitionIdstring

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

tenantIdstring

Only return case instances with the given tenantId.

tenantIdLikestring

Only return case instances with a tenantId like the given value.

tenantIdLikeIgnoreCasestring

Only return case instances with a tenantId like the given value, ignoring case.

withoutTenantIdboolean

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

sort'id' | 'caseDefinitionId' | 'tenantId' | 'caseDefinitionKey'

Property to sort on, to be used together with the order.

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.