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

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

GET

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

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

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

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

GET /v3/queues/{id_очереди}/triggers/{id_триггера}
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_очереди`	Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов.	Строка или число
`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` — переместить задачу; `CreateComment` — добавить комментарий; `CreateChecklist` — создать чеклист; `Webhook` — отправить HTTP-запрос; `CalculateFormula` — вычислить значение; `CreateIssue` — создать задачу.	Строка
id	Идентификатор действия.	Число
status	Статус, в который переводится задача. Возвращается для действия с типом `Transition`.	Объект
text	Текст комментария для действия с типом `CreateComment`, если задан.	Строка

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

Каждый объект массива conditions задает проверку, которую определяет поле type. Это может быть проверка события, например создания задачи, или проверка данных задачи и комментария. Объекты с типом Or или And объединяют проверки в логические группы. Вложенные условия возвращаются в собственном массиве conditions группы.

Параметр	Описание	Тип данных
type	Тип условия. См. допустимые значения поля `type`	Строка
conditions	Вложенные условия. Возвращается для логических групп `Or` и `And`. Каждый элемент имеет ту же структуру, что и объект верхнего массива `conditions`	Массив объектов

Набор остальных полей зависит от значения type. Примеры параметров условий приведены в разделе Объекты условий срабатывания триггера.

Допустимые значения поля type объекта условия

Группа условий	Значения `type`
Логические группы	`Or` — логическое ИЛИ: выполнено хотя бы одно вложенное условие; `And` — логическое И: выполнены все вложенные условия.
События	`Event.create` — создана задача; `Event.update` — задача изменилась; `Event.comment-create` — создан комментарий; `CalculationFormulaWatch` — поля формулы изменились. Примеры задания условий
Чеклист	`ChecklistDone` — все пункты чеклиста выполнены. Примеры задания условий
Текст комментария	`CommentAnyMatchCondition` — содержит любой из фрагментов; `CommentStringMatchCondition` — содержит фрагмент; `CommentNoneMatchCondition` — не содержит ни одного из фрагментов; `CommentStringNotMatchCondition` — не содержит фрагмент; `CommentFullyMatchCondition` — совпадает с. Примеры задания условий
Автор комментария	`CommentAuthor` — автор комментария совпадает с указанным пользователем; `CommentAuthorNot` — автор комментария не совпадает с указанным пользователем. Примеры задания условий
Тип комментария	`CommentMessageInternal` — комментарий в Трекер; `CommentMessageExternal` — письмо на почту. Примеры задания условий
Действие со связью	`CreatedLinkCondition` — связь создана; `UpdatedLinkCondition` — связь обновлена; `RemovedLinkCondition` — связь удалена. Примеры задания условий
Значение поля	`FieldChangedCondition` — значение поля изменилось; `FieldEquals` — равно; `FieldBecameEqual` — стало равно. Примеры задания условий
Состояние поля	`FieldIsNotEmpty` — значение поля не пусто; `FieldIsEmpty` — значение поля пусто; `FieldBecameEmpty` — значение поля удалено; `FieldBecameNotEmpty` — значение поля установлено. Примеры задания условий
Дата	`DateEqualCondition` — дата совпадает; `DateGreaterCondition` — позднее; `DateGreaterOrEqualCondition` — позднее или равно; `DateLessCondition` — раньше; `DateLessOrEqualCondition` — раньше или равно. Примеры задания условий
Группы пользователей	`UserInGroups` — пользователь входит в одну из групп; `UserNotInGroups` — пользователь не входит ни в одну из групп. Примеры задания условий
Количество элементов	`Container.SizeEquals` — количество элементов равно; `Container.SizeNotEquals` — количество элементов не равно; `Container.SizeGreater` — количество элементов больше; `Container.SizeGreaterOrEquals` — количество элементов больше или равно; `Container.SizeLess` — количество элементов меньше; `Container.SizeLessOrEquals` — количество элементов меньше или равно; `ContainerContainsAll` — содержит все элементы; `ContainerContainsAny` — содержит любой из элементов; `ContainerContainsNone` — не содержит ни одного элемента. Примеры задания условий
Числовые значения	`GreaterCondition` — больше; `GreaterOrEqualCondition` — больше или равно; `LessCondition` — меньше; `LessOrEqualCondition` — меньше или равно; `BecameGreaterCondition` — стало больше; `BecameGreaterOrEqualCondition` — стало больше или равно; `BecameLessCondition` — стало меньше; `BecameLessOrEqualCondition` — стало меньше или равно. Примеры задания условий
Строковые значения	`FieldEqualsString` — равно строке; `ContainsAnyOfStrings` — содержит любой из фрагментов; `ContainsNoneOfStrings` — не содержит ни одного из фрагментов. Примеры задания условий

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

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

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

400: Один или несколько параметров запроса имеют недопустимое значение.

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

422: Ошибка валидации JSON, запрос отклонен.

500: Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503: Сервис API временно недоступен.

Была ли статья полезна?

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

Изменить триггер