Редактировать фильтр

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

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

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

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

Чтобы отредактировать фильтр, используйте HTTP-запрос с методом PATCH. В теле запроса укажите параметры в формате JSON.

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

{
    "name": "<новое_название_фильтра>",
    "filter": {
        "status": "open"
    }
}

Пример 1: Изменить название фильтра

• Используется HTTP-метод PATCH.
• Редактируется фильтр с идентификатором 12345.
• Изменяется только параметр name — название фильтра.
• Объект filter: не указан, поэтому условия фильтрации остаются без изменений.

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

{
    "name": "Новое название фильтра"
}

Пример 2: Изменить условия фильтрации

• Используется HTTP-метод PATCH.
• Редактируется фильтр с идентификатором 12345.
• Цель: изменить фильтр так, чтобы он показывал задачи с высоким приоритетом, назначенные на текущего пользователя.
• Объект filter: устанавливаются два новых условия:
  • Приоритет — критический (critical)
  • Исполнитель — текущий пользователь (me())
• Важно: параметр filter заменяет условия полностью. Все предыдущие условия фильтрации будут удалены.

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

{
    "filter": {
        "priority": "critical",
        "assignee": "me()"
    }
}

Пример 3: Добавить сортировку по приоритету

• Используется HTTP-метод PATCH.
• Редактируется фильтр с идентификатором 12345.
• Цель: добавить сортировку по приоритету (от высокого к низкому) к существующему фильтру.
• Параметр sorts: добавляется сортировка результатов по полю priority в порядке убывания (isAscending: false).
• Примечание: в этом примере не указан параметр filter, поэтому существующие условия фильтрации остаются без изменений. Изменяется только сортировка.

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

{
    "sorts": [
        {
            "field": "priority",
            "isAscending": false
        }
    ]
}

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

{
    "id": 12345,
    "self": "https://api.tracker.yandex.net/v3/filters/12345",
    "name": "Новое название фильтра",
    "filter": {
        "assignee": "me()",
        "status": "open"
    },
    "sorts": [
        {
            "field": {
                "self": "https://api.tracker.yandex.net/v3/fields/priority",
                "id": "priority",
                "display": "Приоритет"
            },
            "isAscending": false
        }
    ],
    "favorite": false,
    "permissions": {
        "WRITE": {
            "users": [
                {
                    "self": "https://api.tracker.yandex.net/v3/users/1234567890",
                    "id": "1234567890",
                    "display": "Имя Фамилия",
                    "cloudUid": "ajevuhegoiuhfasjhiu",
                    "passportUid": 1234567890
                }
            ],
            "groups": [],
            "roles": []
        },
        "READ": {
            "users": [],
            "groups": [
                {
                    "self": "https://api.tracker.yandex.net/v3/groups/5",
                    "id": "5",
                    "display": "Все сотрудники"
                }
            ],
            "roles": []
        }
    },
    "owner": {
        "self": "https://api.tracker.yandex.net/v3/users/1234567890",
        "id": "1234567890",
        "display": "Имя Фамилия",
        "cloudUid": "ajevuhegoiuhfasjhiu",
        "passportUid": 1234567890
    }
}