Получить список пулов

GET /pools

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

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

curl -X GET 'https://tasks.yandex.ru/api/v1/pools' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

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

print(response.text)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/pools',
  'qs': {},
  '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 пулов):

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

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

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

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

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

Ответ

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

{
  "items": [
    {parameters_of_pool_1},
    {parameters_of_pool_2},
    ...
    {parameters_of_pool__n_}
  ],
  "has_more": false
}
Пример ответа
{
  "items": [
    {
      "id": "32267581",
      "project_id": "81776",
      "private_name": "Transcript of audio recordings",
      "may_contain_adult_content": true,
      "will_expire": "2023-03-09T00:00:00",
      "auto_close_after_complete_delay_seconds": 0,
      "reward_per_assignment": 7,
      "metadata": {},
      "assignment_max_duration_seconds": 600,
      "auto_accept_solutions": true,
      "auto_accept_period_day": 21,
      "assignments_issuing_config": {
        "issue_task_suites_in_creation_order": false
      },
      "filter": {
        "and": [
          {
            "or": [
              {
                "category": "profile",
                "key": "languages",
                "operator": "IN",
                "value": "EN"
              }
            ]
          }
        ]
      },
      "quality_control": {
        "configs": [
          {
            "collector_config": {
              "type": "ASSIGNMENT_SUBMIT_TIME",
              "uuid": "38830d4b-930b-43ab-a98f-f52e992fd11a",
              "parameters": {
                "fast_submit_threshold_seconds": 15
              }
            },
            "rules": [
              {
                "conditions": [
                  {
                    "key": "fast_submitted_count",
                    "operator": "GTE",
                    "value": 2
                  }
                ],
                "action": {
                  "type": "RESTRICTION_V2",
                  "parameters": {
                    "scope": "PROJECT",
                    "duration_unit": "PERMANENT"
                  }
                }
              }
            ]
          }
        ]
      },
      "defaults": {
        "default_overlap_for_new_task_suites": 3
      },
      "priority": 0,
      "owner": {
        "id": "6c6e20dc86cca2ae787afcb2629de162",
        "myself": true
      },
      "type": "REGULAR",
      "status": "OPEN",
      "created": "2022-03-10T07:41:53.626",
      "speed_quality_balance": {
        "percent": 100,
        "type": "TOP_PERCENTAGE_BY_QUALITY"
      }
    }
  ],
  "has_more": true
}

Параметр

Описание

items

array of objects

Массив со списком пулов и их свойств.

has_more

boolean

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

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

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

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

    См. подробнее о фильтрации запросов.

  • false — в ответе содержатся все имеющиеся элементы.

Предыдущая
Пулы
Следующая
Создать пул