Изменить перекрытие страницы

Запрос
Path-параметры
Заголовки
Query-параметры
Тело запроса
Ответ

Важно

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

Изменяет перекрытие страницы заданий.

Вы можете задать числовое значение или установить бесконечное перекрытие, чтобы выдавать страницу заданий всем исполнителям (например, для обучающих заданий).

Запрос

Боевая версия

Песочница

PATCH https://toloka.dev/api/v1/task-suites/<task_suite_id>
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

PATCH https://sandbox.toloka.dev/api/v1/task-suites/<task_suite_id>
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

Path-параметры

Параметр	Описание
task_suite_id	Идентификатор страницы.

Заголовки

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

Query-параметры

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

Параметр	Описание
open_pool	boolean Открыть пул сразу после завершения операции, если пул закрыт. По умолчанию значение `false`.

Тело запроса

Числовое значение перекрытия

{
  "overlap": <new overlap value>,
  "infinite_overlap": false
}

Бесконечное перекрытие

{
  "overlap": null,
  "infinite_overlap": true
}

Параметр

Описание

overlap

integer | обязательный при условии

Обязателен, если при создании страницы заданий не используется параметр allow_defaults=true и перекрытие не указано в параметрах пула (ключ defaults.default_overlap_for_new_task_suites).

Перекрытие страницы заданий.

infinite_overlap

boolean | обязательный

Выдача страницы заданий с бесконечным перекрытием. Используется, например, для страниц обучающих заданий, чтобы выдать их всем исполнителям:

true — установить бесконечное перекрытие;
false — оставить перекрытие, указанное для страницы заданий или пула.

Ответ

Содержит страницу заданий в формате JSON.