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

Method

GET /process-definition/count

Parameters

Query Parameters

Name	Description
processDefinitionId	Filter by process definition id.
processDefinitionIdIn	Filter by process definition ids.
name	Filter by process definition name.
nameLike	Filter by process definition names that the parameter is a substring of.
deploymentId	Filter by the deployment the id belongs to.
key	Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match.
keysIn	Filter by process definition keys.
keyLike	Filter by process definition keys that the parameter is a substring of.
category	Filter by process definition category. Exact match.
categoryLike	Filter by process definition categories that the parameter is a substring of.
version	Filter by process definition version.
latestVersion	Only include those process definitions that are latest versions. Value may only be true, as false is the default behavior.
resourceName	Filter by the name of the process definition resource. Exact match.
resourceNameLike	Filter by names of those process definition resources that the parameter is a substring of.
startableBy	Filter by a user name who is allowed to start the process.
active	Only include active process definitions. Value may only be true, as false is the default behavior.
suspended	Only include suspended process definitions. Value may only be true, as false is the default behavior.
incidentId	Filter by the incident id.
incidentType	Filter by the incident type. See the User Guide for a list of incident types.
incidentMessage	Filter by the incident message. Exact match.
incidentMessageLike	Filter by the incident message that the parameter is a substring of.
tenantIdIn	Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids.
withoutTenantId	Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior.
includeProcessDefinitionsWithoutTenantId	Include process definitions which belong to no tenant. Can be used in combination with tenantIdIn. Value may only be true, as false is the default behavior.
versionTag	Filter by the version tag.
versionTagLike	Filter by the version tag that the parameter is a substring of.
withoutVersionTag	Only include process definitions without a versionTag
startableInTasklist	Filter by process definitions which are startable in Tasklist.
startablePermissionCheck	Filter by process definitions which the user is allowed to start in Tasklist. If the user doesn't have these permissions the result will be empty list. The permissions are: * CREATE permission for all Process instances * CREATE_INSTANCE and READ permission on Process definition level
notStartableInTasklist	Filter by process definitions which are not startable in Tasklist.

Result

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

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

Response Codes

Code	Media type	Description
200	application/json	Request successful.
400	application/json	Returned if some of the query parameters are invalid. See the Introduction for the error response format.

Example

Request

GET /process-definition/count?keyLike=Key&version=47

Response

{"count": 1}