Skip to main content
Version: 8.4

Get a form

GET 

/v1/forms/:formId

Get the form details by formId and processDefinitionKey required query param. The version query param is optional and is used only for deployed forms (if empty, it retrieves the highest version).

Request

Path Parameters

    formId stringrequired

    The ID of the form.

Query Parameters

    processDefinitionKey stringrequired

    Reference to the process definition.

    version int64

    The version of the form. Valid only for deployed forms.

Responses

On success returned.

Schema
    id string

    The unique identifier of the embedded form within one process.

    processDefinitionKey string

    Reference to process definition (renamed equivalent of Form.processDefinitionId field).

    title string

    The title of the form.

    schema string

    The form content.

    version int64

    The version field is null in the case of an embedded form, while it represents the deployed form's version in other scenarios.

    tenantId string

    The tenant ID associated with the form.

    isDeleted boolean

    Indicates whether the deployed form is deleted or not on Zeebe. This field is false by default, in the case of an embedded form.

Loading...