Model: SettingsWorkflow

1 min

Model Parameters

SettingsWorkflow
- 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