Sign in
Forms

Get a form definition by ID

Gets a form definition by its ID for a given form.

get/api/forms/{formId}/definitions/{definitionId}

Path parameters

formIdinteger required

The ID of the form.

definitionIdinteger required

The ID of the form definition.

Response

Form definition retrieved successfully.

idstring nullable

The ID of the form definition.

isDraftboolean

Indicates if the form definition is a draft.

jsonDatastring nullable

The JSON data of the form definition.

formIdstring nullable

The ID of the associated form.

createdAtstring date-time

The date and time when the form definition was created.

modifiedAtstring date-time nullable

The date and time when the form definition was last modified.

themeModelstring nullable

The model of the associated theme stored as a stringified JSON object.

customQuestionsstring[] nullable

The list of custom questions' JSON data associated with this form definition.

requiresReCaptchaboolean nullable

Indicates if reCAPTCHA is enabled for this form definition.

Changes

Changed in 2 of the 7 revisions of this API.134

  • 50eff5014b7813See the full diff
    • ▲

      removed the media type application/problem+json for the response with the status 400

      response-media-type-removed

    • ○

      added the optional property customQuestions to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property requiresReCaptcha to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property themeModel to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fbc3fe6ecbf131See the full diff
    • ●

      removed the optional property customQuestions from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property requiresReCaptcha from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property themeModel from the response with the 200 status

      response-optional-property-removed

    • ○

      added the media type application/problem+json for the response with the status 400

      response-media-type-added

    This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog