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

GET /trainings

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

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

cURL

Python

Nodejs

curl -X GET 'https://tasks.yandex.ru/api/v1/trainings?project_id=118252' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/trainings"
params = {
  'project_id': '118252'
}
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, params=params, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/trainings',
  'qs': {'project_id': '118252'},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок	Описание
`Authorization`	API-токен для авторизации аккаунта. В качестве префикса добавьте `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]`. О том, как задать сортировку, читайте на странице Сортировка списка объектов.
`limit`	integer Ограничение на количество возвращаемых результатов. По умолчанию — 20, максимум — 300.
`id_gt`	string Объекты с идентификатором больше указанного значения.
`id_gte`	string Объекты с идентификатором больше или равным указанному значению.
`id_lt`	string Объекты с идентификатором меньше указанного значения.
`id_lte`	string Объекты с идентификатором меньше или равным указанному значению.
`created_gt`	string Объекты, выданные или созданные после указанной даты.
`created_gte`	string Объекты, выданные или созданные после указанной даты включительно.
`created_lt`	string Объекты, выданные или созданные до указанной даты.
`created_lte`	string Объекты, выданные или созданные до указанной даты включительно.
`last_started_gt`	string Объекты, которые были в последний раз открыты после указанной даты.
`last_started_gte`	string Объекты, которые были в последний раз открыты после указанной даты включительно.
`last_started_lt`	string Объекты, которые были в последний раз открыты до указанной даты.
`last_started_lte`	string Объекты, которые были в последний раз открыты раньше указанной даты включительно.

Больше примеров

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

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

Показать первые 10 пулов

cURL

curl -X GET 'https://tasks.yandex.ru/api/v1/trainings?sort=id&limit=10' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Показать остальные части с сортировкой по возрастанию идентификатора

cURL

curl -X GET 'https://tasks.yandex.ru/api/v1/trainings?sort=id&limit=10&id_gt={ID_последнего_обучения_из_предыдущего_ответа}' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Ответ

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

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

Пример ответа

{
  "items": [
    {
      "id": "31226418",
      "project_id": "74175",
      "private_name": "Simple training pool",
      "inherited_instructions": true,
      "public_instructions": "",
      "may_contain_adult_content": false,
      "assignment_max_duration_seconds": 600,
      "mix_tasks_in_creation_order": true,
      "shuffle_tasks_in_task_suite": true,
      "training_tasks_in_task_suite_count": 10,
      "retry_training_after_days": 14,
      "owner": {
        "id": "6c6e20dc86cca2ae787afcb2629de162",
        "myself": true
      },
      "status": "OPEN",
      "last_close_reason": "MANUAL",
      "created": "2022-01-22T07:50:14.781",
      "last_started": "2022-01-22T07:50:21.491",
      "last_stopped": "2022-02-24T13:40:29.754"
    }
  ],
  "has_more": true
}

Параметр

Описание

items

array of objects

Массив со списком обучающих пулов и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

Возможные значения:

true — не все элементы вошли в ответ из-за ограничений в параметре limit.

Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

См. подробнее о фильтрации запросов.
false — в ответе содержатся все имеющиеся элементы.

Была ли статья полезна?

Обучения

Создать обучение