Checkbox

Field options

Name	Type	Description

Name	Type	Description
name	string	The name by which the field will internally be referenced
displayText	string	The main field label displayed above the field
description	string	An additional description displayed below the main label
defaultValue	string	The value the field should initially be filled with
items	array	An array of objects of the possible answers
items[].displayText	string	The label of the option
items[].value	string	The value by which the option will be internally referenced
items[].description	string	An additional field for more information about the item
options	object	Additional field options (see below)
options.required	boolean	Whether the field must be filled to advance
options.readOnly	boolean	Whether it’s allowed to change the field value
options.confirmation	boolean	Whether to include this field in the confirmation page

JSON Example

{
  "name": "TestCheckbox",
  "displayText": "Checkbox",
  "description": "A checkbox with multiple options",
  "type": "Checkbox",
  "defaultValue": "S11000",
  "items": [
    {
      "displayText": "Option 1",
      "value": "S11000"
    },
    {
      "displayText": "Option 2",
      "value": "S11001"
    },
    {
      "displayText": "Another option",
      "value": "S11002"
    }
  ],
  "options": {
    "required": true
  }
}