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

Item 1 Type

object (Components (array) Item (object))

Item 1 Properties

Property	Type	Required	Nullable	Defined by
shortDescription	`string`	Optional	cannot be null	Form Definition V2 Schema
hint	`string`	Optional	cannot be null	Form Definition V2 Schema
options	`object`	Optional	cannot be null	Form Definition V2 Schema
schema	`object`	Optional	cannot be null	Form Definition V2 Schema
id	`string`	Optional	cannot be null	Form Definition V2 Schema
list	`string`	Optional	cannot be null	Form Definition V2 Schema
type	`string`	Required	cannot be null	Form Definition V2 Schema
name	Merged	Optional	can be null	Form Definition V2 Schema
title	Merged	Optional	can be null	Form Definition V2 Schema
Additional Properties	Any	Optional	can be null

shortDescription

Brief description of the component purpose

shortDescription

is optional
Type: string (Short Description)
cannot be null
defined in: Form Definition V2 Schema

Short Description Type

string (Short Description)

hint

Additional guidance text displayed below the component title

hint

is optional
Type: string (Hint)
cannot be null
defined in: Form Definition V2 Schema

Hint Type

string (Hint)

options

Component-specific configuration options

options

is optional
Type: object (Options)
cannot be null
defined in: Form Definition V2 Schema

Options Type

object (Options)

options Default Value

The default value is:

{}

schema

Validation rules for the component

schema

is optional
Type: object (Schema)
cannot be null
defined in: Form Definition V2 Schema

Schema Type

object (Schema)

schema Default Value

The default value is:

{}

id

Unique identifier for the component

id

is optional
Type: string (Id)
cannot be null
defined in: Form Definition V2 Schema

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

is optional
Type: string (List)
cannot be null
defined in: Form Definition V2 Schema

List Type

string (List)

list Constraints

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

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

type

Content only component type (Details, Html, Markdown, etc.)

type

is required
Type: string (Type)
cannot be null
defined in: Form Definition V2 Schema

Type

string (Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"Details"`
`"Html"`
`"Markdown"`
`"InsetText"`
`"List"`

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

is optional
Type: any of the following: array or boolean or number or object or string (Title)
can be null
defined in: Form Definition V2 Schema

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