Импортировать связи
Важно
Запрос может быть выполнен только если у пользователя есть право на изменение задачи, связи которой импортируются.
С помощью запроса вы можете импортировать в Tracker связи задачи с другими задачами.
Формат запроса
Чтобы импортировать связь, используйте HTTP-запрос с методом POST
. Параметры связи передаются в теле запроса в формате JSON:
POST /v2/issues/<ключ_или_идентификатор_задачи>/links/_import
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"relationship": "relates",
"issue": "TEST-2",
"createdAt": "2017-08-29T12:34:41.740+0000",
"createdBy": 11********,
"updatedAt": "2017-09-07T11:24:31.140+0000",
"updatedBy": 11********
}
Заголовки
-
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 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<ключ_или_идентификатор_задачи> | Ключ задачи, к которой будет прикреплен файл. | Строка |
Параметры тела запроса
Обязательные параметры
Параметр | Описание | Тип данных |
---|---|---|
relationship | Тип связи между задачами:
|
Строка |
issue | Идентификатор или ключ связываемой задачи. | Строка |
createdAt | Дата и время создания связи. формате YYYY-MM-DDThh:mm:ss.sss±hhmm . Вы можете указать время в интервале от создания до последнего обновления задач, между которыми устанавливается связь. |
Строка |
createdBy | Логин или идентификатор создателя связи. |
|
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
updatedAt | Дата и время последнего изменения связи. формате YYYY-MM-DDThh:mm:ss.sss±hhmm . Вы можете указать время в интервале от создания до последнего обновления задач, между которыми устанавливается связь.Параметр указывается только вместе с параметром updatedBy . |
Строка |
updatedBy | Логин или идентификатор пользователя, который редактировал связь последним. Параметр указывается только вместе с параметром updatedAt . |
|
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит параметры прикрепленного файла в формате JSON:
{
"self": "https://api.tracker.yandex.net/v2/issues/JUNE-2/links/47*****",
"id": 47*****,
"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": "593cd211ef7e8a33********",
"key": "TREK-9844"
"display": "subtask"
},
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/11********",
"id": "11********",
"display": "Иван Иванов"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v2/users/11********",
"id": "11********",
"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/11********",
"id": "11********",
"display": "Иван Иванов"
},
"status": {
"self": "https://api.tracker.yandex.net/v2/statuses/1",
"id": "1",
"key": "open",
"display": "Открыт"
}
}
Параметры ответа
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о связи. | Строка |
id | Идентификатор связи. | Число |
type | Блок с информацией о типе связи. | Объект |
sdirection | Тип связи задачи, указанной в запросе, по отношению к задаче в поле 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 | Отображаемое название статуса. | Строка |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.