Получить список обучений

  1. Запрос
  2. Заголовки
  3. Query-параметры
  4. Пример запроса
  5. Ответ

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

Запрос

GET https://toloka.yandex.com/api/v1/trainings
Authorization: OAuth <OAuth token>

Заголовки

Заголовок Описание
Authorization Токен для авторизации аккаунта. В качестве префикса добавьте OAuth.
Заголовок Описание
Authorization Токен для авторизации аккаунта. В качестве префикса добавьте OAuth.

Query-параметры

Указываются в ссылке после знака вопроса, перечисляются через &.

Параметр Описание
status

string

Статус обучающего пула:
  • OPEN — открыт;
  • CLOSED — закрыт;
  • LOCKED — заблокирован: невозможны никакие действия;
  • ARCHIVED — архивный.
project_id

string

Идентификатор проекта, к которому относится обучающий пул.
sort

string

Параметры для сортировки по возрастанию:
  • id — идентификатор обучающего пула;
  • created — дата создания обучающего пула по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss];
  • last_started — дата последнего запуска обучающего пула в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

О том, как задать сортировку, читайте на странице Сортировка списка объектов.

Стандартные query-параметры limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_ltelast_started_gt, last_started_gte, last_started_lt, last_started_lte
Параметр Описание
status

string

Статус обучающего пула:
  • OPEN — открыт;
  • CLOSED — закрыт;
  • LOCKED — заблокирован: невозможны никакие действия;
  • ARCHIVED — архивный.
project_id

string

Идентификатор проекта, к которому относится обучающий пул.
sort

string

Параметры для сортировки по возрастанию:
  • id — идентификатор обучающего пула;
  • created — дата создания обучающего пула по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss];
  • last_started — дата последнего запуска обучающего пула в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

О том, как задать сортировку, читайте на странице Сортировка списка объектов.

Стандартные query-параметры limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_ltelast_started_gt, last_started_gte, last_started_lt, last_started_lte

Пример запроса

Можно настроить показ списка обучающих пулов частями (например, по 10 пулов):

  1. Показать первые 10 пулов, начиная с пула с наименьшим идентификатором.
  2. Показывать оставшиеся пулы по 10 штук в порядке возрастания.
Показать первые 10 пулов
GET https://toloka.yandex.com/api/v1/trainings?sort=id&limit=10
Authorization: OAuth <OAuth token>
Показывать остальные части с сортировкой по возрастанию идентификатора
GET https://toloka.yandex.com/api/v1/trainings?sort=id&limit=10&id_gt=<id of the last training from the previous response>
Authorization: OAuth <OAuth token>

Ответ

Содержит список обучающих пулов и их свойств в массиве items:

{"items" : [{parameters_of_training_pool_1}, {parameters_of_training_pool_2}, ... {parameters_of_training_pool_n}], "has_more": false}