Получить список внешних связей задачи
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет получить список связей задачи с объектами внешних приложений.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы получить список внешних связей задачи, используйте HTTP-запрос с методом GET.
GET /v2/issues/<ключ_или_идентификатор_задачи>/remotelinks
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
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 для бизнеса, используется заголовок
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <ключ_или_идентификатор_задачи> | Идентификатор или ключ текущей задачи. | Строка |
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело запроса содержит информацию о внешних связях задачи в формате JSON.
[
{
"self": "https://api.tracker.yandex.net/v2/issues/<ключ_или_идентификатор_задачи>/remotelinks/51******",
"id": 51******,
"type": {
"self": "https://api.tracker.yandex.net/v2/linktypes/relates",
"id": "relates",
"inward": "Связана",
"outward": "Связана"
},
"direction": "outward",
"object": {
"self": "https://api.tracker.yandex.net/v2/applications/ru.yandex.bitbucket/objects/13570010********",
"id": "13570010********",
"key": "TEST-17",
"application": {
"self": "https://api.tracker.yandex.net/v2/applications/25811000********",
"id": "25811000********",
"type": "app",
"name": "test-app"
}
},
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/77********",
"id": "77********",
"display": "display-user-name"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v2/users/77********",
"id": "77********",
"display": "display-user-name"
},
"createdAt": "2021-07-14T18:59:54.552+0000",
"updatedAt": "2021-07-14T18:59:54.552+0000"
},
...
]
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о внешней связи. | Строка |
| id | Идентификатор связи. | Строка |
| type | Блок с информацией о типе связи. | Объект |
| direction | «Направление» связи. Параметр релевантен для несимметричных типов связей, например «Родительская задача» — «Подзадача». Возможны следующие значения:
|
Строка |
| 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. | Число |
Поля объекта updatedBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.