Skip to main content
Version: 8.4

FormResponse

FormResponse - represents task embedded form.

{
    "id": string,
    "processDefinitionKey": string,
    "schema": string,
    "version": long,
    "tenantId": string,
    "isDeleted": boolean
}

Fields​

FormResponse.id ● string non-null​

The unique identifier of the embedded form within one process

FormResponse.processDefinitionKey ● string non-null​

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

FormResponse.schema ● string non-null​

Form content

FormResponse.version ● long ​

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

FormResponse.tenantId ● string non-null​

Indicates the Tenant ID associated with the returned form

FormResponse.isDeleted ● boolean non-null​

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

Returned by​

Get form GET