Подключиться
Yandex Tracker

Импортировать связи

Статья создана

Важно

Запрос может быть выполнен только если у пользователя есть право на изменение задачи, связи которой импортируются.

С помощью запроса вы можете импортировать в Tracker связи задачи с другими задачами.

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

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

POST /v2/issues/<issue_id>/links/_import
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Content-Type: application/json

{
  "relationship": "relates",
  "issue": "TEST-2",
  "createdAt": "2017-08-29T12:34:41.740+0000",
  "createdBy": 1110000000011111,
  "updatedAt": "2017-09-07T11:24:31.140+0000",
  "updatedBy": 1110000000011111
}

Заголовки

  • Host

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

    https://api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <значение токена>, например:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

    Идентификатор организации.

Ресурс

  • <issue_id>

    Ключ задачи, к которой будет прикреплен комментарий.

  • Content-Type

    Формат тела запроса. Должен иметь значение application/json.

Тело запроса

Тело запроса содержит параметры комментария:

Параметр Описание Тип данных
relationship Тип связи между задачами:
  • relates — простая связь.
  • is dependent by — текущая задача является блокером.
  • depends on — текущая задача зависит от связываемой
  • is subtask for — текущая задача является подзадачей связываемой.
  • is parent task for — текущая задача является родительской для связываемой задачи.
  • duplicates — текущая задача дублирует связываемую.
  • is duplicated by — связываемая задача дублирует текущую.
  • is epic of — текущая задача является эпиком связываемой. Связь такого типа можно установить только для задач типа "Эпик".
  • has epic — связываемая задача является эпиком текущей. Связь такого типа можно установить только для задач типа "Эпик".
  • clone — связываемая задача является клоном текущей.
  • original — текущая задача является клоном связанной.
 Строка
issue Идентификатор или ключ связываемой задачи. Строка
createdAt Дата и время создания связи. формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Вы можете указать время в интервале от создания до последнего обновления задач, между которыми устанавливается связь. Строка
createdBy Логин или идентификатор создателя связи.
  • Строка для логина.
  • - Число для идентификатора.
updatedAt Дата и время последнего изменения связи. формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Вы можете указать время в интервале от создания до последнего обновления задач, между которыми устанавливается связь.

Параметр указывается только вместе с параметром updatedBy.		 Строка
updatedBy Логин или идентификатор пользователя, который редактировал связь последним.

Параметр указывается только вместе с параметром updatedAt.
  • Строка для логина.
  • Число для идентификатора.

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

В случае успешного выполнения запроса API возвращает ответ с кодом 201. Тело запроса содержит информацию о импортированной задаче в формате JSON.

{
        "self": "https://api.tracker.yandex.net/v2/issues/JUNE-2/links/4709605",
        "id": 4709605,
        "type": {
            "self": "https://api.tracker.yandex.net/v2/linktypes/subtask",
            "id": "subtask",
            "inward": "Подзадача",
            "outward": "Родительская задача"
        },
        "direction": "outward",
        "object": {
            "self": "https://api.tracker.yandex.net/v2/issues/TREK-9844",
            "id": "593cd211ef7e8a332414f2a7",
            "key": "TREK-9844"
            "display": "subtask"
        },
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
            "id": "<id сотрудника>",
            "display": "<отображаемое имя сотрудника>"
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
            "id": "<id сотрудника>",
            "display": "<отображаемое имя сотрудника>"
        },
        "createdAt": "2017-06-11T05:16:01.421+0000",
        "updatedAt": "2017-06-11T05:16:01.421+0000",
        "assignee": {
            "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
            "id": "<id сотрудника>",
            "display": "<отображаемое имя сотрудника>"
        },
        "status": {
            "self": "https://api.tracker.yandex.net/v2/statuses/1",
            "id": "1",
            "key": "open",
            "display": "Открыт"
        }
    }

Параметры ответа

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о связи. Строка
id Идентификатор связи. Число
type Блок с информацией о типе связи. Объект
sdirection Тип связи задачи, указанной в запросе, по отношению к задаче в поле 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 Ссылка на пользователя. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
self Ссылка на пользователя. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка

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

Параметр Описание Тип данных
self Ссылка на пользователя. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка

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

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

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

HTTP-код ошибки Описание ошибки
400 Bad Request Один из параметров запроса имеет недопустимое значение или формат данных.
403 Forbidden У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
404 Not Found Запрашиваемый ресурс не найден.
422 Unprocessable Entity Ошибка валидации JSON, запрос отклонен.
500 Internal Server Error Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503 Service Unavailable Сервис API временно недоступен.
В этой статье: