Skip to main content
Version: Next

Get process start form (alpha)

GET 

/process-definitions/:processDefinitionsKey/form

Get the start form of a process.

Note that this endpoint will only return linked forms. This endpoint does not support embedded forms. Furthermore, 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

    processDefinitionsKey int64required

    The process key.

Responses

The form is successfully returned.

Schema
    formKey int64

    The key of the form.

    tenantId string

    The tenant ID of the form.

    bpmnId string

    The BPMN ID of the form.

    schema object

    The schema of the form.

    version int64

    The version of the form.

Loading...