Skip to main content
Version: Next

Get process definition (alpha)

GET 

/process-definitions/:processDefinitionKey

Returns process definition as JSON.

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

Path Parameters

    processDefinitionKey int64required

    The assigned key of the process definition, which acts as a unique identifier for this process definition.

Responses

The process definition is successfully returned.

Schema
    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...