Остановить выдачу страницы заданий

PATCH /task-suites/{id}/set-overlap-or-min

Останавливает выдачу страницы заданий исполнителям и устанавливает минимально возможное значение для перекрытия страницы заданий.

Для остановки выдачи страницы заданий исполнителям установите значение параметра overlap равное 0.

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

curl -X PATCH 'https://tasks.yandex.ru/api/v1/task-suites/000012e4ca--62eadb541b54e36b45b7a117/set-overlap-or-min' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here' \
     -H 'Content-Type: application/json' \
     -d '{"overlap":0}'

import requests

url = "https://tasks.yandex.ru/api/v1/task-suites/000012e4ca--62eadb541b54e36b45b7a117/set-overlap-or-min"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here',
  'Content-Type': 'application/json'
}
payload = {
  "overlap": 0
}
response = requests.patch(url, headers=headers, json=payload)

print(response.text)

var request = require('request');
var options = {
  'method': 'PATCH',
  'url': 'https://tasks.yandex.ru/api/v1/task-suites/000012e4ca--62eadb541b54e36b45b7a117/set-overlap-or-min',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here',
    'Content-Type': 'application/json'
  },
  'body': JSON.stringify({
    "overlap": 0
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path-параметры

Заголовки

Тело и параметры запроса

{
  "overlap": 0
}

Ответ

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

{
  "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
}

Включает:

• параметры, которые используются при создании страницы заданий:

  Параметр	Описание
  pool_id*	string Идентификатор пула, в который загружаются задания.
  tasks[]*	array of object Данные заданий. См. полный список параметров на странице Получить сведения о задании.
  overlap	integer (обязательный при условии) Обязателен, если при создании страницы заданий не используется параметр allow_defaults=true и перекрытие не указано в параметрах пула (ключ defaults.​default_​overlap_for_​new_task_suites). Перекрытие страницы заданий.
  longitude	float (обязательный при условии) Обязателен, если задания выбираются на карте. Иначе не используется. Долгота точки на карте для страницы заданий.
  latitude	float (обязательный при условии) Обязателен, если задания выбираются на карте. Иначе не используется. Широта точки на карте для страницы заданий.
  infinite_overlap*	boolean Выдача страницы заданий с бесконечным перекрытием. Используется, например, для страниц обучающих заданий, чтобы выдать их всем исполнителям: true — установить бесконечное перекрытие; false — оставить перекрытие, указанное для страницы заданий или пула.
  reserved_for[]	array of strings Идентификаторы исполнителей, которым будет доступна страница.
  unavailable_for[]	array of strings Идентификаторы исполнителей, для которых страница должна быть недоступна.
  issuing_order_override	float Приоритет страницы заданий среди других страниц в пуле. Определяет порядок выдачи страниц исполнителям. Чем больше значение параметра, тем выше приоритет. Параметр можно использовать, если в пуле issue_task_suites_in_creation_order=true. Возможные значения: от -99999.99999 до 99999.99999. По умолчанию значение 0.
  mixed	boolean Способ создания страницы заданий: true — автоматически с помощью опции «умное смешивание» (см. подробнее в разделе Как загрузить задания); false — вручную.

• параметры, которые присваиваются автоматически:

  Параметр	Описание
  id	string Идентификатор страницы заданий.
  remaining_overlap	integer Оставшееся перекрытие для каждого задания. Например, если для задания установлено перекрытие 5, а его разметили два человека, то значение remaining_overlap будет 3. Если задание ожидает приемки или активно, ключ принимает значение 0.
  automerged	boolean Флаг страницы заданий, созданной после слияния заданий. Значение: true — страница заданий сгенерирована в результате слияния идентичных заданий; false — обычная страница заданий, созданная «умным смешиванием» или заказчиком.
  created	string Дата и время создания страницы заданий по UTC в формате ISO 8601 YYYY-MM-DDThh:mm:ss[.sss].