Получить связи задачи
Статья создана
Запрос позволяет получить информацию о связях задачи. Задача выбирается при указании идентификатора или ключа задачи.
Формат запроса
Перед выполнением запроса получите доступ к API.
Для получения списка связей задачи используйте HTTP-запрос с методом GET
:
GET /v2/issues/<issue-id>/links
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>
Заголовки
-
Host
Адрес узла, предоставляющего API:
https://api.tracker.yandex.net
-
Authorization
OAuth-токен в формате
OAuth <значение токена>
, например:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Идентификатор организации.
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<issue-id> | Идентификатор или ключ текущей задачи. | Строка |
Запрос связей задачи:
- Используется HTTP-метод GET.
GET /v2/issues/JUNE-2/links HTTP/1.1 Host: https://api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID: <идентификатор организации>
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит результаты в формате 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 | Блок с информацией о типе связи. | Объект |
direction | Тип связи задачи, указанной в запросе, по отношению к задаче в поле 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 | Отображаемое имя пользователя. | Строка |
Поля объекта updatedBy
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
Поля объекта assignee
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
Поля объекта status
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о статусе. | Строка |
id | Идентификатор статуса. | Строка |
key | Ключ статуса. | Строка |
display | Отображаемое название статуса. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.