Сформировать подсказки (suggest) при поиске задач

Запрос позволяет получить список задач, в названии которых есть введенный фрагмент текста. В ответ попадут только те задачи, к которым у пользователя есть доступ.

GET

https://api.tracker.yandex.net/v3/issues/_suggest

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

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

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

GET /v3/issues/_suggest?input=<текст>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
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: идентификатор организации.

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

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

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

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

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

Параметр Описание Тип данных
input Фрагмент текста для вывода списка задач. Если между словами в тексте указан пробел, в выдачу также попадут результаты, в которых есть любой текст на месте пробела. Строка

Дополнительные параметры

Параметр Описание Тип данных
queue Ключ очереди, в которой будет выполнен поиск задач. Строка
full Опция, которая позволяет вывести подробную информацию о каждой задаче из списка. Значение по умолчанию — false. Обязательный параметр для включения fields, expand, embed. Логический
fields Поля задачи, которые будут переданы в ответе. Полный перечень полей задачи можно получить при помощи запроса Получить параметры задачи.
Чтобы включить параметр, в запросе необходимо также указать значение full=true.
expand Дополнительная информация, которая будет включена в ответ. Доступные значения:
  • all — все параметры задачи;
  • html — описание задачи в формате HTML;
  • attachments — вложенные файлы;
  • comments — комментарии к задаче;
  • links — подробная информация о связях задачи;
  • localLinkRefs — краткая информация о связях задачи;
  • aliases — все ключи задачи;
  • transitions — переходы по жизненному циклу;
  • permissions — права доступа пользователей к задаче;
  • sla— информация о правилах SLA;
  • update_limits — ограничения на редактирование задачи.
Чтобы включить параметр, в запросе необходимо также указать значение full=true.		 Строка
embed Более подробная информация о параметрах, которые были указаны в expand. Доступные значения:
  • attachments — вложенные файлы;
  • comments — комментарии к задаче;
  • transitions — переходы по жизненному циклу;
  • sla— информация о правилах SLA.
Чтобы включить параметр, в запросе необходимо также указать значение full=true.		 Строка

Пример: найти все доступные задачи, в названии которых есть фраза исправить ошибки. В выдаче ответа отобразить параметры задачи: Название, Статус, Исполнитель, Наблюдатели.

Используется HTTP-метод GET.

GET  https://api.tracker.yandex.net/v3/issues/_suggest?full=true&fields=summary,status,assignee,followers&input=исправить+ошибки

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

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

Тело ответа содержит JSON-массив с информацией о комментариях:

[
    {
        "self": "https://api.tracker.yandex.net/v3/issues/TEST-123",
        "id": "11dac33333333a...",
        "key": "TEST-123",
        "version": 749,
        "summary": "My summary",
        "followers": [
            {
                "self": "https://api.tracker.yandex.net/v3/users/111********",
                "id": "11********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp53********",
                "passportUid": 11********
            },
            {
                "self": "https://api.tracker.yandex.net/v3/users/11********",
                "id": "11********",
                "display": "Имя Фамилия",
                "cloudUid": "ajeppa7dgp53********",
                "passportUid": 11********
            }
        ],
        "assignee": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия",
            "cloudUid": "ajeppa7dgp53********",
            "passportUid": 11********
        },
        "status": {
            "self": "https://api.tracker.yandex.net/v3/statuses/3",
            "id": "3",
            "key": "open",
            "display": "Открыт"
        }
    },
    ...
]
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о задаче. Строка
id Идентификатор задачи. Строка
key Ключ задачи. Строка
version Версия задачи. Каждое изменение задачи увеличивает номер версии. Число
summary Название задачи. Строка
followers Массив объектов с информацией о наблюдателях задачи. Массив
assignee Объект с информацией об исполнителе задачи. Объект
status Объект с информацией о статусе задачи. Объект

Поля объектов followers и assignee

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

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

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

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

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Найти задачи
Следующая
Освободить ресурсы просмотра прокрутки