Создать автодействие
Запрос позволяет создать автодействие.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы создать автодействие, используйте HTTP-запрос с методом POST
. Параметры запроса передаются в его теле в формате JSON.
POST /v2/queues/<ключ_или_идентификатор_очереди>/autoactions
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"name": "<имя_автодействия>",
"filter": [<условия_фильтрации>],
"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 для бизнеса, используется заголовок
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<ключ_или_идентификатор_очереди> | Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. | Строка или число |
Параметры тела запроса
Обязательные параметры
Примечание
В теле запроса укажите хотя бы один из параметров: filter
или query
.
Параметр | Описание | Тип данных |
---|---|---|
name | Название автодействия. | Строка |
filter | Массив с условиями фильтрации полей задач, для которых сработает автодействие. | Массив объектов |
query | Строка запроса фильтрации задач, для которых сработает автодействие. Для написания используется язык запросов. Например: "query": "\"Статус\":\"В работе\"" |
Строка |
actions | Массив с действиями над задачами. | Массив объектов |
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
active | Статус автодействия. Допустимые значения:
|
Логический |
enableNotifications | Статус отправки уведомлений. Допустимые значения:
|
Логический |
intervalMillis | Периодичность запуска автодействия в миллисекундах. По умолчанию выставляется значение 3600000 (1 раз в час). |
Число |
calendar | Период, в который автодействие активно. Имеет параметр id — идентификатор графика работы. |
Объект |
Пример: Создать автодействие, которое срабатывает для задач, подходящих под условия фильтра, и меняет статус задач.
- Используется HTTP-метод POST.
- Создается автодействие для очереди DESIGN.
- Условие фильтрации: задачи в статусе «В работе», у которых в поле «Приоритет» указано «Критичный».
- Действие над задачей: переход в статус «Требуется информация».
- Период срабатывания: график работы с идентификатором
2
.
POST /v2/queues/DESIGN/autoactions Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> { "name": "AutoactionName", "filter": { "priority": [ "critical" ], "status": [ "inProgress" ] }, "actions": [ { "type": "Transition", "status": { "key": "needInfo" } } ], "calendar": { "id": 2 } }
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело запроса содержит информацию о созданном автодействии в формате JSON.
{
"id": 9,
"self": "https://api.tracker.yandex.net/v2/queues/DESIGN/autoactions/9",
"queue": {
"self": "https://api.tracker.yandex.net/v2/queues/DESIGN",
"id": "26",
"key": "DESIGN",
"display": "Дизайн"
},
"name": "autoaction_name",
"version": 1,
"active": true,
"created": "2022-01-21T17:10:22.993+0000",
"updated": "2022-01-21T17:10:22.993+0000",
"filter": {
"assignee": [
"13********"
],
"priority": [
"critical"
]
},
"actions": [
{
"type": "Transition",
"id": 1,
"status": {
"self": "https://api.tracker.yandex.net/v2/statuses/2",
"id": "2",
"key": "needInfo",
"display": "Требуется информация"
}
}
],
"enableNotifications": false,
"totalIssuesProcessed": 0,
"intervalMillis": 3600000,
"calendar": {
"id": 2
}
}
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор автодействия. | Строка |
self | Ссылка на автодействие. | Строка |
queue | Очередь, в которой нужно создать автодействие. | Может задаваться как объект, как строка (если передается ключ очереди), как число (если передается идентификатор очереди). |
name | Название автодействия. | Строка |
version | Версия автодействия. Каждое изменение автодействия увеличивает номер версии. | Число |
active | Статус автодействия. Допустимые значения:
|
Логический |
created | Дата и время создания автодействия в формате YYYY-MM-DDThh:mm:ss.sss±hhmm . |
Строка |
updated | Дата и время последнего изменения автодействия в формате YYYY-MM-DDThh:mm:ss.sss±hhmm . |
Строка |
filter | Массив с условиями фильтрации полей задач, для которых сработает автодействие. | Массив объектов |
query | Строка запроса для фильтрации задач. | Строка |
actions | Массив с действиями над задачами. | Массив объектов |
enableNotifications | Статус отправки уведомления. Допустимые значения:
|
Логический |
totalIssuesProcessed | Количество задач, которые были проверены автодействием при последнем срабатывании. | Число |
intervalMillis | Периодичность запуска автодействия в миллисекундах. По умолчанию выставляется значение 3600000 (1 раз в час). |
Число |
calendar | Период, в который автодействие активно. Имеет параметр id — идентификатор графика работы. |
Объект |
Поля объекта queue
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Строка |
key | Ключ очереди. | Строка |
display | Отображаемое название очереди. | Строка |
Поля объектов массива filter
Параметр | Описание | Тип данных |
---|---|---|
filter | Массив с условиями фильтрации полей задач. Используйте запрос, чтобы получить идентфиикатор глобального или локального поля. |
Массив объектов |
Поля объектов массива actions
Параметр | Описание | Тип данных |
---|---|---|
type | Тип действия. Допустимые значения:
|
Строка |
id | Идентификатор действия. | Строка |
status | Статус задачи. | Строка |
Поля объектов массива status
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о статусе. | Строка |
id | Идентификатор статуса. | Строка |
key | Ключ статуса. | Строка |
display | Отображаемое название статуса. | Строка |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.