Query process definitions (alpha)
POST/process-definitions/search
Search for process definitions based on given criteria.
Note that this endpoint is an alpha feature and not enabled on Camunda clusters out of the box. The Camunda 8 API (REST) Overview page provides further details.
This endpoint is an alpha feature and may be subject to change in future releases.
Request
- application/json
Body
- Array [
- ]
sort object[]
Default value: asc
page object
filter object
The key for this process definition.
Name of this process definition.
Resource name of this process definition.
Version of this process definition.
Version tag of this process definition.
Process definition ID of this process definition.
Tenant ID of this process definition.
Responses
- 200
- 400
- 500
The process definition search result.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
page object
items object[]
The key for this process definition.
Name of this process definition.
Resource name for this process definition.
Version of this process definition.
Version tag of this process definition.
Process definition ID of this process definition.
Tenant ID of this process definition.
{
"items": [
{
"processDefinitionKey": 0,
"name": "string",
"resourceName": "string",
"version": 0,
"versionTag": "string",
"processDefinitionId": "string",
"tenantId": "string"
}
],
"page": {
"totalItems": 0,
"firstSortValues": [
{}
],
"lastSortValues": [
{}
]
}
}
The process definition search query failed. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
An internal error occurred while processing the request.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}