Создать триггер с помощью запроса к API
Запрос позволяет создать триггер.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы создать триггер, используйте HTTP-запрос с методом POST
. Параметры запроса передаются в его теле в формате JSON.
POST /v2/queues/<ключ_или_идентификатор_очереди>/triggers
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"name": "<имя_триггера>",
"actions": [<параметры_действия_триггера>]
}
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net
-
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>
, например:OAuth 0c4181a7c2cf4521964a72ff********
-
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker
.- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID
. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID
. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-ID
и идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<ключ_или_идентификатор_очереди> | Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. | Строка или число |
Параметры тела запроса
Обязательные параметры
Параметр | Описание | Тип данных |
---|---|---|
name | Название тригера. | Строка |
actions | Массив с действиями триггера. | Массив объектов |
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
conditions | Массив с условиями срабатывания триггера. | Массив объектов |
active | Статус триггера. Допустимые значения:
|
Логический |
Пример: Создать триггер, который срабатывает при заданном условии и меняет статус задачи.
- Используется HTTP-метод POST.
- Создается триггер для очереди DESIGN.
- Условие срабатывания триггера: текст комментария совпадает с «Open».
- Действие триггера: переход задачи в статус «Открыт».
POST /v2/queues/DESIGN/triggers Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> { "name": "TriggerName", "actions": [ { "type": "Transition", "status": { "key": "open" } } ], "conditions": [ { "type": "CommentFullyMatchCondition", "word": "Open" } ] }
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело запроса содержит информацию о созданном тригере в формате JSON.
{
"id": 16,
"self": "https://api.tracker.yandex.net/v2/queues/DESIGN/triggers/16",
"queue": {
"self": "https://api.tracker.yandex.net/v2/queues/DESIGN",
"id": "26",
"key": "DESIGN",
"display": "Дизайн"
},
"name": "trigger_name",
"order": "0.0002",
"actions": [
{
"type": "Transition",
"id": 1,
"status": {
"self": "https://api.tracker.yandex.net/v2/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 | Статус триггера. Допустимые значения:
|
Логический |
Поля объекта queue
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Строка |
key | Ключ очереди. | Строка |
display | Отображаемое название очереди. | Строка |
Поля объектов массива actions
Параметр | Описание | Тип данных |
---|---|---|
type | Тип действия. Допустимые значения:
|
Строка |
id | Идентификатор действия. | Строка |
status | Статус задачи. | Строка |
Поля объектов массива conditions
Параметр | Описание | Тип данных |
---|---|---|
type | Тип условия. Допустипые значения:
|
Строка |
conditions | Массив с условиями срабатывания триггера. Условие имеет параметр type — тип условия. Допустипые значения:
|
Массив объектов |
Поля объектов массива status
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о статусе. | Строка |
id | Идентификатор статуса. | Строка |
key | Ключ статуса. | Строка |
display | Отображаемое название статуса. | Строка |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 409
- При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.