Связать задачи

Запрос позволяет создать связь между двумя задачами. Связь создается между текущей задачей (указывается в параметре issue-id запроса) и связываемой (указывается в поле issue тела запроса).

POST

https://api.tracker.yandex.net/v3/issues/<id_задачи>/links

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

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

Для создания связи используйте HTTP-запрос с методом POST:

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

{
    "relationship": "<тип_связи>",
    "issue": "<задача>"
}
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Tracker привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

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

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

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

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

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

Параметр Описание Формат
relationship Тип связи между задачами:
  • relates — простая связь.
  • is dependent by — текущая задача является блокером.
  • depends on — текущая задача зависит от связываемой.
  • is subtask for — текущая задача является подзадачей связываемой.
  • is parent task for — текущая задача является родительской для связываемой задачи.
  • duplicates — текущая задача дублирует связываемую.
  • is duplicated by — связываемая задача дублирует текущую.
  • is epic of — текущая задача является эпиком связываемой. Связь такого типа можно установить только для задач типа "Эпик".
  • has epic — связываемая задача является эпиком текущей. Связь такого типа можно установить только для задач типа "Эпик".
 Строка
issue Идентификатор или ключ связываемой задачи. Строка

Создание связи:

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

{
    "relationship": "relates",
    "issue": "TREK-2"
}

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

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

Тело ответа содержит результаты в формате JSON.

  {
    "self": "https://api.tracker.yandex.net/v3/issues/TEST-1/links/10*****",
    "id" : 10*****,
    "type" : {
      "self": "https://api.tracker.yandex.net/v3/linktypes/relates",
      "id" : "relates",
      "inward" : "relates",
      "outward" : "relates"
    },
    "direction" : "inward",
    "object" : {
      "self": "https://api.tracker.yandex.net/v3/issues/STARTREK-2",
      "id" : "4ff3e8dae4b0e2ac********",
      "key" : "TREK-2",
      "display" : "NEW!!!"
    },
    "createdBy" : {
      "self": "https://api.tracker.yandex.net/v3/users/44********",
      "id": "44********",
      "display": "Иван Иванов"
    },
    "updatedBy" : {
      "self": "https://api.tracker.yandex.net/v3/users/44********",
      "id": "44********",
      "display": "Иван Иванов"
    },
    "createdAt" : "2014-06-18T12:06:02.401+0000",
    "updatedAt" : "2014-06-18T12:06:02.401+0000"
  }
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о связи. Строка
id Идентификатор связи. Число
type Блок с информацией о типе связи. Объект
direction Тип связи задачи, указанной в запросе, по отношению к задаче в поле object. Возможны следующие значения:
  • outward — задача, указанная в запросе, является основной для задачи в поле object.
  • inward — задача в поле object является основной для задачи, указанной в запросе.
 Строка
object Блок с информацией о связанной задаче. Объект
createdBy Блок с информацией о создателе связи. Объект
updatedBy Блок с информацией о последнем изменившем связанную задачу пользователе. Объект
createdAt Дата и время создания связи. Строка
updatedAt Дата и время изменения связи. Строка
assignee Исполнитель связанной задачи. Объект
status Статус связанной задачи. Объект

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

Параметр Описание Тип данных
self Ссылка на тип связи. Строка
id Идентификатор типа связи. Строка
inward Название типа связи задачи в поле object по отношению к задаче, указанной в запросе. Строка
outward Название типа связи задачи, указанной в запросе, по отношению к задаче в поле object. Строка

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

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

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

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

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

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

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

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

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

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

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

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