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

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

GET

https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/links?fields=<поля_сущности>

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

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

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

GET /v3/entities/<тип_сущности>/<id_сущности>/links?fields=<поля_сущности>
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: идентификатор организации.

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

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

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

Ресурс
Параметр Описание Тип данных
<тип_сущности> Тип сущности:
  • project — проект;
  • portfolio — портфель;
  • goal — цель
Строка
<id_сущности> Идентификатор сущности. Чтобы получить идентификатор, посмотрите список сущностей. В качестве идентификатора можно использовать параметр id или shortId. Строка
Параметры запроса

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

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

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

  • Используется HTTP-метод GET.
  • В ответ включены поля id и summary связанных сущностей.
GET https://api.tracker.yandex.net/v3/entities/project/<id_проекта>/links?fields=id,summary

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

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

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

[
    {
        "type": "is dependent by", 
        "linkFieldValues": {
            "summary": "Первый проект", 
            "id": "6582874de6db7f5f********"
        }
    }, 
    {
        "type": "relates", 
        "linkFieldValues": {
            "summary": "Второй проект",
            "id": "65868f3fe2b9ef74********"
        }
    }
]
Параметры ответа

Параметр

Описание

Тип данных

relationship

Тип связи. Для проектов и портфелей:

  • depends on — текущая сущность зависит от связанной
  • is dependent by — текущая сущность блокирует связанную
  • works towards — связь проекта с целью

Для цели:

  • parent entity — родительская цель
  • child entity — подцель
  • depends on — текущая цель зависит от связанной
  • is dependent by — текущая цель блокирует связанную
  • is supported by — связь с проектом

Строка

linkFieldValues

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

Строка

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

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