Archives or unarchives the task list with the specified id. | awork API

Archives or unarchives the task list with the specified id. An archived task list still exists but is not editable anymore.

Required Permissions

Any authenticated user.

Archives or unarchives the task list with the specified id. An archived task list still exists but is not editable anymore. <Check title="Required Permissions">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"

The id of the project the task list is related to.

taskListIdstringRequiredformat: "uuid"

Id of the task list which will be archived.

Request

The model to archive the task list.

isArchivedbooleanRequired

Flags the entity as archived.

taskOperationstring or nullOptional

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 or nullOptionalformat: "uuid"

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

deleteTimeTrackingsboolean or nullOptional

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

idstring or nullformat: "uuid"

The id of the task list.

createdOnstring or nullformat: "date-time"

The date this task list was created.

createdBystring or nullformat: "uuid"

The id of the user who created this task list.

updatedOnstring or nullformat: "date-time"

The date this task list was last modified.

updatedBystring or nullformat: "uuid"

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

namestring or null

The name of the list.

orderdouble or null

The order of the list.

isArchivedboolean or null

Whether the task list has been archived.

isHiddenForConnectUsersboolean or null

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

1	import requests
2
3	url = "https://api.awork.com/api/v1/projects/projectId/tasklists/taskListId/setarchived"
4
5	payload = { "isArchived": True }
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": "123e4567-e89b-12d3-a456-426614174000",
3	"createdOn": "2021-03-22T15:00:00Z",
4	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
5	"updatedOn": "2021-03-22T16:30:00Z",
6	"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
7	"name": "Product and Marketing To-Dos",
8	"order": 2,
9	"isArchived": false,
10	"isHiddenForConnectUsers": true
11	}