Reorder
This story shows how tasks can be reordered and moved between lists. To demonstrate how this API feautre works, we have one project with two lists:
Response: HTTP 200, application/json (Hide)
GET /projects/1/task-lists
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
[
{
"id": 1,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/1",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164348,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 1,
"open_tasks": 3,
"completed_tasks": 0
},
{
"id": 2,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/2",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164348,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 2,
"open_tasks": 1,
"completed_tasks": 0
}
]and four tasks, three in the first list and one in the second list:
Response: HTTP 200, application/json (Hide)
GET /projects/1/tasks
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
{
"tasks": [
{
"id": 1,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/1",
"name": "Task #1",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164349,
"updated_by_id": 1,
"task_number": 1,
"task_list_id": 1,
"position": 1,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
{
"id": 2,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/2",
"name": "Task #2",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164349,
"updated_by_id": 1,
"task_number": 2,
"task_list_id": 1,
"position": 4,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
{
"id": 3,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/3",
"name": "Task #3",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164349,
"updated_by_id": 1,
"task_number": 3,
"task_list_id": 1,
"position": 5,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
{
"id": 4,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/4",
"name": "Task #4",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164349,
"updated_by_id": 1,
"task_number": 4,
"task_list_id": 2,
"position": 6,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
}
],
"task_lists": [
{
"id": 1,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/1",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164348,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 1,
"open_tasks": 3,
"completed_tasks": 0
},
{
"id": 2,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/2",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164348,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 2,
"open_tasks": 1,
"completed_tasks": 0
}
],
"label_ids": [],
"project": {
"id": 1,
"class": "Project",
"url_path": "\/projects\/1",
"name": "Test Project",
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"members": [
1
],
"category_id": 0,
"label_id": 0,
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164349,
"updated_by_id": 1,
"body": null,
"body_formatted": "",
"company_id": 1,
"leader_id": 0,
"currency_id": 2,
"template_id": 0,
"based_on_type": null,
"based_on_id": null,
"email": "notifications+m2p-EAHnPCo@mail.manageprojects.com",
"is_tracking_enabled": true,
"is_client_reporting_enabled": false,
"budget": null,
"count_tasks": 4,
"count_discussions": 0,
"count_files": 0,
"count_notes": 0
},
"completed_tasks_count": 0
}Lets reorder tasks in the first list:
Response: HTTP 200, application/json (Hide)
PUT /projects/1/tasks/reorder
Payload:
1 2 3 4 5 6 7 8
{
"task_ids": [
3,
2,
1
],
"task_list_id": 1
}Response:
1 2 3 4 5
[
3,
2,
1
]Response: HTTP 200, application/json (Hide)
GET /projects/1/tasks/1
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
{
"single": {
"id": 1,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/1",
"name": "Task #1",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164350,
"updated_by_id": 1,
"task_number": 1,
"task_list_id": 1,
"position": 3,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
"subscribers": [
1
],
"comments": [],
"reminders": [],
"subtasks": [],
"task_list": {
"id": 1,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/1",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164350,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 1,
"open_tasks": 3,
"completed_tasks": 0
},
"tracked_time": 0,
"tracked_expenses": 0
}Response: HTTP 200, application/json (Hide)
GET /projects/1/tasks/2
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
{
"single": {
"id": 2,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/2",
"name": "Task #2",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164350,
"updated_by_id": 1,
"task_number": 2,
"task_list_id": 1,
"position": 2,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
"subscribers": [
1
],
"comments": [],
"reminders": [],
"subtasks": [],
"task_list": {
"id": 1,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/1",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164350,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 1,
"open_tasks": 3,
"completed_tasks": 0
},
"tracked_time": 0,
"tracked_expenses": 0
}Response: HTTP 200, application/json (Hide)
GET /projects/1/tasks/3
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
{
"single": {
"id": 3,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/3",
"name": "Task #3",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164350,
"updated_by_id": 1,
"task_number": 3,
"task_list_id": 1,
"position": 1,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
"subscribers": [
1
],
"comments": [],
"reminders": [],
"subtasks": [],
"task_list": {
"id": 1,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/1",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164350,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 1,
"open_tasks": 3,
"completed_tasks": 0
},
"tracked_time": 0,
"tracked_expenses": 0
}Now lets reorder and move tasks in one go:
Response: HTTP 200, application/json (Hide)
PUT /projects/1/tasks/reorder
Payload:
1 2 3 4 5 6 7 8
{
"task_ids": [
4,
2,
1
],
"task_list_id": 2
}Response:
1 2 3 4 5
[
4,
2,
1
]Response: HTTP 200, application/json (Hide)
GET /projects/1/tasks/1
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
{
"single": {
"id": 1,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/1",
"name": "Task #1",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164351,
"updated_by_id": 1,
"task_number": 1,
"task_list_id": 2,
"position": 3,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
"subscribers": [
1
],
"comments": [],
"reminders": [],
"subtasks": [],
"task_list": {
"id": 2,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/2",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164351,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 2,
"open_tasks": 3,
"completed_tasks": 0
},
"tracked_time": 0,
"tracked_expenses": 0
}Response: HTTP 200, application/json (Hide)
GET /projects/1/tasks/2
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
{
"single": {
"id": 2,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/2",
"name": "Task #2",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164351,
"updated_by_id": 1,
"task_number": 2,
"task_list_id": 2,
"position": 2,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
"subscribers": [
1
],
"comments": [],
"reminders": [],
"subtasks": [],
"task_list": {
"id": 2,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/2",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164351,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 2,
"open_tasks": 3,
"completed_tasks": 0
},
"tracked_time": 0,
"tracked_expenses": 0
}Response: HTTP 200, application/json (Hide)
GET /projects/1/tasks/4
Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
{
"single": {
"id": 4,
"class": "Task",
"url_path": "\/projects\/1\/tasks\/4",
"name": "Task #4",
"assignee_id": 0,
"delegated_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"comments_count": 0,
"attachments": [],
"labels": [],
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"project_id": 1,
"is_hidden_from_clients": false,
"body": "",
"body_formatted": "",
"created_on": 1430164349,
"created_by_id": 1,
"updated_on": 1430164351,
"updated_by_id": 1,
"task_number": 4,
"task_list_id": 2,
"position": 1,
"is_important": false,
"due_on": null,
"estimate": 0,
"job_type_id": 0,
"total_subtasks": 0,
"completed_subtasks": 0,
"open_subtasks": 0
},
"subscribers": [
1
],
"comments": [],
"reminders": [],
"subtasks": [],
"task_list": {
"id": 2,
"class": "TaskList",
"url_path": "\/projects\/1\/task-lists\/2",
"name": "Task List #1",
"is_trashed": false,
"trashed_on": null,
"trashed_by_id": 0,
"completed_on": null,
"completed_by_id": null,
"is_completed": false,
"project_id": 1,
"created_on": 1430164348,
"created_by_id": 1,
"updated_on": 1430164351,
"updated_by_id": 1,
"start_on": null,
"due_on": null,
"position": 2,
"open_tasks": 3,
"completed_tasks": 0
},
"tracked_time": 0,
"tracked_expenses": 0
}