Form Definition V2 Schema Type

object (Form Definition V2 Schema)

Form Definition V2 Schema Properties

engine

Form engine version to use (V1 or V2)

engine

• is optional

• Type: string (Engine)

• cannot be null

• defined in: Form Definition V2 Schema

Engine Type

string (Engine)

engine Default Value

The default value is:

Copy
"V1"

name

Unique name identifying the form

name

• is optional

• Type: string (Name)

• cannot be null

• defined in: Form Definition V2 Schema

Name Type

string (Name)

feedback

Feedback mechanism configuration

feedback

• is optional

• Type: object (Feedback)

• cannot be null

• defined in: Form Definition V2 Schema

Feedback Type

object (Feedback)

startPage

Path of the first page to show when starting the form

startPage

• is optional

• Type: string (Start Page)

• cannot be null

• defined in: Form Definition V2 Schema

Start Page Type

string (Start Page)

metadata

Custom metadata for the form

metadata

• is optional

• Type: object (Metadata)

• cannot be null

• defined in: Form Definition V2 Schema

Metadata Type

object (Metadata)

declaration

Declaration text shown on the summary page

declaration

• is optional

• Type: string (Declaration)

• cannot be null

• defined in: Form Definition V2 Schema

Declaration Type

string (Declaration)

skipSummary

option to skip the summary page

skipSummary

• is optional

• Type: any of the following: array or boolean or number or object or string (Skip Summary)

• can be null

• defined in: Form Definition V2 Schema

Skip Summary Type

any of the following: array or boolean or number or object or string (Skip Summary)

phaseBanner

Phase banner configuration

phaseBanner

• is optional

• Type: object (Phase Banner)

• cannot be null

• defined in: Form Definition V2 Schema

Phase Banner Type

object (Phase Banner)

options

Options for the form

options

• is optional

• Type: object (Options)

• cannot be null

• defined in: Form Definition V2 Schema

Options Type

object (Options)

outputEmail

Email address where form submissions are sent

outputEmail

• is optional

• Type: string (Output Email)

• cannot be null

• defined in: Form Definition V2 Schema

Output Email Type

string (Output Email)

outputEmail Constraints

email: the string must be an email address, according to RFC 5322, section 3.4.1

output

Configuration for submission output format

output

• is optional

• Type: object (Output)

• cannot be null

• defined in: Form Definition V2 Schema

Output Type

object (Output)

outputs

One or more email targets/types for submission emails

outputs

• is optional

• Type: object[] (Outputs Item)

• cannot be null

• defined in: Form Definition V2 Schema

Outputs Type

object[] (Outputs Item)

schema

Form schema version to use (2)

schema

• is optional

• Type: unknown (Schema)

• cannot be null

• defined in: Form Definition V2 Schema

Schema Type

unknown (Schema)

schema Constraints

constant: the value of this property must be equal to:

Copy
2

pages

Pages schema for V2 forms

pages

• is required

• Type: object[] (Pages Item)

• cannot be null

• defined in: Form Definition V2 Schema

Pages Type

object[] (Pages Item)

pages Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

lists

Lists schema for V2 forms

lists

• is optional

• Type: object[] (Lists Item)

• cannot be null

• defined in: Form Definition V2 Schema

Lists Type

object[] (Lists Item)

lists Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

conditions

Named conditions used for form logic

conditions

• is optional

• Type: object[] (Conditions Item)

• cannot be null

• defined in: Form Definition V2 Schema

Conditions Type

object[] (Conditions Item)

conditions Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

sections

Sections schema for V2 forms

sections

• is required

• Type: object[] (Sections Item)

• cannot be null

• defined in: Form Definition V2 Schema

Sections Type

object[] (Sections Item)

sections Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.