Skip to main content

betaThis is a new capability. Help us improve it and give your feedback on Slack.

form-definition-v2-schema-properties-pages-pages-item-properties-components-anyof-components-array-components-array-item-anyof-components-array--item-object

Item 0 Type

object (Components (array) Item (object))

Item 0 Properties

PropertyTypeRequiredNullableDefined by
shortDescriptionstringOptionalcannot be nullForm Definition V2 Schema
hintstringOptionalcannot be nullForm Definition V2 Schema
optionsobjectOptionalcannot be nullForm Definition V2 Schema
schemaobjectOptionalcannot be nullForm Definition V2 Schema
idstringOptionalcannot be nullForm Definition V2 Schema
liststringOptionalcannot be nullForm Definition V2 Schema
typeNot specifiedRequiredcannot be nullForm Definition V2 Schema
nameMergedOptionalcan be nullForm Definition V2 Schema
titleMergedOptionalcan be nullForm Definition V2 Schema
Additional PropertiesAnyOptionalcan be null

shortDescription

Brief description of the component purpose

shortDescription

Short Description Type

string (Short Description)

hint

Additional guidance text displayed below the component title

hint

Hint Type

string (Hint)

options

Component-specific configuration options

options

Options Type

object (Options)

options Default Value

The default value is:

{}

schema

Validation rules for the component

schema

Schema Type

object (Schema)

schema Default Value

The default value is:

{}

id

Unique identifier for the component

id

Id Type

string (Id)

id Constraints

UUID: the string must be a UUID, according to RFC 4122

list

List id reference to a predefined list of options for select components

list

List Type

string (List)

list Constraints

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

{
"ref": {
"path": [
"lists"
],
"ancestor": "root",
"in": true
}
}

type

Component that can only be a FileUploadField

type

Type

unknown (Type)

type Constraints

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

"FileUploadField"

name

The name value.

name

  • is optional

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

  • can be null

  • defined in: Form Definition V2 Schema

Name Type

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

one (and only one) of

title

The title value.

title

Title Type

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

one (and only one) of

Additional Properties

Additional properties are allowed and do not have to follow a specific schema