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

PUT /user-restrictions

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

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

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

curl -X PUT 'https://tasks.yandex.ru/api/v1/user-restrictions' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here' \
     -H 'Content-Type: application/json' \
     -d '{"scope":"ALL_PROJECTS","user_id":"1ad097faba0eff85a04fe30bc04d53db","will_expire":"2030-01-01T00:00:00.000Z"}'

import requests

url = "https://tasks.yandex.ru/api/v1/user-restrictions"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here',
  'Content-Type': 'application/json'
}
payload = {
  "scope": "ALL_PROJECTS",
  "user_id": "1ad097faba0eff85a04fe30bc04d53db",
  "will_expire": "2030-01-01T00:00:00.000Z"
}
response = requests.put(url, headers=headers, json=payload)

print(response.text)

var request = require('request');
var options = {
  'method': 'PUT',
  'url': 'https://tasks.yandex.ru/api/v1/user-restrictions',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here',
    'Content-Type': 'application/json'
  },
  'body': JSON.stringify({
    "scope": "ALL_PROJECTS",
    "user_id": "1ad097faba0eff85a04fe30bc04d53db",
    "will_expire": "2030-01-01T00:00:00.000Z"
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок

Описание

Authorization

API-токен для авторизации аккаунта. В качестве префикса добавьте OAuth.

Content-Type

Указывает формат данных (application/json) в передаваемом теле запроса.

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

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

Идентификатор блокировки.

Обязательный параметр

Предыдущая
Получить список блокировок
Следующая
Получить сведения о блокировке