Получить список блокировок

GET /user-restrictions

Получает список блокировок исполнителя.

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

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

import requests

url = "https://tasks.yandex.ru/api/v1/user-restrictions"
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',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок

Описание

Authorization

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

Query-параметры

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

Параметр

Описание

scope

string

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

  • ALL_PROJECTS — все проекты заказчика;
  • PROJECT — проект (указывается project_id);
  • POOL — пул (указывается pool_id);
  • SYSTEM — исполнители, которые выполняли задания заказчика, но были заблокированы на платформе.

user_id

string

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

project_id

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

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

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

pool_id

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

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

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

sort

string

Параметры для сортировки:

  • id — идентификатор;
  • created — дата создания по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

О том, как задать сортировку, читайте на странице Сортировка списка объектов.

limit

integer

Ограничение на количество возвращаемых результатов. По умолчанию — 20, максимум — 500.

id_gt

string

Объекты с идентификатором больше указанного значения.

id_gte

string

Объекты с идентификатором больше или равным указанному значению.

id_lt

string

Объекты с идентификатором меньше указанного значения.

id_lte

string

Объекты с идентификатором меньше или равным указанному значению.

created_gt

string

Объекты, выданные или созданные после указанной даты.

created_gte

string

Объекты, выданные или созданные после указанной даты включительно.

created_lt

string

Объекты, выданные или созданные до указанной даты.

created_lte

string

Объекты, выданные или созданные до указанной даты включительно.

Больше примеров

Чтобы получить список блокировок частями (например, по 10 блокировок), используйте комбинацию параметров в запросах:

Показать первые 10 блокировок

curl -X GET 'https://tasks.yandex.ru/api/v1/user-restrictions?sort=id&limit=10' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Показать остальные части с сортировкой по возрастанию идентификатора

curl -X GET 'https://tasks.yandex.ru/api/v1/user-restrictions?sort=id&limit=10&id_gt={ID_последней_блокировки_из_предыдущего_ответа}' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Ответ

Содержит список блокировок в массиве items:

{
  "items" : [
    {ban parameters 1},
    {ban parameters 2},
    ...
    {ban parameters n}
  ],
  "has_more": true
}
Пример ответа
{
  "items": [
    {
      "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"
    }
  ],
  "has_more": true
}

Параметр

Описание

items

array of objects

Массив со списком блокировок и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

Возможные значения:

  • true — не все элементы вошли в ответ из-за ограничений в параметре limit.

    Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

    См. подробнее о фильтрации запросов.

  • false — в ответе содержатся все имеющиеся элементы.

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