Создать макрос
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет создать макрос.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы создать макрос, используйте HTTP-запрос с методом POST
:
POST /v2/queues/<ключ_или_идентификатор_очереди>/macros
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"name": "<имя_макроса>",
"body": "<текст_комментария>\n{{currentDateTime}}\n{{issue.author}}",
"fieldChanges": [
{
"field": "<идентификатор_поля_задачи>",
"value": "<значение_поля_задачи>"
},
...
]
}
Заголовки
-
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 | Название макроса. | Строка |
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
body | Сообщение, которое будет создано при выполнении макроса. Используйте специальный формат для оформления текста сообщения. Чтобы удалить сообщение, используйте конструкцию "body": {"unset":1} |
Строка |
fieldChanges | Массив с информацией о полях задачи, изменения которых запустит макрос. | Массив объектов |
Объекты массива fieldChanges
Параметр | Описание | Тип данных |
---|---|---|
field | Идентификатор поля задачи. Полный список полей задачи |
Строка |
value | Значение поля задачи. | Строка |
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит JSON-объект с параметрами созданного макроса.
{
"self": "https://api.tracker.yandex.net/v2/queues/TEST/macros/3",
"id": 3,
"queue": {
"self": "https://api.tracker.yandex.net/v2/queues/TEST",
"id": "1",
"key": "TEST",
"display": "Тестовая очередь"
},
"name": "Тестовый макрос",
"body": "Тестовый комментарий\n{{currentDateTime}}\n{{issue.author}}",
"fieldChanges": [
{
"field": {
"self": "https://api.tracker.yandex.net/v2/fields/tags",
"id": "tags",
"display": "Теги"
},
"value": [
"tag1"
]
},
...
]
}
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит параметры макроса. | Строка |
id | Идентификатор макроса. | Число |
queue | Объект с информацией об очереди, к задачам которой применяется макрос. | Объект |
name | Название макроса. | Строка |
body | Сообщение, которое будет создано при выполнении макроса. | Строка |
fieldChanges | Массив с информацией о полях задачи, изменения которых запустит макрос. | Массив объектов |
Поля объекта queue
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Строка |
key | Ключ очереди. | Строка |
display | Отображаемое название очереди. | Строка |
Поля объекта fieldChanges
Параметр | Описание | Тип данных |
---|---|---|
field | Объект с информацией о поле задачи. | Объект |
value | Массив со значениями поля задачи. | Массив объектов |
Поля объекта field
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о поле задачи. | Строка |
id | Идентификатор поля задачи. | Строка |
display | Отображаемое название поля задачи. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 409
- При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.