Process Definition

Get List

Queries for process definitions that fulfill given parameters. Parameters may be the properties of process definitions, such as the name, key or version. The size of the result set can be retrieved by using the Get Definition Count method.

get/process-definition

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-definition
  • 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
sortBy'category' | 'key' | 'id' | 'name' | 'version' | 'deploymentId' | 'deployTime' | 'tenantId ' | 'versionTag'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

idstring nullable

The id of the process definition

keystring nullable

The key of the process definition, i.e., the id of the BPMN 2.0 XML process definition.

categorystring nullable

The category of the process definition.

descriptionstring nullable

The description of the process definition.

namestring nullable

The name of the process definition.

versioninteger nullable

The version of the process definition that the engine assigned to it.

resourcestring nullable

The file name of the process definition.

deploymentIdstring nullable

The deployment id of the process definition.

diagramstring nullable

The file name of the process definition diagram, if it exists.

suspendedboolean nullable

A flag indicating whether the definition is suspended or not.

tenantIdstring nullable

The tenant id of the process definition.

versionTagstring nullable

The version tag of the process definition.

historyTimeToLiveinteger nullable

History time to live value of the process definition. Is used within History cleanup.

startableInTasklistboolean nullable

A flag indicating whether the process definition is startable in Tasklist or not.

Changes

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