Model: WorkflowResponse

1 min

Model Parameters

WorkflowResponse
- idstringrequired
  Example
  6e7f910551b00a722e04188
  Description
  Unique identifier of the workflow
- namestringrequired
  Example
  The awesome workflow
  Description
  Name of the workflow
- descriptionstringrequired
  Example
  Nice description
  Description
  Description of the workflow
- is_activebooleanrequired
  Example
  true
  Description
  Indicates whether the workflow is active
- is_flexiblebooleanrequired
  Example
  true
  Description
  Indicates whether the workflow is flexible
- is_smart_duration_enabledbooleanrequired
  Example
  true
  Description
  Indicates whether the smart duration of a workflow is enabled
- is_asset_approval_enabledbooleanrequired
  Example
  true
  Description
  Indicates whether the asset approval of a workflow is enabled
- is_resource_management_enabledbooleanrequired
  Example
  true
  Description
  Indicates whether the resource management of a workflow is enabled
- stepsobject[]required
  Description
  List of steps
  - idstringrequired
    Example
    6e7f910551b00a722e04181
    Description
    Identifier of the step
  - namestringrequired
    Example
    Step 1
    Description
    Name of the step
  - sub_stepsobject[]required
    Description
    List of sub-steps
    - idstringrequired
      Example
      6e7f910551b00a722e04182
      Description
      Identifier of the sub-step
    - namestringrequired
      Example
      Step 1 Substep 1
      Description
      Name of the sub-step
    - actionsobject[]required
      Example
      [ { "name": "Approve" }, { "name": "Find Content" }, { "name": "Write/Edit Content" }, { "name": "Publish" }, { "name": "Set Publish Destination" }, { "name": "Edit Fields" }, { "name": "Set Publish Date" }, { "name": "Write/Edit Share" }, { "name": "Select Image" } ]
      Description
      List of actions of a sub-step
      - namestringrequired
        Example
        Approve
        Description
        Name of the action
    - typestring<default | external>required
      Example
      default
      Description
      Type of the sub-step
      Allowed
      defaultexternal
    - assigneesobject[]required
      Description
      List of assignees of a sub-step
      - idstringrequired
        Example
        6e7f910551b00a722e04182
        Description
        Identifier of the sub-step assignee
      - namestringrequired
        Example
        Ned Stark
        Description
        Name of the assignee
      - typestring<user | team>required
        Example
        user
        Description
        Type of the assignee
        Allowed
        userteam
      - linksobjectrequired
        Description
        Meta links
        selfstringrequired
        Example
        https://api.cmp.optimizely.com/v3/users/6e7f910551b00a722e04182
        Description
        URL of the assignee
- fieldsObjectFieldCreateResponse[]required
  Description
  List of fields
  - FieldTypeCommon
    - idstringrequired
      Example
      64be245ec0d79e79fdf1ad84
      Description
      Identifier of the field
    - namestringrequired
      Example
      Dropdown 101
      Description
      Name of the field
    - valuesundefined[]required
      Description
      List of selected values or from user input
    - typestringrequired
      Example
      text
      Description
      Type of the field
  - FieldTypeLabel
    - idstringrequired
      Example
      64be245ec0d79e79fdf1ad84
      Description
      Identifier of the field
    - namestringrequired
      Example
      Dropdown 101
      Description
      Name of the field
    - valuesundefined[]required
      Description
      List of selected values or from user input
    - typestringrequired
      Example
      text
      Description
      Type of the field
    - is_multi_selectbooleanrequired
      Description
      Select multiple values from the label
    - choicesundefined[]required
      Description
      Choices of the label
  - FieldTypeDropdown
    - idstringrequired
      Example
      64be245ec0d79e79fdf1ad84
      Description
      Identifier of the field
    - namestringrequired
      Example
      Dropdown 101
      Description
      Name of the field
    - valuesundefined[]required
      Description
      List of selected values or from user input
    - typestringrequired
      Example
      text
      Description
      Type of the field
    - is_multi_selectbooleanrequired
      Description
      Select multiple values from the dropdown
    - choicesundefined[]required
      Description
      Choices of the dropdown
  - FieldTypeRadio
    - idstringrequired
      Example
      64be245ec0d79e79fdf1ad84
      Description
      Identifier of the field
    - namestringrequired
      Example
      Dropdown 101
      Description
      Name of the field
    - valuesundefined[]required
      Description
      List of selected values or from user input
    - typestringrequired
      Example
      text
      Description
      Type of the field
    - choicesundefined[]required
      Description
      Choices of the radio button
  - FieldTypeCheckbox
    - Max depth limit reached
  - FieldTypeSimpleNumber
    - Max depth limit reached
  - FieldTypePercentageNumber
    - Max depth limit reached
  - FieldTypeCurrencyNumber
    - Max depth limit reached