Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Tracker
  • Начало работы
    • Подключить Tracker
    • Настроить Tracker
    • Как работать в Tracker
      • Войти в Tracker
      • Начальная страница
      • Мои задачи
      • Как работать с задачей
      • Избранные задачи, доски, дашборды
      • Персональные настройки
    • Мигрировать в Tracker
    • Отключить платные услуги
  • Сценарии использования
    • Настроить Tracker для команды разработки
      • Обзор
      • Создать очередь для команды разработки
      • Структурировать задачи
      • Использовать гибкие методологии (Agile)
      • Настроить шаблоны задач
      • Подключить репозиторий
      • Автоматизировать рутинные действия
      • Интегрировать Tracker с другими системами
    • Настроить Tracker для службы поддержки
      • Обзор
      • Создать очередь для службы поддержки
      • Принимать обращения через форму
      • Настроить многоуровневую структуру поддержки
      • Группировать обращения по темам
      • Отслеживать время обработки обращений
      • Собирать статистику по обращениям
      • Настроить интеграцию со сторонними системами
  • Концепции
    • Обзор сервиса
    • Основные понятия
  • Настроить очередь
    • Обзор
    • Создать очередь
    • Шаблоны очередей
    • Просмотреть задачи очереди
    • Изменить основные параметры очереди
    • Настроить типы и статусы задач
      • Обзор
      • Настроить типы задач
      • Создать воркфлоу
      • Настроить статусы
      • Настроить переходы
      • Добавить типы задач, статусы, резолюции
        • Создать тип задачи
        • Создать статус
        • Создать резолюцию
    • Локальные поля задач
    • Добавить команду очереди
    • Настроить доступ к очереди
    • Расширенные возможности очереди
    • Посмотреть историю изменений очереди
    • Удалить очередь
  • Работать с задачами
    • Создать задачу
      • Обзор
      • Клонировать задачу
    • Редактировать задачу
      • Обзор
      • Добавить комментарии к задаче
      • Форматировать текст в задаче
      • Изменить связи задачи
      • Выполнить макрос
      • Изменить несколько задач
    • Создать чеклист
    • Настроить напоминание о задаче
    • Отметить затраченное время
    • Добавить поле задачи
    • Посмотреть историю изменений задачи
    • Проголосовать за задачу
    • Получить доступ к задаче
    • Удалить задачу
  • Структурировать задачи
    • Обзор
    • Связи между задачами
    • Проекты
    • Компоненты
    • Версии
  • Инструменты гибкой разработки
    • Обзор
    • Создать доску
    • Работать с доской
    • Изменить и удалить доску
    • Спринты
    • Эпики
    • Командная оценка задач
    • Диаграмма сгорания задач
  • Найти задачи
    • Обзор
    • Найти мои задачи
    • Найти задачи в очереди
    • Создать фильтр задач
    • Язык запросов
  • Уведомления и подписки
    • Обзор
    • Подписаться на уведомления
    • Получать отчет об изменениях
    • Подписать пользователей на изменения очереди
    • Настройки уведомлений
      • Обзор
      • Уведомления о ваших задачах
      • Уведомления о ваших подписках
  • Статистика и дашборды
    • Дашборды
      • Обзор
      • Как создать дашборд
      • Виджеты
      • Как изменить дашборд
      • Общий доступ к дашбордам
      • Как сделать дашборд начальной страницей
    • Статистика очереди
    • Диаграмма Гантта
  • Автоматизация и шаблоны
    • Обзор
    • Триггеры
      • Обзор
      • Создать триггер
      • Задать условие срабатывания триггера
      • Настроить действие триггера
      • Изменить и удалить триггер
      • Примеры
    • Автодействия
      • Обзор
      • Автоматическое обновление задач
      • Создание задач по расписанию
      • Изменить и удалить автодействие
    • Макросы
    • Шаблоны
      • Обзор
      • Создать шаблон
      • Изменить шаблон
      • Удалить шаблон
      • Использовать общие шаблоны
  • Настроить SLA для задач
    • Обзор
    • Настроить правила
    • Графики работы
  • Интеграция с другими сервисами
    • Формы
    • Вики
    • Мессенджеры
      • Обзор
      • Slack
      • Telegram
  • Инструменты разработчика
    • Плагин для IDE
    • API
    • Python клиент
    • Подключить репозиторий
  • Правила тарификации
  • Справочник API
    • Обзор
    • Доступ к API
    • Задачи
      • Получить параметры задачи
      • Редактировать задачу
      • Создать задачу
      • Перенести задачу в другую очередь
      • Узнать количество задач
      • Найти задачи
      • Освободить ресурсы просмотра прокрутки
      • Получить приоритеты
      • Получить связи задачи
      • Связать задачи
      • Получить переходы
      • Выполнить переход в статус
      • Получить историю изменений задачи
    • Чеклисты
      • Создать чеклист или добавить в него пункты
      • Получить параметры чеклиста
      • Редактировать чеклист
      • Удалить чеклист
    • Проекты
      • Создать проект
      • Получить параметры проекта
      • Получить список всех проектов
      • Получить список очередей проекта
      • Изменить проект
      • Удалить проект
    • Комментарии
      • Добавить комментарий
      • Получить комментарии к задаче
      • Редактировать комментарий
      • Удалить комментарий
    • Макросы
      • Получить макросы очереди
      • Получить макрос
      • Создать макрос
      • Редактировать макрос
      • Удалить макрос
    • Прикрепленные файлы
      • Получить список прикрепленных файлов
      • Скачать файл
      • Скачать миниатюру
      • Прикрепить файл
      • Загрузить временный файл
      • Удалить файл
    • Очереди
      • Создать очередь
      • Получить параметры очереди
      • Получить список очередей
      • Получить версии очереди
      • Получить обязательные поля очереди
      • Удалить очередь
      • Восстановить очередь
      • Удалить тег из очереди
    • Доски задач
      • Получить параметры всех досок
      • Получить параметры доски
      • Создать доску
      • Редактировать доску
      • Удалить доску
      • Колонки
        • Получить параметры всех колонок
        • Получить параметры колонки
        • Создать колонку
        • Редактировать колонку
        • Удалить колонку
      • Спринты
        • Получить все спринты доски
        • Получить спринт
        • Создать спринт
    • Импорт
      • Импортировать задачу
      • Импортировать файлы
      • Импортировать комментарии
      • Импортировать связи
    • Пакетные операции
      • Массовый перенос задач в другую очередь
      • Массовое редактирование задач
      • Массовое изменение статуса задач
    • Учет времени
      • Добавить запись о затраченном времени
      • Редактировать запись о затраченном времени
      • Удалить запись о затраченном времени
      • Получить записи о затраченном времени
        • Получить все записи по задаче
        • Отобрать записи по параметрам
    • Поля задачи
      • Получить параметры поля задачи
      • Изменить название поля задачи
      • Изменить возможные значения поля задачи
      • Создать категорию поля задачи
      • Локальные поля
        • Создать локальное поле очереди
        • Получить локальные поля очереди
        • Получить информацию о локальном поле очереди
        • Редактировать локальное поле очереди
    • Получить информацию о текущем пользователе
    • Возможные коды ответа
  • Вопросы и ответы
  • Служба поддержки
  1. Справочник API
  2. Макросы
  3. Создать макрос

