Документация Толоки

Закрыть пул

Важно

Домен toloka.yandex.com работает в режиме deprecated. Рекомендуем переключиться на домен toloka.dev для запросов API.

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

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

В результате запросов создается операция. Чтобы отслеживать ход операции, отправьте запрос к ресурсу /operations.

Запрос

POST https://toloka.dev/api/v1/pools/<pool_id>/close
Authorization: OAuth <OAuth token>
POST https://sandbox.toloka.dev/api/v1/pools/<pool_id>/close
Authorization: OAuth <OAuth token>

Path-параметры

Параметр Описание
pool_id Идентификатор пула.

Заголовки

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

Ответ

Примечание

Если текущий статус пула совпадает с запрашиваемым, возвращается пустой ответ со статусом 204.

{
  "id": "fadfe3jk-fdafue2-fda32890-fdafdi23",
  "type": "POOL.CLOSE",
  "status": "PENDING",
  "submitted": "2015-22-12T14:18:35",
  "started" : "2016-04-07T16:06:15.902",
  "finished" : "2016-04-07T16:06:15.902",
  "progress" : 100,
  "parameters": {
    "pool_id": "21"
  }
}

Параметр

Описание

id

string

Идентификатор исполнителя.

type

string

Тип операции: POOL.CLOSE — закрытие пула.

status

string

Статус операции:

  • PENDING — выполнение не началось;
  • RUNNING — выполняется;
  • SUCCESS — успешно выполнена;
  • FAIL — не выполнена.

submitted

string

Дата и время отправки запроса по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

started

string

Дата и время начала операции по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

finished

string

Дата и время окончания операции по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

progress

integer

Ход выполнения операции в процентах.

parameters.pool_id

string Идентификатор пула.