Редактировать макрос

Запрос позволяет изменить параметры макроса.

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

Чтобы изменить параметры макроса, используйте HTTP-запрос с методом PATCH:

PATCH/v2/queues/<queue-id>/macros/<macros-id>
Host:https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации> 


{
  "name": "Тестовый макрос 1",
  "body": "Тестовый комментарий\n{{currentDateTime}}\n{{issue.author}}",
  "fieldChanges": <Объект или массив>
}

Ресурс

<queue-id>: Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов.

<macros-id>: Идентификатор макроса.

Заголовки

Host

Адрес узла, предоставляющего API:

https://api.tracker.yandex.net

Authorization

OAuth-токен в формате OAuth <значение токена>, например:

OAuth 0c4181a7c2cf4521964a72ff57a34a07

X-Org-ID: Идентификатор организации.

Тело запроса

Тело запроса содержит измененные параметры макроса.


Параметр	Описание	Тип данных
`name`	Название макроса.	Строка.
`body`	Сообщение, которое будет создано при выполнении макроса. Формат: `<Текст сообщение>\n<переменная>` где: `<Текст сообщения>`— текст, который будет создан в поле Комментарий при выполнении макроса. `\n` — символ переноса строки. Переменная, которая может содержать:`{{currentUser}}` — имя пользователя, который выполнил макрос; `{{currentDateTime.date}}` — дату выполнения макроса; `{{currentDateTime}}` — дату и время выполнения макроса; `{{issue.<ключ_поля>}}` — ключ поля задачи, значение которого отразится в сообщении. Полный список полей задачи: https://tracker.yandex.ru/admin/fields Чтобы удалить сообщение, используйте конструкцию `"body": { "unset":1 }`	Строка.
`fieldChanges`	Объект или массив с информацией о новых настройках действий макроса. Структура объекта отличается в зависимости от типа изменений.	Объект или массив.


Параметр	Описание	Тип данных
`name`	Название макроса.	Строка.
`body`	Сообщение, которое будет создано при выполнении макроса. Формат: `<Текст сообщение>\n<переменная>` где: `<Текст сообщения>`— текст, который будет создан в поле Комментарий при выполнении макроса. `\n` — символ переноса строки. Переменная, которая может содержать:`{{currentUser}}` — имя пользователя, который выполнил макрос; `{{currentDateTime.date}}` — дату выполнения макроса; `{{currentDateTime}}` — дату и время выполнения макроса; `{{issue.<ключ_поля>}}` — ключ поля задачи, значение которого отразится в сообщении. Полный список полей задачи: https://tracker.yandex.ru/admin/fields Чтобы удалить сообщение, используйте конструкцию `"body": { "unset":1 }`	Строка.
`fieldChanges`	Объект или массив с информацией о новых настройках действий макроса. Структура объекта отличается в зависимости от типа изменений.	Объект или массив.

Структура объекта fieldChanges

Добавить действие макроса. Параметр add позволяет добавить поле и его значение в список имеющихся.

