Получить параметры фильтра

Запрос позволяет получить информацию о фильтре задач.

GET

https://api.tracker.yandex.net/v3/filters/<id_фильтра>

Формат запроса

Перед выполнением запроса получите доступ к API.

Для получения фильтра используйте HTTP-запрос с методом GET:

GET /v3/filters/<id_фильтра>
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,

    • если к Трекеру привязана организация Yandex Cloud Organization, используйте заголовок X-Cloud-Org-ID.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Параметры запроса

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

Параметр Описание Тип данных
<id_фильтра> Идентификатор фильтра. Число

Пример: Получить параметры фильтра

  • Используется HTTP-метод GET.
  • Запрашивается фильтр с идентификатором 12345.
GET /v3/filters/12345 HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит информацию о фильтре в формате JSON.

{
    "id": 12345,
    "self": "https://api.tracker.yandex.net/v3/filters/12345",
    "name": "Мои открытые задачи",
    "filter": {
        "assignee": "me()",
        "status": "open"
    },
    "fields": [
        {
            "self": "https://api.tracker.yandex.net/v3/fields/key",
            "id": "key",
            "display": "Ключ"
        },
        {
            "self": "https://api.tracker.yandex.net/v3/fields/summary",
            "id": "summary",
            "display": "Задача"
        },
        {
            "self": "https://api.tracker.yandex.net/v3/fields/status",
            "id": "status",
            "display": "Статус"
        }
    ],
    "groupBy": {
    "self": "https://api.tracker.yandex.net/v3/fields/status",
    "id": "status",
    "display": "Статус"
    },
    "favorite": false,
    "permissions": {
        "READ": {
            "users": [],
            "groups": [
                {
                    "self": "https://api.tracker.yandex.net/v3/groups/5",
                    "id": "5",
                    "display": "Все сотрудники"
                }
            ],
            "roles": []
        },
        "WRITE": {
            "users": [
                {
                    "self": "https://api.tracker.yandex.net/v3/users/1234567890",
                    "id": "1234567890",
                    "display": "Имя Фамилия",
                    "cloudUid": "ajevuhegoiuhfasjhiu",
                    "passportUid": 1234567890
                }
            ],
            "groups": [],
            "roles": []
        }
    },
    "owner": {
        "self": "https://api.tracker.yandex.net/v3/users/1234567890",
        "id": "1234567890",
        "display": "Имя Фамилия",
        "cloudUid": "ajevuhegoiuhfasjhiu",
        "passportUid": 1234567890
    }
}
Параметры ответа
Параметр Описание Тип данных
id Идентификатор фильтра. Число
self Адрес ресурса API, который содержит информацию о фильтре. Строка
name Название фильтра. Строка
filter Объект с условиями фильтрации. Объект
query Строка с условиями фильтрации, записанными на языке запросов. Строка
fields Массив полей задачи для отображения в UI. Массив объектов
groupBy Поле для группировки результатов в UI. Объект
favorite Признак избранного фильтра: true — фильтр добавлен в избранное, false — не добавлен. Логический
permissions Объект с информацией о правах доступа к фильтру. Объект
owner Объект с информацией о владельце фильтра. Объект

Поля массива fields

Массив содержит объекты с информацией о полях задачи, которые будут отображаться в пользовательском интерфейсе Tracker при использовании фильтра.

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о поле. Строка
id Идентификатор поля. Строка
display Отображаемое название поля. Строка

Пример:

"fields": [
    {
        "self": "https://api.tracker.yandex.net/v3/fields/key",
        "id": "key",
        "display": "Ключ"
    },
    {
        "self": "https://api.tracker.yandex.net/v3/fields/summary",
        "id": "summary",
        "display": "Название"
    }
]

Примечание

Параметр fields влияет только на отображение в интерфейсе Tracker, но не влияет на результаты API-запросов. При использовании фильтра через API (метод /v2/issues/_search) будут возвращаться все поля задачи независимо от значения параметра fields.

Поля объекта groupBy

Объект содержит информацию о поле, по которому группируются результаты в пользовательском интерфейсе Tracker.

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о поле. Строка
id Идентификатор поля. Строка
display Отображаемое название поля. Строка

Пример:

"groupBy": {
    "self": "https://api.tracker.yandex.net/v3/fields/status",
    "id": "status",
    "display": "Статус"
}

Примечание

Параметр groupBy влияет только на отображение в интерфейсе Tracker (задачи группируются по указанному полю), но не изменяет результаты API-запросов.

Поля объекта permissions

Параметр Описание Тип данных
READ Объект с информацией о правах на чтение фильтра. Объект
WRITE Объект с информацией о правах на редактирование фильтра. Объект

Поля объектов READ и WRITE

Параметр Описание Тип данных
users Массив пользователей, у которых есть соответствующие права. Массив объектов
groups Массив групп, у которых есть соответствующие права. Массив объектов
roles Массив ролей, у которых есть соответствующие права. Массив объектов

Поля объекта owner

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число
cloudUid Уникальный идентификатор пользователя в Yandex Cloud Organization. Строка

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Создать фильтр
Следующая
Редактировать фильтр