Добавить внешнюю связь

Запрос позволяет создать связь для работы с объектом внешнего приложения.

POST

https://api.tracker.yandex.net/v3/issues/<id_задачи>/remotelinks?backlink=true

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

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

Чтобы создать внешнюю связь, используйте HTTP-запрос с методом POST.

POST /v3/issues/<id_задачи>/remotelinks?backlink=true
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "relationship": "RELATES",
    "key": "<ключ_объекта>",
    "origin": "<идентификатор_приложения>"
}
Заголовки
  • 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.

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

Ресурс
Параметр Описание Тип данных
<id_задачи> Идентификатор или ключ текущей задачи. Строка
Параметры запроса

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

Параметр Описание Тип данных
backlink Значение true следует указать, чтобы при добавлении связи выполнить запрос из Трекера для создания дублирующей связи во внешнем приложении. Логический
Параметры тела запроса

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

Параметр Описание Тип данных
relationship Тип связи. Рекомендуем использовать значение RELATES — связан. Строка
key Ключ объекта во внешнем приложении. Строка
origin Идентификатор приложения, с объектом которого нужно создать связь. Строка

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

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

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

 {
     "self": "https://api.tracker.yandex.net/v3/issues/<id_задачи>/remotelinks/51******", 
     "id": 51******,
     "type": {
         "self": "https://api.tracker.yandex.net/v3/linktypes/relates",
         "id": "relates",
         "inward": "Связана",
         "outward": "Связана"
     },
     "direction": "outward",
     "object": {
         "self": "https://api.tracker.yandex.net/v3/applications/ru.yandex.bitbucket/objects/13570010********",
         "id": "13570010********",
         "key": "TEST-17",
         "application": {
             "self": "https://api.tracker.yandex.net/v3/applications/25811000********",
             "id": "25811000********",
             "type": "app",
             "name": "test-app"
         }
     },
     "createdBy": {
         "self": "https://api.tracker.yandex.net/v3/users/11********",
         "id": "11********",
         "display": "Имя Фамилия"
     },
     "updatedBy": {
         "self": "https://api.tracker.yandex.net/v3/users/11********",
         "id": "11********",
         "display": "Имя Фамилия"
     },
     "createdAt": "2021-07-19T06:18:09.327+0000",
     "updatedAt": "2021-07-19T06:18:09.327+0000"
 }

Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о внешней связи. Строка
id Идентификатор связи. Строка
type Блок с информацией о типе связи. Объект
direction «Направление» связи. Параметр релевантен для несимметричных типов связей, например «Родительская задача» — «Подзадача». Возможны следующие значения:
  • outward — задача, указанная в запросе, является основной для объекта.
  • inward — объект является основным для задачи, указанной в запросе.
Строка
object Блок с информацией об объекте внешнего приложения. Объект
createdBy Блок с информацией о создателе связи. Объект
updatedBy Блок с информацией о последнем сотруднике, изменявшим связь. Объект
createdAt Дата и время создания связи. Строка
updatedAt Дата и время последнего обновления связи. Строка

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о типе связи. Строка
id Идентификатор типа связи. Строка
inward Название типа связи в зависимости от «направления». Строка
outward Название типа связи в зависимости от «направления». Строка

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

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

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

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

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число
cloudUid Уникальный идентификатор пользователя в Yandex Cloud Organization. Строка

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число
cloudUid Уникальный идентификатор пользователя в Yandex Cloud Organization. Строка

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

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.