taskLists

Archives or restores the specified task list.

Changed on

Archives or restores the specified task list. An archived task list remains available but cannot be edited. <Check title="Required Permissions" icon="key">The user must have project-planning-data:manage permission for the project.</Check>

post/projects/{projectId}/tasklists/{taskListId}/setarchived

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/projects/{projectId}/tasklists/{taskListId}/setarchived
  • Auth: HTTP bearer

Path parameters

projectIdstring uuid required

The id of the project.

taskListIdstring uuid required

The id of the task list.

Request body

isArchivedboolean

Flags the entity as archived.

taskOperationstring nullable

The operation for tasks which are not yet done. The operation is required if you set a list to archived. Can be: task-to-done: Set tasks to 'Done' or the first status of type 'done'. task-remove: Remove tasks from this task list. task-move: Move tasks to another list. task-delete: Deletes the non done tasks.

taskListIdstring uuid nullable

The id of the task list where all non done tasks should moved to. Only necessary if TaskOperation is set to 'task-move'.

deleteTimeTrackingsboolean nullable

Set to true to delete also the related time trackings of all non done tasks. Only necessary if TaskOperation is set to 'task-delete'.

Response

OK

idstring uuid

The id of the task list.

createdOnstring date-time

The date this task list was created.

createdBystring uuid

The id of the user who created this task list.

updatedOnstring date-time

The date this task list was last modified.

updatedBystring uuid

The id of the user who last modified this task list.

namestring nullable

The name of the list.

ordernumber double nullable

The order of the list.

plannedDurationinteger nullable

The planned duration for this task list, in seconds.

totalPlannedDurationinteger nullable

The total planned duration for this task list, including all primary tasks (parent tasks which have this tacklist as PrimaryTaskListId), in seconds. Calculated: sum PlannedDuration of primary tasks in list Archived task lists are not included in the calculation.

totalPlannedDurationWithHierarchyinteger nullable

The total planned duration for this task list, including all primary tasks (parent tasks which have this task list as PrimaryTaskListId), in seconds. Calculated: max(PlannedDuration, sum TotalPlannedDurationWithHierarchy of primary tasks in list) Archived task lists are not included in the calculation.

isArchivedboolean

Whether the task list has been archived.

isHiddenForConnectUsersboolean

True if the task in this list will be not visible for external workspace users. False otherwise.

trackedDurationinteger

The total duration of time trackings for tasks in this task list, in seconds. Includes both billable and non-billable time trackings. Backend-calculated property. When hierarchy feature flag is enabled: only tasks with PrimaryTaskListId == this list. When hierarchy feature flag is disabled: all tasks associated with this list.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostProjectTaskListSetArchivedByProjectIdAndTaskListId removed and replaced with taskLists_PostProjectTaskListSetArchivedByProjectIdAndTaskListId