Skip to main content
GET
/
process-definition
/
count
Get List Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-definition/count \
  --header 'Authorization: Basic <encoded-value>'
{
  "count": 1
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

processDefinitionId
string

Filter by process definition id.

processDefinitionIdIn
string

Filter by a comma-separated list of process definition ids.

name
string

Filter by process definition name.

nameLike
string

Filter by process definition names that the parameter is a substring of.

deploymentId
string

Filter by the deployment the id belongs to.

deployedAfter
string<date-time>

Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed after (exclusive) a specific time. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.546+0200.

deployedAt
string<date-time>

Filter by the deploy time of the deployment the process definition belongs to. Only selects process definitions that have been deployed at a specific time (exact match). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.546+0200.

key
string

Filter by process definition key, i.e., the id in the BPMN 2.0 XML. Exact match.

keysIn
string

Filter by a comma-separated list of process definition keys.

keyLike
string

Filter by process definition keys that the parameter is a substring of.

category
string

Filter by process definition category. Exact match.

categoryLike
string

Filter by process definition categories that the parameter is a substring of.

version
integer

Filter by process definition version.

latestVersion
boolean

Only include those process definitions that are latest versions. Value may only be true, as false is the default behavior.

resourceName
string

Filter by the name of the process definition resource. Exact match.

resourceNameLike
string

Filter by names of those process definition resources that the parameter is a substring of.

startableBy
string

Filter by a user name who is allowed to start the process.

active
boolean

Only include active process definitions. Value may only be true, as false is the default behavior.

suspended
boolean

Only include suspended process definitions. Value may only be true, as false is the default behavior.

incidentId
string

Filter by the incident id.

incidentType
string

Filter by the incident type. See the User Guide for a list of incident types.

incidentMessage
string

Filter by the incident message. Exact match.

incidentMessageLike
string

Filter by the incident message that the parameter is a substring of.

tenantIdIn
string

Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids.

withoutTenantId
boolean

Only include process definitions which belong to no tenant. Value may only be true, as false is the default behavior.

includeProcessDefinitionsWithoutTenantId
boolean

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
string

Filter by the version tag.

versionTagLike
string

Filter by the version tag that the parameter is a substring of.

withoutVersionTag
boolean

Only include process definitions without a versionTag.

startableInTasklist
boolean

Filter by process definitions which are startable in Tasklist..

notStartableInTasklist
boolean

Filter by process definitions which are not startable in Tasklist.

startablePermissionCheck
boolean

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

Response

Request successful.

count
integer

The number of matching instances.