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

Получить связи сущности

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

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

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

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

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

GET /v2/entities/<тип_сущности>/<идентификатор_сущности>/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 для бизнеса.
Ресурс
Параметр Описание Тип данных
<тип_сущности> Тип сущности:
  • project — проект;
  • portfolio — портфель.
 Строка
<идентификатор_сущности> Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. Строка
<идентификатор_проекта_или_портфеля> Идентификатор проекта или портфеля (значение поля shortId). Его можно использовать в запросе вместо идентификатора сущности. Строка

Важно

Идентификатор сущности не совпадает с идентификатором проекта или портфеля.

Параметры запроса

Дополнительные параметры

Параметр Описание Тип данных
fields Дополнительные поля сущности, которые будут включены в ответ. Строка

Пример: Получить связи между сущностями

  • Используется HTTP-метод GET.
GET /v2/entities/project/<идентификатор_проекта>/links?fields=id,summary
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

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

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

Тело ответа содержит информацию о связях сущности в формате JSON.

[
    {
        "type": "is dependent by", 
        "linkFieldValues": {
            "summary": "Первый проект", 
            "id": "6582874de6db7f5f********"
        }
    }, 
    {
        "type": "relates", 
        "linkFieldValues": {
            "summary": "Второй проект",
            "id": "65868f3fe2b9ef74********"
        }
    }
]
Параметры ответа
Параметр Описание Тип данных
type Тип связи:
  • is dependent by — текущая сущность является блокером;
  • depends on — текущая сущность зависит от связываемой.
  • relates — простая связь.
 Строка
linkFieldValues Список полей и их значений у связанных сущностей. Список полей указывается в параметре fields запроса. Строка

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

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