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

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

GET

https://api.tracker.yandex.net/v3/issues/<id_задачи>/links

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

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

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

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

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

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

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

    • если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок X-Org-ID,

    • если к Трекеру привязана организация Yandex Cloud Organization, используйте заголовок X-Cloud-Org-ID.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
<id_задачи> Идентификатор или ключ текущей задачи. Строка

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

  • Используется HTTP-метод GET.
GET  https://api.tracker.yandex.net/v3/issues/JUNE-2/links

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

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

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

[
    {
        "self": "https://api.tracker.yandex.net/v3/issues/JUNE-2/links/47*****",
        "id": 47*****,
        "type": {
            "self": "https://api.tracker.yandex.net/v3/linktypes/subtask",
            "id": "subtask",
            "inward": "Подзадача",
            "outward": "Родительская задача"
        },
        "direction": "outward",
        "object": {
            "self": "https://api.tracker.yandex.net/v3/issues/TREK-9844",
            "id": "593cd211ef7e8a33********",
            "key": "TREK-9844",
            "display": "subtask"
        },
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия"
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v3/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/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия"
        },
        "status": {
            "self": "https://api.tracker.yandex.net/v3/statuses/1",
            "id": "1",
            "key": "open",
            "display": "Открыт"
        }
    },
    ...
]

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

Параметр

Описание

Тип данных

self

Адрес ресурса API, который содержит информацию о связи

Строка

id

Идентификатор связи

Число

type

Блок с информацией о типе связи

Объект

direction

Тип связи задачи, указанной в запросе, по отношению к задаче в поле object. Возможны следующие значения:

  • outward — задача, указанная в запросе, является основной для задачи в поле object;
  • inward — задача в поле object является основной для задачи, указанной в запросе

Строка

object

Блок с информацией о связанной задаче

Объект

createdBy

Блок с информацией о создателе связи

Объект

updatedBy

Блок с информацией о последнем изменившем связанную задачу пользователе

Объект

createdAt

Дата и время создания связи

Строка

updatedAt

Дата и время изменения связи

Строка

assignee

Исполнитель связанной задачи

Объект

status

Статус связанной задачи

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

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

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

Поля объектов createdBy, updatedBy, assignee

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

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

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

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

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