Skip to main content
Version: Next

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

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

The process definition search result.

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.

  • ]
Loading...