Получить сведения о блокировке

GET /user-restrictions/{id}

Получает сведения о блокировке, ID которой указан в запросе.

Можно получить идентификатор из списка блокировок.

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

curl -X GET 'https://tasks.yandex.ru/api/v1/user-restrictions/19038' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'
import requests

url = "https://tasks.yandex.ru/api/v1/user-restrictions/19038"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, headers=headers)

print(response.text)
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/user-restrictions/19038',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path-параметры

Параметр

Описание

id*

string

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

Заголовки

Заголовок

Описание

Authorization

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

Ответ

Содержит параметры блокировки в формате JSON.

Пример ответа
{
  "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

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

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