Tracker
Статья создана
Обновлена 26 февраля 2025 г.
- Organization
- TrackerGetIssue
- TrackerCreateIssue
- TrackerUpdateIssue
- TrackerUpdateIssue.Action
- TrackerUpdateIssue.AdditionalProperties
- InterpolatableMap
- MapValue
- TrackerListIssues
- TrackerLinkIssues.SearchOptionsFilter
- TrackerLinkIssues
- TrackerUpdateIssueStatus
- TrackerCreateComment
- TrackerUpdateComment
- TrackerListComments
Обращение к Yandex Tracker API. Поля getIssue, createIssue, updateIissue, listIssues, linkIssues, updateIssueStatus, createComment, updateComment и listComments — взаимоисключающие.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
endpoint |
string |
Нет | api.tracker.yandex.net |
Да | Хост для вызова Yandex Tracker API. |
oauthToken |
string |
Да | Нет | Да | OAuth-токен, который будет использоваться для авторизации при обращении к Tracker API. |
organization |
Organization | Да | Нет | Нет | Идентификатор организации. Подробнее см. в документации Tracker. |
getIssue |
TrackerGetIssue | Нет | Нет | Нет | Описание действия получения задачи. |
createIssue |
TrackerCreateIssue | Нет | Нет | Нет | Описание действия создания задачи. |
updateIissue |
TrackerUpdateIssue | Нет | Нет | Нет | Описание действия редактирования задачи. |
listIssues |
TrackerListIssues | Нет | Нет | Нет | Описание действия поиска задачи. |
linkIssues |
TrackerLinkIssues | Нет | Нет | Нет | Описание действия добавления связи между задачами. |
updateIssueStatus |
TrackerUpdateIssueStatus | Нет | Нет | Нет | Описание действия обновления статуса задачи. |
createComment |
TrackerCreateComment | Нет | Нет | Нет | Описание действия создания комментария. |
updateComment |
TrackerUpdateComment | Нет | Нет | Нет | Описание действия обновления комментария. |
listComments |
TrackerListComments | Нет | Нет | Нет | Описание действия отображения комментариев к задаче. |
Organization
Поля yandexOrganizationId и cloudOrganizationId — взаимоисключающие.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
yandexOrganizationId |
string |
Нет | Нет | Да | Идентификатор организации Яндекс 360 для бизнеса. |
cloudOrganizationId |
string |
Нет | Нет | Да | Идентификатор организации Yandex Cloud Organization. |
TrackerGetIssue
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
key |
string |
Да | Нет | Да | Ключ задачи. |
TrackerCreateIssue
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
queue |
string |
Да | Нет | Да | Очередь, в которой будет создана задача. |
title |
string |
Да | Нет | Да | Заголовок задачи. |
parent |
string |
Нет | Нет | Да | Ключ родительской задачи. |
description |
string |
Нет | Нет | Да | Описание задачи. |
sprints |
string |
Нет | Нет | Да | Один или несколько спринтов. Значение может быть задано в виде строки или JSON-массива. |
type |
string |
Нет | Нет | Да | Тип задачи. |
priority |
string |
Нет | Нет | Да | Приоритет задачи. |
followers |
string |
Нет | Нет | Да | Один или несколько наблюдателей. Значение может быть задано в виде строки или JSON-массива. |
assignee |
string |
Нет | Нет | Да | Исполнитель задачи. |
author |
string |
Нет | Нет | Да | Автор задачи. |
additionalProperties |
map[string]string |
Нет | Нет | Да | Дополнительные поля задачи. |
TrackerUpdateIssue
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
key |
string |
Да | Нет | Да | Ключ задачи. |
title |
string |
Нет | Нет | Да | Заголовок задачи. |
parent |
string |
Нет | Нет | Да | Ключ родительской задачи. |
description |
string |
Нет | Нет | Да | Описание задачи. |
sprints |
TrackerUpdateIssue.Action | Нет | Нет | Да | Связанные спринты. |
type |
string |
Нет | Нет | Да | Тип задачи. |
priority |
string |
Нет | Нет | Да | Приоритет задачи. |
followers |
TrackerUpdateIssue.Action | Нет | Нет | Да | Наблюдатели в задаче. |
additionalProperties |
TrackerUpdateIssue.AdditionalProperties | Нет | Нет | Да | Дополнительные поля задачи. |
TrackerUpdateIssue.Action
Поля setValue, addValuesList, removeValuesList и replaceValuesMap — взаимоисключающие.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
setValue |
string |
Нет | Нет | Да | Заменяет собой значение поля задачи. Значение может быть задано в виде строки или JSON-массива. |
addValuesList |
string |
Нет | Нет | Да | Добавляет одно или несколько значений в поле задачи. Значение может быть задано в виде строки или JSON-массива. |
removeValuesList |
string |
Нет | Нет | Да | Удаляет одно или несколько значений из поля задачи. Значение может быть задано в виде строки или JSON-массива. |
replaceValuesMap |
InterpolatableMap | Нет | Нет | Нет | Описывает список значений поля, которые нужно заменить, и их новые значения. |
TrackerUpdateIssue.AdditionalProperties
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
pairs |
map[string]TrackerUpdateIssue.Action |
Нет | Нет | Да | Словарь, состоящий из пар: название дополнительного поля и действие, которое необходимо над ним выполнить. |
InterpolatableMap
Поля json и plainValue — взаимоисключающие.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
json |
string |
Нет | Нет | Да | Словарь, содержащий JSON-массив пар текущих и новых значений изменяемых полей. |
plainValue |
MapValue | Нет | Нет | Нет | Словарь, содержащий массив пар текущих и новых значений изменяемых полей в формате объекта MapValue. |
MapValue
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
pairs |
map[string]string |
Да | Нет | Да | Словарь, содержащий массив пар текущих и новых значений изменяемых полей. |
TrackerListIssues
Поля queue, keys, filter и query — взаимоисключающие.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
pageSize |
string |
Нет | Нет | Да | Максимальное количество задач, которые будут содержаться в ответе. |
pageNumber |
string |
Нет | Нет | Да | Номер страницы в выдаче списка задач. Подробнее см. в разделе Общий формат запросов. |
queue |
string |
Нет | Нет | Да | Очередь, в которой требуется найти задачи. |
keys |
string |
Нет | Нет | Да | Ключи задач, которые требуется найти. Значение может быть задано в виде строки или JSON-массива. |
filter |
TrackerLinkIssues.SearchOptionsFilter | Нет | Нет | Да | Фильтр для поиска задач по значениям полей. |
query |
string |
Нет | Нет | Да | Фильтр на языке запросов. |
TrackerLinkIssues.SearchOptionsFilter
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
issueProperties |
map[string]string |
Да | Нет | Да | Поля, по которым необходимо выполнить поиск, и требуемые значения. |
order |
string |
Нет | Нет | Да | Направление и поле сортировки задач. Подробнее см. в разделе Найти задачи. |
TrackerLinkIssues
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
key |
string |
Да | Нет | Да | Ключ задачи. |
linkKey |
string |
Да | Нет | Да | Ключ задачи, которую нужно связать с задачей, заданной в поле key. |
relationship |
string |
Да | Нет | Да | Тип связи между задачами. |
TrackerUpdateIssueStatus
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
key |
string |
Да | Нет | Да | Ключ задачи, для которой нужно изменить статус. |
transition |
string |
Да | Нет | Да | Идентификатор перехода. |
additionalProperties |
MapValue | Нет | Нет | Да | Дополнительные поля, необходимые для выполнения перехода. |
TrackerCreateComment
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
key |
string |
Да | Нет | Да | Ключ задачи, в которую необходимо добавить комментарий. |
text |
string |
Да | Нет | Да | Текст комментария. |
mentions |
string |
Нет | Нет | Да | Упоминания пользователей. Значение может быть задано в виде строки или JSON-массива. |
TrackerUpdateComment
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
id |
string |
Да | Нет | Да | Идентификатор обновляемого комментария. |
issueKey |
string |
Да | Нет | Да | Ключ задачи, к которой относится комментарий. |
text |
string |
Да | Нет | Да | Новый текст комментария. |
TrackerListComments
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
key |
string |
Да | Нет | Да | Ключ задачи. |
lastCommentId |
string |
Нет | Нет | Да | Значение параметра id у комментария, после которого начнется запрашиваемая страница. Подробнее см. в разделе Получить комментарии к задаче. |
pageSize |
string |
Нет | Нет | Да | Максимальное количество комментариев в ответе. |