Get Case Definition Count

Requests the number of case definitions that fulfill the query criteria. Takes the same filtering parameters as the Get Case Definitions method.

Method

GET /case-definition/count

Parameters

Query Parameters

Name Description
caseDefinitionId Filter by case definition id.
caseDefinitionIdIn Filter by case definition ids.
name Filter by case definition name.
nameLike Filter by case definition names that the parameter is a substring of.
deploymentId Filter by the deployment the id belongs to.
key Filter by case definition key, i.e., the id in the CMMN XML. Exact match.
keyLike Filter by case definition keys that the parameter is a substring of.
category Filter by case definition category. Exact match.
categoryLike Filter by case definition categories that the parameter is a substring of.
version Filter by case definition version.
latestVersion Only include those case definitions that are latest versions. Value may only be true, as false is the default behavior.
resourceName Filter by the name of the case definition resource. Exact match.
resourceNameLike Filter by names of those case definition resources that the parameter is a substring of.
tenantIdIn Filter by a comma-separated list of tenant ids. A case definition must have one of the given tenant ids.
withoutTenantId Only include case definitions which belong to no tenant. Value may only be true, as false is the default behavior.
includeCaseDefinitionsWithoutTenantId Include case definitions which belong to no tenant. Can be used in combination with tenantIdIn. Value may only be true, as false is the default behavior.

Result

A JSON object that contains the count as the only property.

Name Type Description
count Number The number of matching case definitions.

Response Codes

Code Media type Description
200 application/json Request successful.
400 application/json Returned if some of the query parameters are invalid, for example if a sortOrder parameter is supplied, but no sortBy. See the Introduction for the error response format.

Example

Request

GET /case-definition/count?keyLike=Key&version=2

Response

{
  "count": 1
}

On this Page: