form-definition-schema
Form Definition Schema Type
object (Form Definition Schema)
Form Definition Schema Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| engine | string | Optional | cannot be null | Form Definition Schema |
| schema | Not specified | Optional | cannot be null | Form Definition Schema |
| name | string | Optional | cannot be null | Form Definition Schema |
| feedback | object | Optional | cannot be null | Form Definition Schema |
| startPage | string | Optional | cannot be null | Form Definition Schema |
| pages | array | Required | cannot be null | Form Definition Schema |
| sections | array | Required | cannot be null | Form Definition Schema |
| conditions | array | Optional | cannot be null | Form Definition Schema |
| lists | array | Optional | cannot be null | Form Definition Schema |
| metadata | object | Optional | cannot be null | Form Definition Schema |
| declaration | string | Optional | cannot be null | Form Definition Schema |
| skipSummary | Multiple | Optional | can be null | Form Definition Schema |
| phaseBanner | object | Optional | cannot be null | Form Definition Schema |
| options | object | Optional | cannot be null | Form Definition Schema |
| outputEmail | string | Optional | cannot be null | Form Definition Schema |
| output | object | Optional | cannot be null | Form Definition Schema |
| outputs | array | Optional | cannot be null | Form Definition Schema |
engine
Form engine version to use (V1 or V2)
engine
-
is optional
-
Type:
string(Engine) -
cannot be null
-
defined in: Form Definition Schema
Engine Type
string (Engine)
engine Default Value
The default value is:
"V1"schema
Form schema version to use (1 or 2)
schema
-
is optional
-
Type: unknown (Schema)
-
cannot be null
-
defined in: Form Definition Schema
Schema Type
unknown (Schema)
schema Constraints
constant: the value of this property must be equal to:
1schema Default Value
The default value is:
1name
Unique name identifying the form
name
-
is optional
-
Type:
string(Name) -
cannot be null
-
defined in: Form Definition Schema
Name Type
string (Name)
feedback
Feedback mechanism configuration
feedback
-
is optional
-
Type:
object(Feedback) -
cannot be null
-
defined in: Form Definition 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 Schema
Start Page Type
string (Start Page)
pages
Pages schema for V1 forms
pages
-
is required
-
Type:
object[](Pages Item) -
cannot be null
-
defined in: Form Definition Schema
Pages Type
object[] (Pages Item)
pages Constraints
unique items: all items in this array must be unique. Duplicates are not allowed.
sections
Sections grouping related pages together
sections
-
is required
-
Type:
object[](Sections Item) -
cannot be null
-
defined in: Form Definition Schema
Sections Type
object[] (Sections Item)
sections 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 Schema
Conditions Type
object[] (Conditions Item)
conditions Constraints
unique items: all items in this array must be unique. Duplicates are not allowed.
lists
Reusable lists of options for select components
lists
-
is optional
-
Type:
object[](Lists Item) -
cannot be null
-
defined in: Form Definition Schema
Lists Type
object[] (Lists Item)
lists Constraints
unique items: all items in this array must be unique. Duplicates are not allowed.
metadata
Custom metadata for the form
metadata
-
is optional
-
Type:
object(Metadata) -
cannot be null
-
defined in: Form Definition 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 Schema
Declaration Type
string (Declaration)
skipSummary
option to skip the summary page
skipSummary
-
is optional
-
Type: any of the following:
arrayorbooleanornumberorobjectorstring(Skip Summary) -
can be null
-
defined in: Form Definition 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 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 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 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 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 Schema
Outputs Type
object[] (Outputs Item)
Form Definition Schema Definitions
Definitions group conditionGroupSchema
Reference this group by using
{"$ref":"@defra/forms-model/schemas/form-definition-schema.json#/$defs/conditionGroupSchema"}| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| conditions | array | Optional | cannot be null | Form Definition Schema |
conditions
Array of conditions or condition references in this group
conditions
-
is optional
-
Type: an array of merged types (Conditions Item)
-
cannot be null
-
defined in: Form Definition Schema
Conditions Type
an array of merged types (Conditions Item)