"fieldChanges": {
      "add": [
               {
          "field": "tags", 
          "value": "tag2"
               },
                ...
              ]

Тело запроса


Параметр	Описание	Тип данных
`fieldChanges`	Объект с информацией о новых настройках действий макроса.	Объект.
Объект массива `fieldChanges`
`add`	Массив с информацией о параметрах нового действия макроса.	Массив.
Объекты массива `add`
`field`	Идентификатор поля задачи. Полный список полей задачи: https://tracker.yandex.ru/admin/fields	Строка.
`value`	Значение поля задачи.	Строка.


Параметр	Описание	Тип данных
`fieldChanges`	Объект с информацией о новых настройках действий макроса.	Объект.
Объект массива `fieldChanges`
`add`	Массив с информацией о параметрах нового действия макроса.	Массив.
Объекты массива `add`
`field`	Идентификатор поля задачи. Полный список полей задачи: https://tracker.yandex.ru/admin/fields	Строка.
`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`	Идентификатор поля задачи. Полный список полей задачи: https://tracker.yandex.ru/admin/fields	Строка.
`value`	Значение поля задачи.	Строка.


Параметр	Описание	Тип данных
`fieldChanges`	Объект с информацией о новых настройках действий макроса.	Объект.
Параметры объекта `fieldChanges`
`replace`	Массив с информацией о параметрах действия, которые нужно заменить на новые.	Массив.
Массив объекта `replace`
`target`	Объект с информацией о параметрах действия, которые нужно заменить.	Объект.
`replacement`	Объект с информацией о новых параметрах действия.	Объект.
Параметры объектов `target` и `replacement`
`field`	Идентификатор поля задачи. Полный список полей задачи: https://tracker.yandex.ru/admin/fields	Строка.
`value`	Значение поля задачи.	Строка.

Заменить все действия макроса на новые. Сохранятся только те поля и значения, которые указаны в массиве.

"fieldChanges": [
                          {
             "field": "tags", 
             "value": "tag2"
                          },
                          ...
]

Тело запроса


Параметр	Описание	Тип данных
`fieldChanges`	Объект или массив с информацией о новых настройках действий макроса.	Объект или массив.
Параметры массива `fieldChanges`
`field`	Идентификатор поля задачи. Полный список полей задачи: https://tracker.yandex.ru/admin/fields	Строка.
`value`	Значение поля задачи.	Строка.


Параметр	Описание	Тип данных
`fieldChanges`	Объект или массив с информацией о новых настройках действий макроса.	Объект или массив.
Параметры массива `fieldChanges`
`field`	Идентификатор поля задачи. Полный список полей задачи: https://tracker.yandex.ru/admin/fields	Строка.
`value`	Значение поля задачи.	Строка.

Удалить действие макроса. Параметр replace позволяет удалить поле и его значение.

"fieldChanges": {
         "remove": [ 
                    {
                  "field": "tags", 
                  "value": "tag2"
                     },
                      ...
                    ]
}

Тело запроса


Параметр	Описание	Тип данных
`fieldChanges`	Объект с информацией о новых настройках действий макроса.	Объект.
Поле объекта `fieldChanges`
`remove`	Массив с информацией о полях и значениях действия макроса, которые нужно удалить.	Массив.
Параметры массива `remove`
`field`	Идентификатор поля задачи. Полный список полей задачи: https://tracker.yandex.ru/admin/fields	Строка.
`value`	Значение поля задачи.	Строка.


Параметр	Описание	Тип данных
`fieldChanges`	Объект с информацией о новых настройках действий макроса.	Объект.
Поле объекта `fieldChanges`
`remove`	Массив с информацией о полях и значениях действия макроса, которые нужно удалить.	Массив.
Параметры массива `remove`
`field`	Идентификатор поля задачи. Полный список полей задачи: https://tracker.yandex.ru/admin/fields	Строка.
`value`	Значение поля задачи.	Строка.

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит 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<переменная>` где: `<Текст сообщения>`— текст, который будет создан в поле Комментарий при выполнении макроса. `\n` — символ переноса строки. Переменная, которая может содержать:`{{currentUser}}` — имя пользователя, который выполнил макрос; `{{currentDateTime.date}}` — дату выполнения макроса; `{{currentDateTime}}` — дату и время выполнения макроса; `{{issue.<ключ_поля>}}` — ключ поля задачи, значение которого отразится в сообщении. Полный список полей задачи: https://tracker.yandex.ru/admin/fields Чтобы удалить сообщение, используйте конструкцию `"body": { "unset":1 }`	Строка.
`fieldChanges`	Массив с информацией о полях задачи, изменения которых запустит макрос.	Массив объектов.
Поля объекта `queue`
`self`	Адрес ресурса API, который содержит информацию об очереди.	Строка.
`id`	Идентификатор очереди.	Строка.
`key`	Ключ очереди.	Строка.
`display`	Отображаемое название очереди.	Строка.
Объекты массива `fieldChanges`
`field`	Объект с информацией о поле задачи.	Объект.
`value`	Массив со значениями поля задачи.	Массив объектов.
Поля объекта `field`
`self`	Адрес ресурса API, который содержит информацию о поле задачи.	Строка.
`id`	Идентификатор поля задачи.	Строка.
`display`	Отображаемое название поля задачи.	Строка.


Параметр	Описание	Тип данных
`self`	Адрес ресурса API, который содержит параметры макроса.	Строка.
`id`	Идентификатор макроса.	Число.
`queue`	Объект с информацией об очереди, к задачам которой применяется макрос.	Объект.
`name`	Название макроса.	Строка.
`body`	Сообщение, которое будет создано при выполнении макроса. Формат: `<Текст сообщение>\n<переменная>` где: `<Текст сообщения>`— текст, который будет создан в поле Комментарий при выполнении макроса. `\n` — символ переноса строки. Переменная, которая может содержать:`{{currentUser}}` — имя пользователя, который выполнил макрос; `{{currentDateTime.date}}` — дату выполнения макроса; `{{currentDateTime}}` — дату и время выполнения макроса; `{{issue.<ключ_поля>}}` — ключ поля задачи, значение которого отразится в сообщении. Полный список полей задачи: https://tracker.yandex.ru/admin/fields Чтобы удалить сообщение, используйте конструкцию `"body": { "unset":1 }`	Строка.
`fieldChanges`	Массив с информацией о полях задачи, изменения которых запустит макрос.	Массив объектов.
Поля объекта `queue`
`self`	Адрес ресурса API, который содержит информацию об очереди.	Строка.
`id`	Идентификатор очереди.	Строка.
`key`	Ключ очереди.	Строка.
`display`	Отображаемое название очереди.	Строка.
Объекты массива `fieldChanges`
`field`	Объект с информацией о поле задачи.	Объект.
`value`	Массив со значениями поля задачи.	Массив объектов.
Поля объекта `field`
`self`	Адрес ресурса API, который содержит информацию о поле задачи.	Строка.
`id`	Идентификатор поля задачи.	Строка.
`display`	Отображаемое название поля задачи.	Строка.

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


HTTP-код ошибки	Описание ошибки
`400 Bad Request`	Один из параметров запроса имеет недопустимое значение или формат данных.
`403 Forbidden`	У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
`404 Not Found`	Запрашиваемый ресурс не найден.
`422 Unprocessable Entity`	Ошибка валидации JSON, запрос отклонен.
`500 Internal Server Error`	Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
`503 Service Unavailable`	Сервис API временно недоступен.


HTTP-код ошибки	Описание ошибки
`400 Bad Request`	Один из параметров запроса имеет недопустимое значение или формат данных.
`403 Forbidden`	У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
`404 Not Found`	Запрашиваемый ресурс не найден.
`422 Unprocessable Entity`	Ошибка валидации JSON, запрос отклонен.
`500 Internal Server Error`	Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
`503 Service Unavailable`	Сервис API временно недоступен.