Получить параметры задачи
Запрос позволяет получить информацию о задаче.
GET
https://api.tracker.yandex.net/v3/issues/<id_задачи>
Формат запроса
Перед выполнением запроса получите доступ к API.
Для получения задачи используйте HTTP-запрос с методом GET
:
GET /v3/issues/<id_задачи>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
Host
: адрес узла, предоставляющего API. -
Authorization
: токен для авторизации в одном из форматов:-
OAuth <OAuth-токен>
при авторизации по протоколу OAuth 2.0. Читать подробнее -
Bearer <IAM-токен>
при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее
-
-
X-Org-ID
илиX-Cloud-Org-ID
: идентификатор организации.-
Используйте заголовок
X-Org-ID
, если к Трекеру привязана организация Яндекс 360 для бизнеса. -
Используйте заголовок
X-Cloud-Org-ID
, если к Трекеру привязана организация Yandex Cloud Organization.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
Ресурс
Параметр | Описание | Тип данных |
---|---|---|
<id_задачи> | Идентификатор или ключ текущей задачи. | Строка |
Параметры запроса
Дополнительные параметры
Параметр | Описание | Тип данных |
---|---|---|
expand | Дополнительные поля, которые будут включены в ответ:
|
Строка |
Запрос одной задачи с указанием необходимых полей:
- Используется HTTP-метод GET.
- В ответе включено отображение вложенных файлов.
GET https://api.tracker.yandex.net/v3/issues/JUNE-3?expand=attachments
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK
.
Тело ответа содержит результаты в формате JSON.
[
{
"self": "https://api.tracker.yandex.net/v3/issues/TREK-9844",
"id": "593cd211ef7e8a33********",
"key": "TREK-9844",
"version": 7,
"lastCommentUpdatedAt": "2017-07-18T13:33:44.291+0000",
"summary": "subtask",
"parent": {
"self": "https://api.tracker.yandex.net/v3/issues/JUNE-2",
"id": "593cd0acef7e8a33********",
"key": "JUNE-2",
"display": "Task"
},
"aliases": [
"JUNE-3"
],
"updatedBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 11********
},
"description": "<#<html><head></head><body><div>test</div><div> </div><div> </div> </body></html>#>",
"sprint": [
{
"self": "https://api.tracker.yandex.net/v3/sprints/53**",
"id": "53**",
"display": "Sprint 1"
}
],
"type": {
"self": "https://api.tracker.yandex.net/v3/issuetypes/2",
"id": "2",
"key": "task",
"display": "Задача"
},
"priority": {
"self": "https://api.tracker.yandex.net/v3/priorities/2",
"id": "2",
"key": "normal",
"display": "Средний"
},
"createdAt": "2017-06-11T05:16:01.339+0000",
"followers": [
{
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 11********
}
],
"createdBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 11********
},
"votes": 0,
"assignee": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия",
"cloudUid": "ajeppa7dgp53********",
"passportUid": 11********
},
"project": {
"primary": {
"self": "https://api.tracker.yandex.net/v3/projects/1",
"id": "1",
"display": "New project"
},
"secondary": []
},
"queue": {
"self": "https://api.tracker.yandex.net/v3/queues/TREK",
"id": "111",
"key": "TREK",
"display": "My queue"
},
"updatedAt": "2017-07-18T13:33:44.291+0000",
"status": {
"self": "https://api.tracker.yandex.net/v3/statuses/1",
"id": "1",
"key": "open",
"display": "Открыт"
},
"previousStatus": {
"self": "https://api.tracker.yandex.net/v3/statuses/2",
"id": "2",
"key": "resolved",
"display": "Решен"
},
"favorite": false
},
{...}
]
Параметры ответа
В таблице перечислены часто используемые параметры задачи. Полный список поддерживаемых параметров можно найти на странице https://tracker.yandex.ru/admin/fields.
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о задаче | Строка |
id | Идентификатор задачи | Строка |
key | Ключ задачи | Строка |
version | Версия задачи. Каждое изменение параметров задачи увеличивает номер версии. Редактирование задачи будет заблокировано, если версия достигнет предельного значения: для роботов 10100 , для пользователей 11100 |
Число |
lastCommentUpdatedAt | Дата и время последнего добавленного комментария | Строка |
summary | Название задачи | Строка |
parent | Объект с информацией о родительской задаче | Объект |
aliases | Массив с информацией об альтернативных ключах задачи | Массив строк |
updatedBy | Объект с информацией о последнем сотруднике, изменявшим задачу | Объект |
description | Описание задачи | Строка |
sprint | Массив объектов с информацией о спринте | Массив объектов |
type | Объект с информацией о типе задачи | Объект |
priority | Объект с информацией о приоритете | Объект |
createdAt | Дата и время создания задачи | Строка |
followers | Массив объектов с информацией о наблюдателях задачи | Массив объектов |
createdBy | Объект с информацией о создателе задачи | Объект |
votes | Количество голосов за задачу | Число |
assignee | Объект с информацией об исполнителе задачи | Объект |
project | Объект с информацией о проектах задачи | Объект |
queue | Объект с информацией об очереди задачи | Объект |
updatedAt | Дата и время последнего обновления задачи | Строка |
status | Объект с информацией о статусе задачи | Объект |
previousStatus | Объект с информацией о предыдущем статусе задачи | Объект |
favorite | Признак избранной задачи:
|
Логический |
tags | Теги задачи | Массив строк |
Поля объекта parent
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о задаче. | Строка |
id | Идентификатор задачи. | Строка |
key | Ключ задачи. | Строка |
display | Отображаемое название задачи. | Строка |
Поля объекта updatedBy
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объектов массива sprint
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о спринте. | Строка |
id | Идентификатор спринта. | Строка |
display | Отображаемое название спринта. | Строка |
Поля объекта type
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о типе задаче. | Строка |
id | Идентификатор типа задачи. | Строка |
key | Ключ типа задачи. | Строка |
display | Отображаемое название типа задачи. | Строка |
Поля объекта priority
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о приоритете. | Строка |
id | Идентификатор приоритета. | Строка |
key | Ключ приоритета. | Строка |
display | Отображаемое название приоритета. | Строка |
Поля объектов массива followers
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта createdBy
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта assignee
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
id | Идентификатор пользователя. | Строка |
display | Отображаемое имя пользователя. | Строка |
passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта project
Параметр | Описание | Тип данных |
---|---|---|
primary | Основной проект задачи | Объект |
secondary | Список дополнительных проектов задачи | Массив объектов |
Если в адресе запроса указана версия API v2
, объект project
содержит информацию только об основном проекте.
Поля объекта, содержащего данные проекта
Параметры primary
и secondary
содержат объекты со следующими полями:
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о проекте. | Строка |
id | Идентификатор проекта. | Строка |
display | Отображаемое название проекта. | Строка |
Поля объекта queue
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию об очереди. | Строка |
id | Идентификатор очереди. | Строка |
key | Ключ очереди. | Строка |
display | Отображаемое название очереди. | Строка |
Поля объекта status
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о статусе. | Строка |
id | Идентификатор статуса. | Строка |
key | Ключ статуса. | Строка |
display | Отображаемое название статуса. | Строка |
Поля объекта previousStatus
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит информацию о статусе. | Строка |
id | Идентификатор статуса. | Строка |
key | Ключ статуса. | Строка |
display | Отображаемое название статуса. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.