formMultipleChoiceInput

Defines the desired user interface as a checkbox group where multiple choices can be selected. Applies to string fields only.

Referenced by: formFieldElement

Properties

Property	Details
choiceDelimiter	Delimiter used to join multiple selected choice values. If not provided, a comma (,) will be used as the default delimiter. Choice values cannot contain the choiceDelimiter character.
choices[]	Available choices that are presented in the checkbox group. Choice order should be defined by the order of items in the choices array. Array of items of the following types: formChoice
includeSelectAllChoices	Include option to select/unselect all choices. If not defined, only defined choices and "other" choice items will be displayed.
maximumChoices	Maximum number of choices that may be selected. If not provided, there is no maximum. If "other" choice is selected, it is not considered when determining the maximum number of choices.
minimumChoices	Minimum number of choices that must be selected. If this property is not set and the associated field is non-nullable, then at least one choice must be selected. If the property is not set and the field is nullable, selecting no choices is acceptable. If "other" choice is selected, it is not considered when determining the minimum number of choices.
otherChoice	An object that defines the "Other" choice.
type	The input type identifier. Valid value of this property multiple-choice

Example

{
  "choices": [
    {
      "label": "Paint needed",
      "value": "0"
    },
    {
      "label": "Grease needed",
      "value": "1"
    }
  ],
  "type": "multiple-choice"
}

Example

{
  "choices": [
    {
      "label": "Paint needed",
      "value": "paint-needed"
    },
    {
      "label": "Grease needed",
      "value": "grease-needed"
    }
  ],
  "type": "multiple-choice",
  "includeSelectAllChoices": true
}

Example

{
  "choiceDelimiter": ",",
  "choices": [
    {
      "label": "Paint needed",
      "value": "paint-needed"
    },
    {
      "label": "Grease needed",
      "value": "grease-needed"
    }
  ],
  "type": "multiple-choice",
  "includeSelectAllChoices": true,
  "minimumChoices": 1,
  "maximumChoices": 3,
  "otherChoice": {
    "fieldName": "other-maintenance",
    "hint": "Specify other maintenance needed",
    "label": "Other maintenance needed"
  }
}