Model: FormField

1 min

Model Parameters

FormField
- field_typestringrequired
  Example
  custom_field
  Description
  Type of template form field
- helpstringrequired
  Example
  This is a helper text
  Description
  Helper text for form field
- is_requiredbooleanrequired
  Description
  Indicates whether the form field is required
- logic_rulesLogicRule[]required
  Description
  List of the template logic rules
  - actionLogicRuleActionrequired
    Description
    Template logic rule action
    - target_fieldLogicRuleTargetFieldrequired
      Description
      Template logic rule action's target field
      - identifierstringrequired
        Example
        end_of_form
        Description
        Name of the target field identifier
      - custom_field_typestringrequired
        Description
        Type of custom field if the target field is a custom field
      - typestringrequired
        Example
        end_of_form
        Description
        Type of the target field identifier
    - typestringrequired
      Example
      jump_to
      Description
      Type of logic rule action
    - valuesstring[]required
      Example
      [ "a choice" ]
      Description
      Values to consider on logic rule action
  - conditionLogicRuleConditionrequired
    Description
    Logic rule action associated condition
    - operatorstringrequired
      Example
      equal
      Description
      The operator for logic rule action
    - valuesstring[]required
      Example
      [ "choice1" ]
      Description
      List of labels or custom field choices
- sort_orderintegerrequired
  Description
  Sort order of the form field
- identifierstringrequired
  Example
  SingleChoice1
  Description
  Identifier of the form field
- custom_field_typestringrequired
  Example
  multichoice
  Description
  Type of the custom field when the form field is a custom field