Связать сущности

Запрос позволяет создать связи между несколькими сущностями.

POST

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

Чтобы добавить родительскую сущность для проекта или портфеля, отредактируйте поле parentEntity с помощью запроса Изменить сущность.

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

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

Для создания связей используйте HTTP-запрос с методом POST. Информация о связях передается в теле запроса в формате JSON. Связь создается между текущей сущностью (указывается в <id_сущности> запроса) и сущностями, идентификаторы которых указаны в полях entity тела запроса.

POST /v3/entities/<тип_сущности>/<id_сущности>/links
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "relationship": "<тип_связи>",
  "entity": "<идентификатор_связываемой_сущности>"
}
Заголовки

  • 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. Строка
Параметры тела запроса

Обязательные параметры

Параметр

Описание

Тип данных

relationship

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

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

Для цели:

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

Строка

entity

Идентификатор связанной сущности.

Строка

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

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

[
  {
     "relationship":"is dependent by",
     "entity": "6582874de6db7f5f********"
  },
  {
     "relationship":"works towards",
     "entity": "65868f3fe2b9ef74********"
  }
]

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

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

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

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