Model: SettingsResources

1 min

Model Parameters

SettingsResources
- labelsSettingsLabelGroup[]required
  Description
  Settings labels
  - has_single_valuebooleanrequired
    Example
    true
    Description
    Single or multiple value support indicator for the label group
  - label_typestringrequired
    Example
    Content Pillar
    Description
    Name of the label group
  - labelsSettingsLabelGroupLabel[]required
    Description
    List of labels of the label group
    - namestringrequired
      Example
      Pillar1
      Description
      Name of the label
    - colorstringrequired
      Example
      #4ECFD5
      Description
      Color of the label
- custom_fieldsSettingsCustomFieldrequired
  Description
  Settings for custom fields
  - currencyCurrencyCustomField[]required
    Description
    List of currency custom fields
    - labelstringrequired
      Example
      A Currency Custom Field
      Description
      Name of the custom field
    - decimal_placesintegerrequired
      Example
      1
      Description
      Value of decimal places
    - currency_codestringrequired
      Example
      USD
      Description
      Curency code of custom field
      Default
      USD
    - has_thousand_separatorbooleanrequired
      Description
      Indicator of thousand separator
      Default
      false
  - numberNumberCustomField[]required
    Description
    List of number custom fields
    - labelstringrequired
      Example
      A Number Custom Field
      Description
      Name of the custom field
    - decimal_placesintegerrequired
      Example
      1
      Description
      Value of decimal places
    - has_thousand_separatorbooleanrequired
      Description
      Indicator of thousand separator
      Default
      false
  - percentagePercentageCustomField[]required
    Description
    List of percentage custom fields
    - labelstringrequired
      Example
      A Percentage Custom Field
      Description
      Name of the custom field
    - decimal_placesintegerrequired
      Example
      1
      Description
      Value of decimal places
  - checkboxMultipleOptionCustomField[]required
    Description
    List of checkbox custom fields
    - labelstringrequired
      Example
      A custom field with choice
      Description
      Name of the custom field
    - choicesstring[]required
      Example
      [ "choice1", "choice2" ]
      Description
      Custom field choices
  - dropdownMultipleOptionCustomField[]required
    Description
    List of dropdown custom fields
    - labelstringrequired
      Example
      A custom field with choice
      Description
      Name of the custom field
    - choicesstring[]required
      Example
      [ "choice1", "choice2" ]
      Description
      Custom field choices
  - multichoiceMultipleOptionCustomField[]required
    Description
    List of multichoice custom fields
    - labelstringrequired
      Example
      A custom field with choice
      Description
      Name of the custom field
    - choicesstring[]required
      Example
      [ "choice1", "choice2" ]
      Description
      Custom field choices
  - multi_select_dropdownMultipleOptionCustomField[]required
    Description
    List of multi-select dropdown custom fields
    - labelstringrequired
      Example
      A custom field with choice
      Description
      Name of the custom field
    - choicesstring[]required
      Example
      [ "choice1", "choice2" ]
      Description
      Custom field choices
  - dateLabelOnlyCustomField[]required
    Description
    List of date custom fields
    - labelstringrequired
      Example
      A Custom Field
      Description
      Name of the custom field
  - imageLabelOnlyCustomField[]required
    Description
    List of image custom fields
    - labelstringrequired
      Example
      A Custom Field
      Description
      Name of the custom field
  - richtextLabelOnlyCustomField[]required
    Description
    List of rich text custom fields
    - labelstringrequired
      Example
      A Custom Field
      Description
      Name of the custom field
  - stringLabelOnlyCustomField[]required
    Description
    List of string custom fields
    - labelstringrequired
      Example
      A Custom Field
      Description
      Name of the custom field
  - textareaLabelOnlyCustomField[]required
    Description
    List of textarea custom fields
    - labelstringrequired
      Example
      A Custom Field
      Description
      Name of the custom field
  - videoLabelOnlyCustomField[]required
    Description
    List of video custom fields
    - labelstringrequired
      Example
      A Custom Field
      Description
      Name of the custom field
