Общее #
- Base URL:
/api/v1/tasks - Авторизация: заголовок
Authorization: Bearer: <api_token>— токен пользователя, выдаётся в личном кабинете. - Права доступа: проверяются права пользователя на ресурс
project.tasks(view— чтение,create/edit/drop— изменение). - Формат дат:
YYYY-MM-DD.
Формат успешного ответа:
{
"status": "ok",
"data": ...
}
Формат ответа с ошибкой:
{
"status": "error",
"message": "..."
}
1. Список задач #
Список задач проекта с фильтрацией и пагинацией.
GET /api/v1/tasks
Параметры (query)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
| id | number | нет | ID задачи |
| statusId | number | нет | ID статуса задачи |
| objectTypeId | number | нет | ID типа объекта (project/section/page/keyword/link) |
| assignedToId | number | нет | ID исполнителя |
| objectId | number | нет | ID объекта, к которому привязана задача |
| limit | number | нет | Лимит записей, по умолчанию 100 |
| offset | number | нет | Смещение, по умолчанию 0 |
Фильтры statusId / objectTypeId / assignedToId — числовые идентификаторы (в отличие от имён status / objectType / assignedTo в выдаче, которые возвращаются строками).
Ответ (data)
| Поле | Тип | Описание |
|---|---|---|
| total | number | Всего задач по фильтру |
| tasks | array | Массив задач (см. ниже) |
Поля задачи:
| Поле | Тип | Описание |
|---|---|---|
| id | number | ID задачи |
| name | string | Название |
| description | string | Описание в Markdown, до 5000 символов |
| commentsCount | number | Количество комментариев задачи |
| deadline | string | Срок (YYYY-MM-DD, может быть null) |
| outdated | boolean | Просрочена ли задача |
| deadlineWeek | number | Номер недели срока |
| doneAt | string | Дата выполнения (YYYY-MM-DD, может быть null) |
| assignedTo | string | Имя исполнителя |
| createdBy | string | Имя автора |
| status | string | Название статуса (локализованное) |
| estimateTime | number | Плановое время |
| usedTime | number | Фактически затраченное время |
| objectType | string | Название типа объекта |
| objectName | string | Имя объекта (проект/раздел/страница/ключ/ссылка) |
| objectId | number | ID объекта |
| objectURL | string | URL объекта |
| createdAt | string | Дата создания |
| updatedAt | string | Дата обновления |
Пример
curl "https://.../api/v1/tasks?projectId=1445&statusId=1&limit=50" \
-H "Authorization: Bearer: <token>"
Возвращаемый результат #
{
"status": "ok",
"data": {
"total": 1,
"tasks": [
{
"id": 15,
"name": "Обновить мета-теги",
"description": null,
"commentsCount": 0,
"deadline": "2026-11-20",
"outdated": false,
"deadlineWeek": 47,
"doneAt": null,
"assignedTo": "Иван Иванов",
"createdBy": "Павел Копков",
"status": "В работе",
"estimateTime": 2,
"usedTime": 0,
"objectType": "Страница",
"objectName": "/catalog/",
"objectId": 231,
"objectURL": "https://example.ru/catalog/",
"createdAt": "2026-11-16",
"updatedAt": "2026-11-16"
}
]
}
}
2. Создание задачи #
Создание задачи. Если передан массив objectIds — создаётся по одной задаче на каждый объект.
POST /api/v1/tasks/create
Параметры (body, JSON)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
| name | string | да | Название задачи |
| status | number | да | ID статуса (см. /tasks/statuses) |
| description | string | нет | Описание в Markdown, до 5000 символов |
| objectType | number | нет | ID типа объекта (см. /tasks/object-types) |
| objectIds | array | нет | ID объектов — задача создаётся на каждый |
| assignedTo | number | нет | ID исполнителя (см. /tasks/assignees) |
| deadline | string | нет | Срок, YYYY-MM-DD |
| doneAt | string | нет | Дата выполнения, YYYY-MM-DD |
| estimateTime | number | нет | Плановое время |
| usedTime | number | нет | Фактическое время |
Задача создаётся от имени текущего пользователя (поле createdBy).
Ответ (data)
{
"created": true
}
Обратите внимание: id созданной задачи в ответе не возвращается — найдите задачу через GET /tasks (например, по name и дате создания).
Пример
curl -X POST "https://.../api/v1/tasks/create" \
-H "Authorization: Bearer: <token>" \
-H "Content-Type: application/json" \
-d '{"projectId": 1445, "name": "Обновить мета-теги", "status": 1, "objectIds": [231], "deadline": "2026-11-20"}'
3. Изменение задачи #
PUT /api/v1/tasks/update
Параметры (body, JSON)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта (задача должна принадлежать этому проекту) |
| taskId | number | да | ID задачи |
| name | string | нет | Название |
| description | string | нет | Описание в Markdown, до 5000 символов |
| objectType | number | нет | ID типа объекта |
| objectId | number | нет | ID объекта |
| status | number | нет | ID статуса |
| assignedTo | number | нет | ID исполнителя |
| deadline | string | нет | Срок, YYYY-MM-DD |
| doneAt | string | нет | Дата выполнения, YYYY-MM-DD |
| estimateTime | number | нет | Плановое время |
| usedTime | number | нет | Фактическое время |
| saveAsCopy | boolean | нет | Сохранить копией задачи (по умолчанию false) |
Если задача не найдена или не принадлежит проекту projectId — ошибка 404 (Task not found).
Ответ (data)
{
"updated": true
}
Поле updated — boolean: true, если задача изменена; false, если ни одно поле не изменилось.
4. Удаление задач #
Мягкое удаление одной или нескольких задач проекта.
DELETE /api/v1/tasks/drop
Параметры (body, JSON)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
| tasks | array | да | Массив ID удаляемых задач |
Если среди задач есть не принадлежащие проекту projectId — ошибка 400 (ничего не удаляется).
Ответ (data)
{
"dropped": true
}
5. Статусы задач (справочник) #
GET /api/v1/tasks/statuses
Параметры (query)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
Ответ (data) — массив объектов:
| Поле | Тип | Описание |
|---|---|---|
| id | number | ID статуса |
| name | string | Название (локализованное) |
| code | string | Код статуса |
| sort | number | Порядок сортировки |
6. Типы объектов (справочник) #
GET /api/v1/tasks/object-types
Параметры (query)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
Ответ (data) — массив объектов:
| Поле | Тип | Описание |
|---|---|---|
| id | number | ID типа объекта |
| name | string | Название (локализованное) |
| code | string | Код типа (project / section / page / keyword / link) |
Служебный тип объекта (id=4) в выдачу не включается.
7. Исполнители (справочник) #
Пользователи проекта, доступные для назначения на задачи.
GET /api/v1/tasks/assignees
Параметры (query)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
Ответ (data) — массив объектов:
| Поле | Тип | Описание |
|---|---|---|
| id | number | ID пользователя |
| name | string | Имя |
| role | string | Роль в проекте |
8. Комментарии задачи #
Комментарии к задаче. Текст комментария отображается в интерфейсе как Markdown, до 5000 символов.
- Base URL:
/api/v1/task-comments - Права доступа: чтение —
project.tasks.view; создание —project.tasks.edit; изменение и удаление — только автор комментария или суперадминистратор (host-admin).
8.1. Список комментариев #
GET /api/v1/task-comments
Параметры (query)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
| taskId | number | да | ID задачи |
| limit | number | нет | Лимит записей, по умолчанию 1000 |
| offset | number | нет | Смещение, по умолчанию 0 |
Ответ (data)
{
"status": "ok",
"data": {
"comments": [
{
"id": 1,
"taskId": 5,
"authorId": 1,
"author": "Иван Иванов",
"text": "**Готово**, проверь пожалуйста",
"createdAt": "2026-11-22 11:46:19",
"updatedAt": "2026-11-22 11:46:19"
}
],
"total": 1
}
}
8.2. Создание комментария #
POST /api/v1/task-comments/create
Параметры (body, JSON)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
| taskId | number | да | ID задачи |
| text | string | да | Текст комментария в Markdown, до 5000 символов |
Ответ (data) — созданный комментарий в формате из раздела 8.1.
8.3. Изменение комментария #
PUT /api/v1/task-comments/update
Параметры (body, JSON)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
| commentId | number | да | ID комментария |
| text | string | да | Новый текст комментария в Markdown, до 5000 символов |
Ответ (data) — обновлённый комментарий в формате из раздела 8.1.
Изменять комментарий может только его автор. Суперадминистратор (host-admin) может изменять любые комментарии.
8.4. Удаление комментариев #
DELETE /api/v1/task-comments/drop
Параметры (body, JSON)
| Имя | Тип | Обязательный | Описание |
|---|---|---|---|
| projectId | number | да | ID проекта |
| comments | array | да | Массив ID комментариев |
Удаление мягкое: заполняется deleted_at, комментарии перестают возвращаться в списке. Удалять комментарии может только их автор. Суперадминистратор (host-admin) может удалять любые комментарии.
{
"status": "ok",
"data": {"dropped": true}
}