Skip to main content
GET
/
process-definition
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-definition \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "invoice:1:c3a63aaa-2046-11e7-8f94-34f39ab71d4e",
    "key": "invoice",
    "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    "description": null,
    "name": "Invoice Receipt",
    "version": 1,
    "resource": "invoice.v1.bpmn",
    "deploymentId": "c398cd26-2046-11e7-8f94-34f39ab71d4e",
    "diagram": null,
    "suspended": false,
    "tenantId": null,
    "versionTag": null,
    "historyTimeToLive": 5,
    "startableInTasklist": true
  },
  {
    "id": "invoice:2:c3e1bd16-2046-11e7-8f94-34f39ab71d4e",
    "key": "invoice",
    "category": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    "description": null,
    "name": "Invoice Receipt",
    "version": 2,
    "resource": "invoice.v2.bpmn",
    "deploymentId": "c3d82020-2046-11e7-8f94-34f39ab71d4e",
    "diagram": null,
    "suspended": false,
    "tenantId": null,
    "versionTag": null,
    "historyTimeToLive": null,
    "startableInTasklist": true
  }
]

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
sortBy
enum<string>

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

Available options:
category,
key,
id,
name,
version,
deploymentId,
deployTime,
tenantId ,
versionTag
sortOrder
enum<string>

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.

Available options:
asc,
desc
firstResult
integer

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

maxResults
integer

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.

id
string | null

The id of the process definition

key
string | null

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

category
string | null

The category of the process definition.

description
string | null

The description of the process definition.

name
string | null

The name of the process definition.

version
integer | null

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

resource
string | null

The file name of the process definition.

deploymentId
string | null

The deployment id of the process definition.

diagram
string | null

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

suspended
boolean | null

A flag indicating whether the definition is suspended or not.

tenantId
string | null

The tenant id of the process definition.

versionTag
string | null

The version tag of the process definition.

historyTimeToLive
integer | null

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

Required range: x >= 0
startableInTasklist
boolean | null

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