Редактировать макрос
Запрос позволяет изменить параметры макроса.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы изменить параметры макроса, используйте HTTP-запрос с методом PATCH
:
PATCH /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": <объект_или_массив>
}
Заголовки
-
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 | Сообщение, которое будет создано при выполнении макроса. Формат: <текст_сообщения>\n<переменная> где:
"body": {"unset":1} |
Строка |
fieldChanges | Объект или массив с информацией о новых настройках действий макроса. Структура объекта отличается в зависимости от типа изменений. | Объект или массив |
Структура объекта fieldChanges
Добавить действие макроса. Параметр add
позволяет добавить поле и его значение в список имеющихся.
"fieldChanges": {
"add": [
{
"field": "tags",
"value": "tag2"
},
...
]
Тело запроса
Параметр | Описание | Тип данных |
---|---|---|
fieldChanges | Объект с информацией о новых настройках действий макроса. | Объект |
Объект массива fieldChanges
Параметр | Описание | Тип данных |
---|---|---|
add | Массив с информацией о параметрах нового действия макроса. | Массив |
Объекты массива add
Параметр | Описание | Тип данных |
---|---|---|
field | Идентификатор поля задачи. Полный список полей задачи |
Строка |
value | Значение поля задачи. | Строка |
Заменить действие макроса на новое. Параметр replace
позволяет заменить поле и его значение, заданные с помощью параметра target
на новые, заданные с помощью параметра replacement
.
"fieldChanges": {
"replace": [
{
"target": {
"field": "tags",
"value": "tag2"
},
"replacement": {
"field": "originalEstimation",
"value": "PT2H"
}
}
]
}
Тело запроса
Параметр | Описание | Тип данных |
---|---|---|
fieldChanges | Объект с информацией о новых настройках действий макроса. | Объект |
Параметры объекта fieldChanges
Параметр | Описание | Тип данных |
---|---|---|
replace | Массив с информацией о параметрах действия, которые нужно заменить на новые. | Массив |
Массив объекта replace
Параметр | Описание | Тип данных |
---|---|---|
target | Объект с информацией о параметрах действия, которые нужно заменить. | Объект |
replacement | Объект с информацией о новых параметрах действия. | Объект |
Параметры объектов target
и replacement
Параметр | Описание | Тип данных |
---|---|---|
field | Идентификатор поля задачи. Полный список полей задачи |
Строка |
value | Значение поля задачи. | Строка |
Заменить все действия макроса на новые. Сохранятся только те поля и значения, которые указаны в массиве.
"fieldChanges": [
{
"field": "tags",
"value": "tag2"
},
...
]
Тело запроса
Параметр | Описание | Тип данных |
---|---|---|
fieldChanges | Объект или массив с информацией о новых настройках действий макроса. | Объект или массив |
Параметры массива fieldChanges
Параметр | Описание | Тип данных |
---|---|---|
field | Идентификатор поля задачи. Полный список полей задачи |
Строка |
value | Значение поля задачи. | Строка |
Удалить действие макроса. Параметр replace
позволяет удалить поле и его значение.
"fieldChanges": {
"remove": [
{
"field": "tags",
"value": "tag2"
},
...
]
}
Тело запроса
Параметр | Описание | Тип данных |
---|---|---|
fieldChanges | Объект с информацией о новых настройках действий макроса. | Объект |
Поле объекта fieldChanges
Параметр | Описание | Тип данных |
---|---|---|
remove | Массив с информацией о полях и значениях действия макроса, которые нужно удалить. | Массив |
Параметры массива remove
Параметр | Описание | Тип данных |
---|---|---|
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": "Тестовый макрос 1",
"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 | Сообщение, которое будет создано при выполнении макроса. Формат: <текст_сообщения>\n<переменная> где:
"body": {"unset":1} |
Строка |
fieldChanges | Массив с информацией о полях задачи, изменения которых запустит макрос. | Массив объектов |
Поля объекта queue
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Строка |
key | Ключ очереди. | Строка |
display | Отображаемое название очереди. | Строка |
Объекты массива fieldChanges
Параметр | Описание | Тип данных |
---|---|---|
field | Объект с информацией о поле задачи. | Объект |
value | Массив со значениями поля задачи. | Массив объектов |
Поля объекта field
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о поле задачи. | Строка |
id | Идентификатор поля задачи. | Строка |
display | Отображаемое название поля задачи. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.