Обзор REST-маршрутов

На этой странице представлен список всех REST-маршрутов с кратким описанием и ссылками на страницы с подробной информацией.
Перед изучением каждого маршрута рекомендуется ознакомиться с разделом Работа с сервером.

---

информация

Для быстрой навигации можно использовать одну из двух вкладок ниже:

• Маршруты по объектам данных — чтобы понять, какие маршруты использовать для каких операций
• Маршруты по методам — для быстрого ознакомления с маршрутами по HTTP-методам и данными, которые возвращает сервер

Маршруты по объектам данных

tasks

Используйте следующие маршруты для выполнения операций с задачами:

HTTP-метод	Маршрут	Описание
GET	/tasks	Получает данные о всех задачах и возвращает json-объект с массивом объектов задач
GET	/tasks/projects	Получает данные о всех задачах указанного проекта и возвращает json-объект с массивом всех объектов задач для этого проекта
POST	/tasks	Создаёт новую задачу и возвращает объект задачи с ID новой задачи
POST	/clone	Создаёт копию задачи и возвращает json-объект с клиентским ID задачи и ID дублированной задачи на сервере
PUT	/tasks	Обновляет данные указанной задачи (задач) и возвращает пустой json-объект
PUT	/move	Перемещает задачу в указанную позицию и возвращает пустой json-объект
PUT	/sort	Сортирует все задачи активного проекта по указанным параметрам и возвращает пустой json-объект
DELETE	/tasks	Удаляет данные о задаче и возвращает пустой json-объект

projects

Используйте следующие маршруты для выполнения операций с проектами:

HTTP-метод	Маршрут	Описание
GET	/projects	Получает данные о всех проектах и возвращает json-объект с массивом объектов проектов
POST	/projects	Создаёт новый проект и возвращает объект проекта с ID проекта
PUT	/projects	Обновляет данные проекта и возвращает пустой json-объект
DELETE	/projects	Удаляет данные проекта и возвращает пустой json-объект

users

Используйте следующие маршруты для выполнения операций с пользователями:

HTTP-метод	Маршрут	Описание
GET	/users	Получает данные о всех пользователях и возвращает json-объект с массивом объектов пользователей

tags

Используйте следующие маршруты для выполнения операций с тегами:

HTTP-метод	Маршрут	Описание
GET	/tags	Получает данные о всех тегах и возвращает json-объект с массивом этих тегов

Маршруты по методам

GET

Название	Описание
GET /users	Возвращает json-объект с массивом всех объектов пользователей
GET /tasks	Возвращает json-объект с массивом всех объектов задач
GET /projects	Возвращает json-объект с массивом всех доступных объектов проектов
GET /tags	Возвращает json-объект с массивом всех тегов по умолчанию
GET /tasks/projects	Возвращает json-объект с массивом всех объектов задач для указанного проекта

POST

Название	Описание
POST /clone	Возвращает json-объект с клиентским ID задачи и ID дублированной задачи на сервере.
POST /projects	Возвращает новый объект проекта с ID проекта
POST /tasks	Возвращает новый объект задачи с ID новой задачи

PUT

Название	Описание
PUT /move	Возвращает пустой json-объект, если задачи успешно перемещены в соответствии с запросом
PUT /sort	Возвращает пустой json-объект, если задачи отсортированы в соответствии с запросом
PUT /tasks	Возвращает пустой json-объект, если задача изменена в соответствии с запросом
PUT /projects	Возвращает пустой json-объект, если проект изменён в соответствии с запросом

DELETE

Название	Описание
DELETE /tasks	Возвращает пустой json-объект, если задача успешно удалена
DELETE /projects	Возвращает пустой json-объект, если проект успешно удалён