Связаться с намиПодключиться

Получить связи задачи

Статья создана
Обновлена 26 августа 2024 г.

Запрос позволяет получить информацию о связях задачи. Задача выбирается при указании идентификатора или ключа задачи.

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

Перед выполнением запроса получите доступ к API.

Для получения списка связей задачи используйте HTTP-запрос с методом GET:

GET /v2/issues/<ключ_или_идентификатор_задачи>/links
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

  • 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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_задачи> Идентификатор или ключ текущей задачи. Строка

Запрос связей задачи:

  • Используется HTTP-метод GET.
GET /v2/issues/JUNE-2/links HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

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

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит результаты в формате JSON.

[
    {
        "self": "https://api.tracker.yandex.net/v2/issues/JUNE-2/links/47*****",
        "id": 47*****,
        "type": {
            "self": "https://api.tracker.yandex.net/v2/linktypes/subtask",
            "id": "subtask",
            "inward": "Подзадача",
            "outward": "Родительская задача"
        },
        "direction": "outward",
        "object": {
            "self": "https://api.tracker.yandex.net/v2/issues/TREK-9844",
            "id": "593cd211ef7e8a33********",
            "key": "TREK-9844",
            "display": "subtask"
        },
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Иван Иванов"
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Иван Иванов"
        },
        "createdAt": "2017-06-11T05:16:01.421+0000",
        "updatedAt": "2017-06-11T05:16:01.421+0000",
        "assignee": {
            "self": "https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Иван Иванов"
        },
        "status": {
            "self": "https://api.tracker.yandex.net/v2/statuses/1",
            "id": "1",
            "key": "open",
            "display": "Открыт"
        }
    },
    ...
]

Параметры ответа

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о связи. Строка
id Идентификатор связи. Число
type Блок с информацией о типе связи. Объект
direction Тип связи задачи, указанной в запросе, по отношению к задаче в поле object. Возможны следующие значения:
  • outward — задача, указанная в запросе, является основной для задачи в поле object.
  • inward — задача в поле object является основной для задачи, указанной в запросе.
 Строка
object Блок с информацией о связанной задаче. Объект
createdBy Блок с информацией о создателе связи. Объект
updatedBy Блок с информацией о последнем изменившем связанную задачу пользователе. Объект
createdAt Дата и время создания связи. Строка
updatedAt Дата и время изменения связи. Строка
assignee Исполнитель связанной задачи. Объект
status Статус связанной задачи. Объект

Поля объекта type

Параметр Описание Тип данных
self Ссылка на тип связи. Строка
id Идентификатор типа связи. Строка
inward Название типа связи задачи в поле object по отношению к задаче, указанной в запросе. Строка
outward Название типа связи задачи, указанной в запросе, по отношению к задаче в поле object. Строка

Поля объекта object

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о задаче. Строка
id Идентификатор задачи. Строка
key Ключ задачи. Строка
display Отображаемое название задачи. Строка

Поля объекта createdBy

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число

Поля объекта updatedBy

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число

Поля объекта assignee

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число

Поля объекта status

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о статусе. Строка
id Идентификатор статуса. Строка
key Ключ статуса. Строка
display Отображаемое название статуса. Строка

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
Предыдущая
Связать задачи
Следующая
Удалить связь с задачей