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

GET /task-suites

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

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

cURL

Python

NodeJS

curl -X GET 'https://tasks.yandex.ru/api/v1/task-suites?pool_id=1227652' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/task-suites"
params = {
  'pool_id': '1227652'
}
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/task-suites',
  'qs': {'pool_id': '1227652'},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

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

Query-параметры

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

Параметр	Описание
`pool_id`	string Идентификатор пула, из которого нужно получить страницы заданий. Обязательно указать `task_id`, либо`pool_id`.
`task_id`	string Идентификатор задания на страницах, сформированных автоматически (с помощью «умного смешивания»). Вы получите страницы заданий, на которых есть указанное задание. Обязательно указать `task_id`, либо`pool_id`.
`sort`	string Параметры для сортировки: `id` — идентификатор страницы заданий; `created` — дата создания страницы заданий по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`. О том, как задать сортировку, читайте на странице Сортировка списка объектов.
`overlap`	integer Страницы с перекрытием, равным указанному значению.
`limit`	integer Ограничение на количество возвращаемых результатов. По умолчанию — 50, максимум — 100 000.
`id_gt`	string Объекты с идентификатором больше указанного значения.
`id_gte`	string Объекты с идентификатором больше или равным указанному значению.
`id_lt`	string Объекты с идентификатором меньше указанного значения.
`id_lte`	string Объекты с идентификатором меньше или равным указанному значению.
`created_gt`	string Объекты, выданные или созданные после указанной даты.
`created_gte`	string Объекты, выданные или созданные после указанной даты включительно.
`created_lt`	string Объекты, выданные или созданные до указанной даты.
`created_lte`	string Объекты, выданные или созданные до указанной даты включительно.
`overlap_gt`	integer Объекты с перекрытием больше указанного значения.
`overlap_gte`	integer Объекты с перекрытием, больше или равным указанному значению.
`overlap_lt`	integer Объекты с перекрытием меньше указанного значения.
`overlap_lte`	integer Объекты с перекрытием, меньше или равным указанному значению.

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

Можно настроить показ перечня страниц заданий частями (например, по 10 страниц):

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

Показать первые 10 страниц заданий

cURL

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

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

cURL

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

Ответ

Содержит страницы заданий в массиве items:

{
  "items" : [
    {task suite 1},
    {task suite 2},
    ...
    {task suite n}
  ],
  "has_more": true
}

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

{
  "items": [
    {
      "pool_id": "36502086",
      "tasks": [
        {
          "id": "00022cfa46--637cf3f76e13181a0164e729",
          "input_values": {
            "image": "https://example.com/image1.jpg"
          }
        },
        {
          "id": "00022cfa46--637cf3ed6e13181a0164e5a2",
          "input_values": {
            "image": "https://example.com/image2.jpg"
          }
        }
      ],
      "overlap": 1,
      "infinite_overlap": false,
      "reserved_for": [],
      "unavailable_for": [],
      "issuing_order_override": 0,
      "id": "00022cfa46--637cf41c9376542ef7b52bde",
      "mixed": true,
      "automerged": false,
      "created": "2022-11-22T16:09:00.308",
      "remaining_overlap": 0
    }
  ],
  "has_more": true
}

Параметр

Описание

items

array of objects

Массив со списком страниц заданий и их свойств.

has_more

boolean

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

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

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

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

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

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

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

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