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

200

On success returned.

application/json

Schema

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.

Example (from schema)

{
  "id": "string",
  "processDefinitionKey": "string",
  "title": "string",
  "schema": "string",
  "version": 0,
  "tenantId": "string",
  "isDeleted": true
}

404

An error is returned when the form with the formId, processDefinitionKey, and optionally specified version is not found.

application/problem+json

Schema

Schema

status int32

An integer that represents the HTTP status code of the error response. For example, 400 indicates a "Bad Request" error, 404 indicates a "Not Found" error, and so on.

message string

A string that provides a brief description of the error that occurred.

instance string

Error instance UUID for lookup (eg. in log messages).

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string"
}

Loading...