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

Общий формат запросов

Статья создана
Yandex Cloud
  • Методы
  • Заголовки
  • Формат тела запроса
  • Формат текста и переменные
  • Постраничное отображение результатов
  • Примеры запросов

Общий вид запросов к Yandex Tracker API:

<метод> /v2/<resources>/<resource_id>/?<param>=<value>
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
{
   Тело запроса в формате JSON
} 

Примечание

Yandex Tracker API передает и получает параметры даты и времени в часовом поясе UTC±00:00. Поэтому полученные время и дата могут отличаться от часового пояса клиента, с которого выполняется запрос.

Методы

Запросы к Tracker API используют один из HTTP-методов:

GET — получить информацию об объекте или списке объектов;

POST — создать объект;

PATCH — изменить параметры существующего объекта. Запросы, выполненные с помощью метода PATCH изменяют только те параметры, которые явно указаны в теле запроса;

DELETE — удалить объект.

Заголовки

В запросах к Tracker API указывайте заголовки:

  • Host: https://api.tracker.yandex.net

  • Authorization: OAuth <ваш OAuth-токен> — при доступе по протоколу OAuth 2.0.

    Authorization: Bearer <ваш IAM-TOKEN> — при доступе по IAM-токену.

  • X-Org-ID: <идентификатор организации>

    Чтобы узнать идентификатор организации, перейдите на страницу настроек Tracker. Идентификатор указан в поле ID организации для API.

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

В теле запроса передается JSON-объект с идентификаторами изменяемых полей задачи и их значениями.

  • Чтобы добавить или удалить значение из массива, используйте команды add и remove:

    •     {
              "followers": { "add": ["<id сотрудника1>", "<id сотрудника2>"] }
          }
      

    Команда add добавляет новые значения в массив. Чтобы перезаписать массив (удалить старые значения и добавить новые), используйте команду set.

  • Чтобы обнулить значение поля, укажите значение null. Чтобы обнулить массив, используйте пустой массив []. Отдельные значения в массиве можно изменить с помощью команд target и replacement:

    • {"followers": null}
    •   {
          "followers": {
            "replace": [
                {"target": "<идентификатор1>", "replacement": "<идентификатор2>"},
                {"target": "<идентификатор3>", "replacement": "<идентификатор4>"}]
          }
        }
      
  • Например, чтобы изменить тип задачи на Ошибка, используйте один из способов:

    • {"type": 1}
    • {"type": "bug"}
    •   {
            "type": { "id": "1" }
        }
      
    •   {
            "type": { "name": "Ошибка" }
        }
      
    •   {
            "type": {"set": "bug"}
        }
      

Формат текста и переменные

При работе с запросами на создание или редактирование комментариев, макросов, триггеров и автодействий используйте специальный формат для оформления текста сообщения:

  • Чтобы отформатировать текст, используйте разметку Yandex Flavored Markdown.
  • Чтобы добавить перенос строки, используйте символ \n.
  • Чтобы добавить значения из полей задачи, используйте переменные.

Постраничное отображение результатов

Если вы запрашиваете список объектов, и количество строк в ответе больше 50, в ответе возвращается страница с указанным количеством результатов. Вы можете выполнить несколько запросов для просмотра последующих страниц. Для этого используется механизм постраничного отображения результатов.

При постраничном отображении результаты запроса рассчитываются каждый раз при отображении новой страницы. Таким образом, если за время просмотра одной страницы в результатах запроса произошли изменения, это может повлиять на отображение следующих страниц. Например, по запросу найдено 11 задач, из которых отображено 10. В процессе просмотра результатов первой страницы одна из задач была изменена и перестала отвечать требованиям поискового запроса. В этом случае, при запросе второй страницы результатов будет возвращен пустой массив, так как оставшиеся 10 задач будут находиться на первой странице.

Для постраничного отображения результатов используйте в запросе следующие параметры:

  • perPage (необязательный)

    Количество объектов (задач, очередей и пр.) на странице. Значение по умолчанию — 50.

  • page (необязательный)

    Номер страницы ответа. Значение по умолчанию — 1.

В ответе будут содержаться следующие заголовки:

  • X-Total-Pages

    Общее количество страниц с записями.

  • X-Total-Count

    Общее число записей в ответе.

Примеры запросов

Пример 1: Изменить название, описание, тип и приоритет задачи.
  • Используется HTTP-метод PATCH.
  • Редактируется задача TEST-1.
  • Новый тип задачи: Ошибка.
  • Новый приоритет задачи: Низкий.
PATCH /v2/issues/TEST-1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

{
  "summary": "Новое название задачи",
  "description": "Новое описание задачи",
  "type": {
      "id": "1",
      "key": "bug"
      },
  "priority": {
      "id": "2",
      "key": "minor"
      }
}
Пример 2: Запрос одной задачи с указанием необходимых полей.
  • Используется HTTP-метод GET.
  • В ответе включено отображение приложений.
GET /v2/issues/JUNE-3?expand=attachments
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>
Пример 3: Создать задачу.
  • Используется HTTP-метод POST.
  • Создается задача с названием Test Issue в очереди с ключом TREK.
  • Новая задача является подзадачей JUNE-2.
  • Тип создаваемой задачи – Ошибка.
  • Исполнитель задачи – <user_login>
POST /v2/issues/ HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

{
  "queue": "TREK",
  "summary": "Test Issue",
  "parent":"JUNE-2",
  "type": "bug",
  "assignee": "<user_login>",
  "attachmentIds": [55, 56]
}
Пример 4: Найти задачи очереди, которые назначены на заданного сотрудника. Результаты отобразить постранично.
  • Используется HTTP-метод POST.
  • Ключ очереди – TREK.
  • Исполнитель задачи – <user_login>.
POST /v2/issues/_search?perPage=15
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

{
  "filter": {
    "queue": "TREK",
    "assignee": "<user_login>"
  }
}

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • Методы
  • Заголовки
  • Формат тела запроса
  • Формат текста и переменные
  • Постраничное отображение результатов
  • Примеры запросов