Fields for searching:
( Allowed sorting directions for GET request are set in OrderDirectionEnum, allowed 'up' and 'dw')
- status
- GET query
&status=todo
- SQL query
status = 'todo'
- GET query
- priority
- GET query
&priority=2
- SQL query
priority >= 2
- GET query
- title
- GET query
&title=Title_of_task
- SQL query
(full text searching) MATCH (title) AGAINST ('Title_of_task')
- GET query
Fields for ordering:
- priority
- GET query
&prioritySort=up
- SQL query
order by priority asc
- GET query
- created_at
- GET query
&createdSort=dw
- SQL query
order by cteated_at desc
- GET query
- completed_at
- GET query
&completedSort=dw
- SQL query
order by comlpeted_at desc
- GET query
Example GET query:
GET http://my_tasks_manager.com:80/tasks/?status=todo&priority=2&createdSort=up&prioritySort=dw
Show request
{
"status": 200,
"message": "All tasks",
"data": [
{
"id": 375,
"parent_id": 21,
"user_id": 857,
"status": "todo",
"priority": 2,
"title": "Test Task",
"description": "Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit...",
"created_at": "2123-07-31T21:32:38.000000Z",
"updated_at": "2123-08-12T08:45:59.000000Z",
"completed_at": null
},
{
"id": 1431,
"parent_id": 17,
"user_id": 857,
"status": "todo",
"priority": 2,
"title": "New Task",
"description": "Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus.",
"created_at": "2123-08-13T19:38:39.000000Z",
"updated_at": "2123-09-15T20:06:17.000000Z",
"completed_at": null
}
]
}
Example GET query show task id=869:
GET http://my_tasks_manager.com:80/api/tasks/show/869
Show request
{
"status": 200,
"message": "Task ID 869.",
"data": {
"id": 869,
"parent_id": 37,
"user_id": 418,
"status": "done",
"priority": 3,
"title": "Old Task",
"description": " Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna.",
"created_at": "2123-08-11T11:38:39.000000Z",
"updated_at": "2123-08-12T20:06:17.000000Z",
"completed_at": "2123-08-12T20:06:17.000000Z"
}
}
Example PUT query sets status to 'done' task id=869:
PUT http://my_tasks_manager.com:80/api/tasks/complete/869
Show request (all children have status 'todo')
{
"status": 200,
"message": "Task ID 869 was marked 'done' successfully",
"data": true
}
Show request (children have status 'done')
{
"status": 200,
"message": "One or more children of Task ID 1 have status 'done'.",
"data": false
}
Example DELETE Query, delete task id=883:
DELETE http://my_tasks_manager.com:80/api/tasks/delete/883
Show request (Task status is 'todo')
{
"status": 200,
"message": "Task ID 883 was deleted successfully.",
"data": true
}
Show request (Task status is 'done')
{
"status": 200,
"message": "Task ID 883 status: 'done'. Please select another task.",
"data": {
"id": 883,
"parent_id": 37,
"user_id": 418,
"status": "done",
"priority": 3,
"title": "Old Task",
"description": " Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna.",
"created_at": "2123-08-13T11:38:39.000000Z",
"updated_at": "2123-08-15T20:06:17.000000Z",
"completed_at": "2123-08-15T20:06:17.000000Z"
}
}
Example Update query:
PUT http://my_tasks_manager.com:80/api/tasks/update/?id=391&description=Start_new_project
Show request
{
"status": 200,
"message": "Task was updated successfully.",
"data": {
"id": 391,
"parent_id": 47,
"user_id": 179,
"status": "done",
"priority": 1,
"title": "New_project",
"description": "Start_new_project",
"created_at": "2123-08-12T18:45:09.000000Z",
"updated_at": "2123-08-15T19:21:26.000000Z",
"completed_at": "2123-08-15T19:21:26.000000Z"
}
}
===============
add branch dev
===============
If you find any errors, please email [email protected]