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

Закрыть пул для редактирования

Важно

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

Закрывает пул для редактирования.

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

Примечание

Если после редактирования не открыть пул вручную, он откроется автоматически через 15 минут.

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

Запрос

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

Path-параметры

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

Заголовки

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

Ответ

Примечание

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

{
  "id": "019587fd-b536-49f8-b6dc-01ffc25f8594",
  "type": "POOL.CLOSE",
  "status": "PENDING",
  "submitted": "2021-11-24T07:47:50.120",
  "started" : "2021-11-24T07:47:50.120",
  "finished" : "2021-11-24T07:47:50.120",
  "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

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