Model: SettingsTemplate

1 min

Model Parameters

SettingsTemplate
- namestringrequired
  Example
  Template 1
  Description
  Name of the template
- descriptionstringrequired
  Example
  Template description
  Description
  Description of the template
- public_descriptionstringrequired
  Example
  Template public description
  Description
  Public description of the template
- form_fieldsFormField[]required
  Description
  List of the template form_fields
  - 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
- sectionsSection[]required
  Description
  List of the template sections
  - labelstringrequired
    Example
    Test section
    Description
    Name of the template section
  - idstringrequired
    Example
    9ec506f480dbc2d5f6919168ae448c41
    Description
    Id of the template section
- instructionsInstruction[]required
  Description
  List of the template instructions
  - descriptionstringrequired
    Example
    Test instruction description
    Description
    Description of the template instruction
  - idstringrequired
    Example
    9ec506f480dbc2d5f6919168ae448c40
    Description
    Id of the template instruction
- typesstring[]required
  Example
```
[
  "campaign_brief",
  "task_brief",
  "work_request"
]
```
  Description
  List of areas where you can use the template