Получить связи задачи с пагинацией

Запрос позволяет получить страницу списка связей задачи с помощью HTTP-метода POST.

POST

https://api.tracker.yandex.net/v3/issues/{id_задачи}/links/_list?page=PAGE&perPage=ITEMS_PER_PAGE

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

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

Чтобы получить список связей, используйте HTTP-запрос с методом POST. В теле запроса передайте JSON-объект:

POST /v3/issues/{id_задачи}/links/_list?page=PAGE&perPage=ITEMS_PER_PAGE
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ

{
    "fields": [],
    "linkTypes": [
        "relates"
    ]
}
Заголовки
  • Host: адрес узла, предоставляющего API.

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

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

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

  • Content-Type: формат тела запроса. Должен иметь значение application/json.

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

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

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

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

Ресурс
Параметр Описание Тип данных
id_задачи Идентификатор или ключ текущей задачи. Строка
Параметры запроса
Параметр Описание Тип данных
page Номер страницы ответа. Число
perPage Количество связей на странице ответа. Число
Параметры тела запроса
Параметр Описание Тип данных
fields Поля, которые нужно включить в ответ. Массив строк
linkTypes Идентификаторы типов связей, которые нужно включить в ответ. Массив строк

Пример: Получить список связей задачи

POST https://api.tracker.yandex.net/v3/issues/JUNE-2/links/_list?page=1&perPage=20
Content-Type: application/json

{
    "fields": [],
    "linkTypes": ["relates"]
}

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

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

Тело ответа содержит объект с массивом links.

{
    "links": [
        {
            "self": "https://api.tracker.yandex.net/v3/issues/JUNE-2/links/47001",
            "id": 47001,
            "type": {
                "self": "https://api.tracker.yandex.net/v3/linktypes/relates",
                "id": "relates",
                "inward": "relates",
                "outward": "relates"
            },
            "direction": "outward",
            "object": {
                "self": "https://api.tracker.yandex.net/v3/issues/TREK-9844",
                "id": "593cd211ef7e8a33********",
                "key": "TREK-9844",
                "display": "Related issue"
            },
            "createdAt": "2017-06-11T05:16:01.421+0000",
            "updatedAt": "2017-06-11T05:16:01.421+0000"
        }
    ]
}

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

Параметр Описание Тип данных
links Массив объектов со связями задачи. Массив объектов

Параметр

Описание

Тип данных

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 Identity Hub. Строка

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

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