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

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

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

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

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

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

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

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

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

  • 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). Его можно использовать в запросе вместо идентификатора сущности. Строка

Важно

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

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

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

Параметр Описание Тип данных
relationship Тип связи:
  • is dependent by — текущая сущность является блокером;
  • depends on — текущая сущность зависит от связываемой;
  • relates — простая связь.
 Строка
entity Идентификатор сущности, с которой устанавливается связь. Вместо него в запросе можно использовать идентификатор проекта или портфеля — значение поля shortId. Строка

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

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

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

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

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

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

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