Получить список триггеров очереди

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

GET

https://api.tracker.yandex.net/v3/queues/{id_очереди}/triggers

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

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

Чтобы получить список триггеров очереди, используйте HTTP-запрос с методом GET.

GET /v3/queues/{id_очереди}/triggers
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
Заголовки
  • Host: адрес узла, предоставляющего API.

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

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

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

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

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

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

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

Ресурс
Параметр Описание Тип данных
id_очереди Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка или число
Параметры запроса

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

Параметр Описание Тип данных
perPage Количество триггеров на странице. Целое число
id Идентификатор последнего триггера с предыдущей страницы. Используется для получения следующей страницы. Число

Механизм пагинации

Запрос использует относительную пагинацию:

  • Сортировка происходит по возрастанию идентификатора триггера.
  • Для получения следующей страницы используйте идентификатор последнего триггера предыдущей страницы в параметре id.

Пример последовательных запросов

  1. Первый запрос:

    GET /v3/queues/DESIGN/triggers?perPage=20
    
  2. Следующий запрос:

    GET /v3/queues/DESIGN/triggers?perPage=20&id=LAST_TRIGGER_ID
    

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

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

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

[
    {
        "id": 16,
        "self": "https://api.tracker.yandex.net/v3/queues/DESIGN/triggers/16",
        "queue": {
            "self": "https://api.tracker.yandex.net/v3/queues/DESIGN",
            "id": "26",
            "key": "DESIGN",
            "display": "Design"
        },
        "name": "trigger_name",
        "order": "0.0002",
        "actions": [
            {
                "type": "Transition",
                "id": 1,
                "status": {
                    "self": "https://api.tracker.yandex.net/v3/statuses/2",
                    "id": "2",
                    "key": "needInfo",
                    "display": "Требуется информация"
                }
            }
        ],
        "conditions": [
            {
                "type": "Or",
                "conditions": [
                    {
                        "type": "Event.comment-create"
                    }
                ]
            }
        ],
        "version": 1,
        "active": true
    }
]
Параметры ответа
Параметр Описание Тип данных
id Идентификатор триггера. Число
self Ссылка на триггер. Строка
queue Очередь, в которой создан триггер. Может задаваться как объект, как строка (если передается ключ очереди), как число (если передается идентификатор очереди).
name Название триггера. Строка
order Вес триггера. Параметр влияет на порядок отображения триггера в интерфейсе. Строка
actions Массив с действиями триггера. Массив объектов
conditions Массив с условиями срабатывания триггера. Массив объектов
version Версия триггера. Каждое изменение триггера увеличивает номер версии. Число
active Статус триггера. Допустимые значения:
  • true— активный;
  • false— неактивный.
Логический

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

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

Поля объектов массива actions

Параметр Описание Тип данных
type Тип действия. Допустимые значения:
  • Transition— изменить статус задачи;
  • Update— изменить значения в полях;
  • Move— переместить задачу;
  • Event.comment-create— добавить комментарий;
  • CreateChecklist— создать чеклист;
  • Webhook— отправить HTTP-запрос;
  • CalculateFormula— вычислить значение;
  • Event.create— создать задачу.
Строка
id Идентификатор действия. Строка
status Статус задачи. Строка

Поля объектов массива conditions

Параметр Описание Тип данных
type Тип условия. Допустимые значения:
  • or— логическое ИЛИ;
  • and— логическое И.
Строка
conditions Массив с условиями срабатывания триггера.
Условие имеет параметр type — тип условия. Допустимые значения:
  • CommentNoneMatchCondition— комментарий не содержит ни одного из фрагментов;
  • CommentStringNotMatchCondition— комментарий не содержит фрагмент;
  • CommentFullyMatchCondition— комментарий совпадает с;
  • CommentAnyMatchCondition— комментарий содержит любой из фрагментов;
  • CommentStringMatchCondition— комментарий содержит фрагмент;
  • CommentAuthorNot— автор комментария не;
  • CommentAuthor— автор комментария;
  • CommentAuthorInGroups— автор комментария входит в одну из групп;
  • CommentAuthorNotInGroups— автор комментария не входит ни в одну из групп;
  • CommentMessageExternal— тип комментария Письмо на почту;
  • CommentMessageInternal— тип комментария Комментарий в Трекере;
  • CommentAuthorContainerConditionProto— проверка авторов новых комментариев текущего изменения. См. поля условия.
Массив объектов

Поля объектов массива status

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

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

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

Ключ очереди — это уникальный код из латинских букв, например TEST. Он содержится в ссылках на задачи очереди и нужен для некоторых настроек и API-запросов.