form-metadata-schema
Form Metadata Schema Type
object (Form Metadata Schema)
Form Metadata Schema Properties
title
Title of the form, displayed to users
title
-
is required
-
Type:
string(Title) -
cannot be null
-
defined in: Form Metadata Schema
Title Type
string (Title)
title Constraints
maximum length: the maximum number of characters for this string is: 250
organisation
Defra organisation responsible for the form
organisation
-
is required
-
Type:
string(Organisation) -
cannot be null
-
defined in: Form Metadata Schema
Organisation Type
string (Organisation)
organisation Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"Animal and Plant Health Agency – APHA" | |
"Centre for Environment, Fisheries and Aquaculture Science – Cefas" | |
"Defra" | |
"Environment Agency" | |
"Forestry Commission" | |
"Marine Management Organisation – MMO" | |
"Natural England" | |
"Rural Payments Agency – RPA" | |
"Veterinary Medicines Directorate – VMD" |
teamName
Name of the team responsible for the form
teamName
-
is required
-
Type:
string(Team Name) -
cannot be null
-
defined in: Form Metadata Schema
Team Name Type
string (Team Name)
teamName Constraints
maximum length: the maximum number of characters for this string is: 100
teamEmail
Contact email for the team responsible for the form
teamEmail
-
is required
-
Type:
string(Team Email) -
cannot be null
-
defined in: Form Metadata Schema
Team Email Type
string (Team Email)
teamEmail Constraints
email: the string must be an email address, according to RFC 5322, section 3.4.1
contact
Complete contact information for form-related inquiries
contact
-
is optional
-
Type:
object(Contact) -
cannot be null
-
defined in: Form Metadata Schema
Contact Type
object (Contact)
submissionGuidance
Guidance text shown to users when submitting the form
submissionGuidance
-
is optional
-
Type:
string(Submission Guidance) -
cannot be null
-
defined in: Form Metadata Schema
Submission Guidance Type
string (Submission Guidance)
privacyNoticeType
Type of privacy notice content
privacyNoticeType
-
is optional
-
Type:
string(Privacy Notice Type) -
cannot be null
-
defined in: Form Metadata Schema
Privacy Notice Type Type
string (Privacy Notice Type)
privacyNoticeType Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"text" | |
"link" |
privacyNoticeText
The privacy notice text value.
privacyNoticeText
-
is optional
-
Type: any of the following:
arrayorbooleanornumberorobjectorstring(Privacy Notice Text) -
can be null
-
defined in: Form Metadata Schema
Privacy Notice Text Type
any of the following: array or boolean or number or object or string (Privacy Notice Text)
one (and only one) of
privacyNoticeUrl
The privacy notice url value.
privacyNoticeUrl
-
is optional
-
Type: any of the following:
arrayorbooleanornumberorobjectorstring(Privacy Notice Url) -
can be null
-
defined in: Form Metadata Schema
Privacy Notice Url Type
any of the following: array or boolean or number or object or string (Privacy Notice Url)
one (and only one) of
termsAndConditionsAgreed
Whether the data protection terms and conditions have been agreed to
termsAndConditionsAgreed
-
is optional
-
Type:
boolean(Terms And Conditions Agreed) -
cannot be null
-
defined in: Form Metadata Schema
Terms And Conditions Agreed Type
boolean (Terms And Conditions Agreed)
notificationEmail
Email address to receive form submission notifications
notificationEmail
-
is optional
-
Type:
string(Notification Email) -
cannot be null
-
defined in: Form Metadata Schema
Notification Email Type
string (Notification Email)
notificationEmail Constraints
email: the string must be an email address, according to RFC 5322, section 3.4.1
id
Unique identifier for the form, 24-character hexadecimal string
id
-
is required
-
Type:
string(Id) -
cannot be null
-
defined in: Form Metadata Schema
Id Type
string (Id)
slug
URL-friendly identifier used in form paths
slug
-
is required
-
Type:
string(Slug) -
cannot be null
-
defined in: Form Metadata Schema
Slug Type
string (Slug)
slug Constraints
pattern: the string must match the following regular expression:
^[a-z0-9-]+$draft
Metadata for the draft version
draft
-
is optional
-
Type:
object(Draft) -
cannot be null
-
defined in: Form Metadata Schema
Draft Type
object (Draft)
live
Metadata for the published version
live
-
is optional
-
Type:
object(Live) -
cannot be null
-
defined in: Form Metadata Schema
Live Type
object (Live)
createdAt
When the form was first created
createdAt
-
is required
-
Type:
string(Created At) -
cannot be null
-
defined in: Form Metadata Schema
Created At Type
string (Created At)
createdAt Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
createdBy
Who created the form
createdBy
-
is required
-
Type:
object(Created By) -
cannot be null
-
defined in: Form Metadata Schema
Created By Type
object (Created By)
updatedAt
When the form was last updated
updatedAt
-
is required
-
Type:
string(Updated At) -
cannot be null
-
defined in: Form Metadata Schema
Updated At Type
string (Updated At)
updatedAt Constraints
date time: the string must be a date time string, according to RFC 3339, section 5.6
updatedBy
Who last updated the form
updatedBy
-
is required
-
Type:
object(Updated By) -
cannot be null
-
defined in: Form Metadata Schema
Updated By Type
object (Updated By)
versions
Version history for the form
versions
-
is optional
-
Type:
object[](Versions Item) -
cannot be null
-
defined in: Form Metadata Schema
Versions Type
object[] (Versions Item)