- workflowsSettingsWorkflow[]required
  Description
  Settings workflows
  - is_flexible_workflowbooleanrequired
    Description
    Indicates whether the workflow is flexible
  - is_not_pushed_to_library_by_defaultbooleanrequired
    Description
    Indicates whether the contents of the task created from this workflow are not pushed to the library by default
  - is_released_as_assetbooleanrequired
    Description
    Indicates whether the contents of the task created from this workflow are released as an asset
  - namestringrequired
    Example
    A Workflow
    Description
    Name of the workflow
  - labelsWorkflowLabel[]required
    Description
    List of the associated labels
    - default_valuestring[]required
      Example
      [ "label1", "label2" ]
      Description
      List of label names
    - is_requiredbooleanrequired
      Example
      true
      Description
      Indicates whether a label is required
    - label_typestringrequired
      Example
      Content Pillar
      Description
      Name of the Label Group
    - is_required_at_task_creationbooleanrequired
      Description
      Indicates whether a label is required at task creation
  - custom_fieldsWorkflowCustomfield[]required
    Description
    List of the associated custom field
    - is_requiredbooleanrequired
      Description
      Indicates whether a custom field is required
    - fieldstringrequired
      Example
      exampleCustomField
      Description
      Name of the custom field
    - default_valuestring[]required
      Example
      [ "choice1", "choice2" ]
      Description
      List of the custom field choices
      Default
    - typestringrequired
      Example
      equal
      Description
      Type of custom field
  - default_channelsWorkflowChannel[]required
    Description
    List of the associated channels
    - display_namestringrequired
      Example
      exampleChannel
      Description
      Name of the channel
    - typestringrequired
      Example
      twitter
      Description
      Type of channel
  - blacklisted_channelsWorkflowChannel[]required
    Description
    List of the disallowed channels
    - display_namestringrequired
      Example
      exampleChannel
      Description
      Name of the channel
    - typestringrequired
      Example
      twitter
      Description
      Type of channel
  - stepsWorkflowStep[]required
    Description
    List of the workflow steps
    - labelstringrequired
      Example
      Step 1
      Description
      Name of the workflow step
    - substepsWorkflowSubStep[]required
      Description
      List of the substeps
      - actionsstring[]required
        Example
        [ "findContent", "writeEditSocialPost" ]
        Description
        List of actions
      - labelstringrequired
        Example
        Substep 1
        Description
        Name of the substep
      - external_sub_step_configobject
        Description
        External substep configuration
        is_user_interaction_allowedboolean
        Description
        Indicates whether the user interaction is allowed
        Default
        false
      - is_externalbooleanrequired
        Description
        Indicates whether a substep is external
        Default
        false
      - external_systemstringrequired
        Description
        Name of the external system if the substep is external
      - descriptionstringrequired
        Example
        This is a substep description
        Description
        Description of the substep
    - descriptionstringrequired
      Example
      This is a dummy example
      Description
      Description of the workflow step
    - durationintegerrequired
      Example
      1
      Description
      Duration of the workflow step
  - descriptionstringrequired
    Example
    Sample description
    Description
    Description of the workflow
- templatesSettingsTemplate[]required
  Description
  Settings templates
  - 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
- appsSettingsApp[]required
  Description
  Settings apps
  - namestringrequired
    Example
    App 1
    Description
    Name of the app
  - descriptionstringrequired
    Example
    Sample description
    Description
    Description of the app
  - homepage_urlstringrequired
    Example
    https://example1.com
    Description
    Home page URL for app
  - authorization_callback_urlsstring[]required
    Example
    [ "https://example1.com", "https://example2.com" ]
    Description
    List of the authorization callback URLs
  - expose_emailbooleanrequired
    Example
    true
    Description
    Indicates whether an email should be exposed in an API response
  - envstringrequired
    Example
    production
    Description
    Environment of the app
- webhooksSettingsWebhook[]required
  Description
  Settings webhooks
  - namestringrequired
    Example
    Webhook 1
    Description
    Name of the webhook
  - descriptionstringrequired
    Example
    Sample description
    Description
    Description of the webhook
  - callback_urlstringrequired
    Example
    https://exampledomain.com
    Description
    Callback URL of the webhook
  - secretstringrequired
    Example
    secret121
    Description
    Webhook callback URL secret
  - event_namesstring[]required
    Example
    [ "asset_added", "asset_removed" ]
    Description
    List of the subscribed event names for the webhook
- routing_rulesSettingsRoutingRule[]required
  Description
  Settings routing rules
  - namestringrequired
    Example
    example Routing Rule
    Description
    Name of the routing rule
  - rulesobject[]required
    Description
    List of the associated rules
    - field_typestringrequired
      Example
      customField
      Description
      Name of the rule field type
    - identifierstringrequired
      Example
      exampleCustomField1
      Description
      Name of the rule identifier
    - operatorstringrequired
      Example
      equal
      Description
      Name of the rule operator
    - valuestring[]required
      Example
      [ "value1", "value2" ]
      Description
      List of the associated label, custom field, or due date choice
    - unitstring<days | weeks | months | years | >required
      Example
      days
      Description
      Unit of rule's field. Not null when the rule's field_type value is dueDate
      Allowed
      daysweeksmonthsyearsnull
    - custom_field_typestringrequired
      Example
      multichoice
      Description
      Associated custom field type
  - watchersstring[]required
    Example
    [ "[email protected]" ]
    Description
    List of the routing rule watchers email
  - descriptionstringrequired
    Example
    Sample routing rule description
    Description
    Description of the routing rule
  - template_namestringrequired
    Example
    Sample template name
    Description
    Name of the associated template