Model: TaskResponse

1 min

Model Parameters

TaskResponse
- idstringrequired
  Example
  5d7f910551b00a722e0418830cee5534
  Description
  Unique identifier of the task
- titlestringrequired
  Example
  Awesome Task
  Description
  Title of the task
- start_atstring<date-time>required
  Example
  2019-10-06T13:15:30Z
  Description
  Start date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- due_atstring<date-time>required
  Example
  2020-10-06T13:15:30Z
  Description
  Due date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- is_completedbooleanrequired
  Description
  Determines whether the task is completed
- is_archivedbooleanrequired
  Description
  Determines whether the task is archived
- statusstring<Archived | Completed | Overdue | Not Started | In Progress | On Hold>required
  Example
  Not Started
  Description
  Current status of the task
  Allowed
  ArchivedCompletedOverdueNot StartedIn ProgressOn Hold
- reference_idstringrequired
  Example
  TSK-123
  Description
  Reference ID of the task
- workflow_idstring
  Example
  8q7f910551b00a722e0418830cee6612
  Description
  Unique identifier of workflow
- campaign_idstringrequired
  Example
  8n7f910o51b00b722o0418n30cie8211
  Description
  Unique identifier of the campaign
- milestone_idstringrequired
  Example
  8n7f910o51b00b722o0418n30cie8211
  Description
  Unique identifier of the milestone
- modified_atstringrequired
  Example
  2024-06-01T06:00:00Z
  Description
  Modified date of the task in ISO 8601 UTC format
- labelsResourceLabelResponse[]required
  Description
  Labels associated with the task
  - groupobjectrequired
    Description
    Label group
    - idstringrequired
      Example
      2467e583a60e23fda2b89db81a453cd2
      Description
      Identifier of the label group
    - namestringrequired
      Example
      Content Format
      Description
      Name of the label group
  - valuesobject[]required
    Description
    List of values of the label
    - idstringrequired
      Example
      71c378f3fee3d822759d1bdc2aab628c
      Description
      Identifier of the label value
    - namestringrequired
      Example
      Photos
      Description
      Name of the label value
- stepsTaskStep[]required
  Description
  Steps of the task
  - idstringrequired
    Example
    6d7f910551b00a722e0418830cee5564
    Description
    Unique identifier of the step
  - titlestringrequired
    Example
    Sample step
    Description
    Title of the step
  - is_completedbooleanrequired
    Description
    Determines whether the step is completed in Optimizely CMP
  - descriptionstringrequired
    Example
    Description of the step
    Description
    Description of the step
  - due_atstring<date-time>required
    Example
    2020-10-06T13:15:30Z
    Description
    Due date and time of the step containing the substep, in ISO 8601 UTC format (2020-02-10T10:40
    )
    Format
    date-time
  - sub_stepsTaskSubStep[]required
    Description
    Substeps of the step
    - idstringrequired
      Example
      9c7f910551b00a722e0418830cee2564
      Description
      Unique identifier of the substep
    - titlestringrequired
      Example
      Sample step
      Description
      Title of the substep
    - assignee_idstringrequired
      Example
      5fdf31d57f0d0e362e2b5908
      Description
      ID of the assignee of the step containing the substep
    - assignee_typestring<user | team>required
      Example
      user
      Description
      Type of the assignee of the step containing the substep.
      Allowed
      userteam
    - is_completedbooleanrequired
      Description
      Determines whether the substep is completed in Optimizely CMP
    - is_in_progressbooleanrequired
      Description
      Determines whether the substep is In Progress in Optimizely CMP
    - is_skippedbooleanrequired
      Description
      Determines whether the substep is skipped in Optimizely CMP
    - is_externalbooleanrequired
      Example
      true
      Description
      Determines whether the substep is external in Optimizely CMP
    - linksobjectrequired
      Description
      Meta links
      - selfstringrequired
        Example
        https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564
        Description
        URL of the substep
      - taskstringrequired
        Example
        https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
        Description
        URL of the task
      - external_workstringrequired
        Example
        https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564/external-work
        Description
        URL of the external work associated with substep if substep is external in Optimizely CMP
      - assigneestring
        Example
        https://api.cmp.optimizely.com/v3/users/5fdf31d57f0d0e362e2b5908
        Description
        Assignee of the step containing the substep
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
    Description
    URL of the task
  - assetsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/assets
    Description
    URL for getting the list of the task assets or adding a new asset to the task
  - attachmentsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/attachments
    Description
    URL for getting the list of the task attachments
  - briefstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/brief
    Description
    URL of the task brief
  - campaignstringrequired
    Example
    https://api.cmp.optimizely.com/v3/campaigns/2e7f9107351b00a722e0412230cee5534
    Description
    URL of the campaign that the task is associated with
  - custom_fieldsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/custom-fields
    Description
    URL of the list of custom fields added to the task
  - milestonestringrequired
    Example
    https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741
    Description
    URL of the milestone that the task is associated with
  - web_urlsobjectrequired
    Description
    Web URLs
    - selfstringrequired
      Example
      https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f
      Description
      Web URL of the task
    - briefstringrequired
      Example
      https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f?activeTab=brief
      Description
      Web URL of the task brief