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

Заблокировать доступ к заданиям

Важно

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

Создает блокировку для исполнителя.

Запрос

PUT https://toloka.dev/api/v1/user-restrictions
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

PUT https://sandbox.toloka.dev/api/v1/user-restrictions
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

Заголовки

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

Тело запроса

{
  "scope": "PROJECT",
  "user_id": "f25a5f41-94e8-49bf-977f-3611087a16b3",
  "project_id": "10",
  "private_comment": "Many mistakes",
  "will_expire": "2016-04-10T18:08:07"
}

Параметр

Описание

scope

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

Область блокировки:

  • ALL_PROJECTS — все проекты заказчика;
  • PROJECT — проект (указывается project_id);
  • POOL — пул (указывается pool_id).

user_id

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

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

project_id

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

Обязателен, если scope=PROJECT.

Идентификатор проекта, к которому заблокирован доступ.

pool_id

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

Обязателен, если scope=POOL.

Идентификатор пула, к которому заблокирован доступ.

private_comment

string

Комментарий с причиной ограничения доступа.

Максимальная длина: 499 символов.

will_expire

string

Дата и время по UTC, когда доступ будет восстановлен. Формат даты ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

Ответ

Содержит идентификатор и параметры блокировки, дату ограничения доступа.

{
  "scope": "PROJECT",
  "user_id": "f25a5f41-94e8-49bf-977f-3611087a16b3",
  "project_id": "10",
  "private_comment": "Many mistakes",
  "will_expire": "2016-04-10T18:08:07",
  "id": "54",
  "created": "2016-03-28T18:08:07"
}

Параметр

Описание

scope

string

Область блокировки:

  • ALL_PROJECTS — все проекты заказчика;
  • PROJECT — проект (указывается project_id);
  • POOL — пул (указывается pool_id).

user_id

string

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

project_id

string

Указывается, если scope=PROJECT.

Идентификатор проекта, к которому заблокирован доступ.

pool_id

string

Указывается, если scope=POOL.

Идентификатор пула, к которому заблокирован доступ.

private_comment

string

Комментарий с причиной ограничения доступа.

Максимальная длина: 499 символов.

will_expire

string

Дата и время по UTC, когда доступ будет восстановлен. Формат даты ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

created

string

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

id

string

Идентификатор блокировки.
В этой статье: