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.

note

This endpoint is an alpha feature and may be subject to change in future releases.

Request

application/json

Body

sort object[]
Array [
field stringrequired
order string
Default value: asc
]
page object
from int32
limit int32
searchAfter object[]
searchBefore object[]
filter object

processDefinitionKey int64

The key for this process definition.

name string

Name of this process definition.

resourceName string

Resource name of this process definition.

version int32

Version of this process definition.

versionTag string

Version tag of this process definition.

processDefinitionId string

Process definition ID of this process definition.

tenantId string

Tenant ID of this process definition.

Responses

200

The process definition search result.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
processDefinitionKey int64
The key for this process definition.
name string
Name of this process definition.
resourceName string
Resource name for this process definition.
version int32
Version of this process definition.
versionTag string
Version tag of this process definition.
processDefinitionId string
Process definition ID of this process definition.
tenantId string
Tenant ID of this process definition.
]

Example (from schema)

{
  "items": [
    {
      "processDefinitionKey": 0,
      "name": "string",
      "resourceName": "string",
      "version": 0,
      "versionTag": "string",
      "processDefinitionId": "string",
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The process definition search query failed. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...