Список всех методов API Яндекс Заданий

Проекты

Метод

Эндпоинт

Описание

GET

/projects

Получает список проектов.

POST

/projects

Создает проект.

GET

/projects/{id}

Получает свойства проекта.

PUT

/projects/{id}

Редактирует проект.

POST

/projects/{id}/archive

Отправляет проект в архив.

Пулы

Метод

Эндпоинт

Описание

GET

/pools

Получает список созданных пулов (в том числе архивных).

POST

/pools

Создает пул.

GET

/pools/{id}

Получает свойства пула.

PATCH

/pools/{id}

Изменяет приоритет пула.

PUT

/pools/{id}

Вносит изменения в пул.

POST

/pools/{id}/archive

Переносит пул в архив.

POST

/pools/{id}/clone

Создает дубликат пула.

POST

/pools/{id}/close

Закрывает пул.

POST

/pools/{id}/close-for-update

Закрывает пул для редактирования.

POST

/pools/{id}/open

Открывает пул.

GET

/api/new/requester/pools/{id}/validate

Проверяет, возможен ли запуск пула.

PUT

/api/new/requester/poolModeration/{id}

Отправляет пул на модерацию.

Обучения

Метод

Эндпоинт

Описание

GET

/trainings

Получает список созданных обучений (в том числе архивных).

POST

/trainings

Создает обучающий пул (обучение).

GET

/trainings/{id}

Получает свойства обучающего пула.

PUT

/trainings/{id}

Вносит изменения в обучающий пул.

POST

/training/{id}/archive

Переносит обучающий пул в архив.

POST

/training/{id}/clone

Создает дубликат обучающего пула.

POST

/trainings/{id}/close

Закрывает обучающий пул.

POST

/trainings/{id}/close-for-update

Закрывает обучающий пул для редактирования.

POST

/trainings/{id}/open

Открывает обучающий пул.

Метод

Эндпоинт

Описание

GET

/skills

Получает список созданных навыков.

POST

/skills

Создает навык.

GET

/skills/{id}

Получает свойства навыка.

PUT

/skills/{id}

Изменяет название, комментарий и уровень доступа к навыку.

GET

/user-skills

Получает список исполнителей с назначенными навыками.

PUT

/user-skills

Задает значение навыка.

GET

/user-skills/{id}

Получает значение навыка исполнителя.

DELETE

/user-skills/{id}

Удаляет навык у исполнителя.

Блокировка доступа к заданиям

Метод

Эндпоинт

Описание

PUT

/user-restrictions

Создает блокировку для исполнителя.

GET

/user-restrictions

Получает список блокировок исполнителя.

GET

/user-restrictions/{id}

Получает сведения о блокировке.

DELETE

/user-restrictions/{id}

Удаляет блокировку.

Задания

Метод

Эндпоинт

Описание

GET

/tasks

Получает список заданий в пуле.

POST

/tasks

Создает одно или несколько заданий.

GET

/tasks/{id}

Получает данные задания.

PATCH

/tasks/{id}

Меняет перекрытие задания.

PATCH

/tasks/{id}/set-overlap-or-min

Останавливает выдачу задания исполнителям.

Страницы заданий

Метод

Эндпоинт

Описание

GET

/task-suites

Получает список страниц заданий в пуле.

POST

/task-suites

Создает одну или несколько страниц заданий.

GET

/task-suites/{id}

Получает страницу заданий.

PATCH

/task-suites/{id}

Изменяет перекрытие или приоритет страницы заданий в пуле.

PATCH

/task-suites/{id}/set-overlap-or-min

Останавливает выдачу страницы заданий исполнителям.

Отслеживание операций

Метод

Эндпоинт

Описание

GET

/operations

Получает список созданных операций.

GET

/operations/{id}

Получает сведения об операции.

GET

/operations/{id}/log

Получает лог операции.

Получение ответов

Метод

Эндпоинт

Описание

GET

/assignments

Получает ответы во всех страницах заданий пула.

GET

/assignments/{id}

Получает свойства ответа.

POST

/assignments

Получает свойства одного или нескольких ответов.

Файлы в ответах

Метод

Эндпоинт

Описание

GET

/attachments

Получает список сохраненных файлов.

GET

/attachments/{id}

Получает свойства прикрепленного к ответу в задании файла.

GET

/attachments/{id}/download

Скачивает прикрепленный к ответу в задании файл.

Агрегация ответов

Метод

Эндпоинт

Описание

POST

/aggregated-solutions/aggregate-by-pool

Запускает агрегацию ответов на все выполненные задания в пуле.

POST

/aggregated-solutions/aggregate-by-task

Запускает агрегацию ответов на одно задание.

GET

/aggregated-solutions/{operation_id}

Получает агрегированные ответы.

Бонусы

Метод

Эндпоинт

Описание

GET

/user-bonuses

Получает список выданных бонусов.

POST

/user-bonuses

Выдает бонусы исполнителям.

GET

/user-bonuses/{id}

Получает свойства выданного бонуса.

Сообщения исполнителям

Метод

Эндпоинт

Описание

GET

/message-threads

Получает список цепочек сообщений.

POST

/message-threads/{id}/add-to-folders

Добавляет цепочку сообщений в папку.

POST

/message-threads/{id}/remove-from-folders

Удаляет цепочку сообщений из папки.

POST

/message-threads/{id}/reply

Отвечает на цепочку сообщений.

POST

/message-threads/compose

Рассылает сообщение исполнителям.

Метаданные пользователей

Метод

Эндпоинт

Описание

GET

/user-metadata/{id}

Получает данные пользователя с id, указанным в запросе.

Данные об остатке

Метод

Эндпоинт

Описание

GET

/requester

Получает информацию об остатке на счете.

Подписки на события

Метод

Эндпоинт

Описание

GET

/webhook-subscriptions

Получает данные по нескольким созданным подпискам.

PUT

/webhook-subscriptions

Создает одну или несколько подписок.

GET

/webhook-subscriptions/{id}

Получает данные подписки.

DELETE

/webhook-subscriptions/{id}

Удаляет подписку.

POST

/webhook-subscriptions/{id}/test

Отправляет тестовое уведомление на URL, который указан в подписке.