Process Definition

Get List Count

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

get/process-definition/count

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-definition/count
  • Auth: HTTP basic

Query parameters

processDefinitionIdstring

Filter by process definition id.

processDefinitionIdInstring

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

namestring

Filter by process definition name.

nameLikestring

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

deploymentIdstring

Filter by the deployment the id belongs to.

deployedAfterstring 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.

deployedAtstring 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.

keystring

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

keysInstring

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

keyLikestring

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

categorystring

Filter by process definition category. Exact match.

categoryLikestring

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

versioninteger

Filter by process definition version.

latestVersionboolean

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

resourceNamestring

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

resourceNameLikestring

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

startableBystring

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

activeboolean

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

suspendedboolean

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

incidentIdstring

Filter by the incident id.

incidentTypestring

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

incidentMessagestring

Filter by the incident message. Exact match.

incidentMessageLikestring

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

tenantIdInstring

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

withoutTenantIdboolean

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

includeProcessDefinitionsWithoutTenantIdboolean

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.

versionTagstring

Filter by the version tag.

versionTagLikestring

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

withoutVersionTagboolean

Only include process definitions without a versionTag.

startableInTasklistboolean

Filter by process definitions which are startable in Tasklist..

notStartableInTasklistboolean

Filter by process definitions which are not startable in Tasklist.

startablePermissionCheckboolean

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.

countinteger

The number of matching instances.

Changes

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