Создать макрос

  • Формат запроса
  • Формат ответа

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

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

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

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

{
  "name": "Тестовый макрос",
  "body": "Тестовый комментарий\n{{currentDateTime}}\n{{issue.author}}",
  "fieldChanges": [
    {
      "field": "tags",
      "value": "tag1"
    }, 
     ...
  ]
}

Ресурс

  • <issue-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 Массив с информацией о полях задачи, изменения которых запустит макрос. Массив объектов.

Объекты массива fieldChanges

Параметр Описание Тип данных
field Идентификатор поля задачи.

Полный список полей задачи
Строка.
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": "Тестовый макрос",
    "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 Отображаемое название поля задачи. Строка.

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

HTTP-код ошибки Описание ошибки
400 Bad Request Один из параметров запроса имеет недопустимое значение или формат данных.
403 Forbidden У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
404 Not Found Запрашиваемый ресурс не найден.
409 Conflict Запрос не может быть выполнен по причине конфликта имен.
422 Unprocessable Entity Ошибка валидации JSON, запрос отклонен.
500 Internal Server Error Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503 Service Unavailable Сервис API временно недоступен.
В этой статье:
  • Формат запроса
  • Формат ответа
Language / Region
Вакансии
Политика конфиденциальности
Условия использования
Брендбук
© 2021 ООО «Яндекс.Облако»