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

Получить параметры задачи

Запрос позволяет получить информацию о задаче.

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

Для получения задачи используйте HTTP-запрос с методом GET:

GET /v2/issues/<issue-id>?
expand=<дополнительные поля в ответе>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>

Ресурс

  • <issue-id>

    Ключ задачи.

Параметры запроса

  • expand (необязательный)

    Дополнительные поля, которые будут включены в ответ:

    • transitions — переходы по жизненному циклу;
    • attachments — вложения.

Запрос одной задачи с указанием необходимых полей:

  • Используется HTTP-метод GET.
  • В ответе включено отображение приложений.
GET /v2/issues/JUNE-3?expand=attachments HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>

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

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

{
    "self": "https://api.tracker.yandex.net/v2/issues/TREK-9844",
    "id": "593cd211ef7e8a332414f2a7",
    "key": "TREK-9844",
    "version": 7,
    "lastCommentUpdatedAt": "2017-07-18T13:33:44.291+0000",
    "summary": "subtask",
    "parent": {
        "self": "https://api.tracker.yandex.net/v2/issues/JUNE-2",
        "id": "593cd0acef7e8a332414f28e",
        "key": "JUNE-2",
        "display": "Task"
        },
    "aliases": [
            "JUNE-3"
        ],

    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v2/users/1120000000016876",
        "id": "<id сотрудника>",
        "display": "<отображаемое имя сотрудника>"
        },
    "description": "<#<html><head></head><body><div>test</div><div>&nbsp;</div><div>&nbsp;</div> </body></html>#>",    
    "sprint": [
            {
        "self": "https://api.tracker.yandex.net/v2/sprints/5317",
        "id": "5317",
        "display": "спринт1"
            }
        ],
    "type": {
        "self": "https://api.tracker.yandex.net/v2/issuetypes/2",
        "id": "2",
        "key": "task",
        "display": "Задача"
        },
    "priority": {
        "self": "https://api.tracker.yandex.net/v2/priorities/2",
        "id": "2",
        "key": "normal",
        "display": "Средний"
        },

    "createdAt": "2017-06-11T05:16:01.339+0000",
    "followers": [
        {
        "self": "https://api.tracker.yandex.net/v2/users/1120000000016876",
        "id": "<id сотрудника>",
        "display": "<отображаемое имя сотрудника>"
        }
        ],
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
        "id": "<id сотрудника>",
        "display": "<отображаемое имя сотрудника>"
        },
    "votes": 0,
        "assignee": {
        "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
        "id": "<id сотрудника>",
        "display": "<отображаемое имя сотрудника>"
        },
    "queue": {
        "self": "https://api.tracker.yandex.net/v2/queues/TREK",
        "id": "111",
        "key": "TREK",
        "display": "Стартрек"
        },
    "updatedAt": "2017-07-18T13:33:44.291+0000",
    "status": {
        "self": "https://api.tracker.yandex.net/v2/statuses/1",
        "id": "1",
        "key": "open",
        "display": "Открыт"
        },
    "previousStatus": {
        "self": "https://api.tracker.yandex.net/v2/statuses/2",
        "id": "2",
        "key": "resolved",
        "display": "Решен"
        },
    "favorite": false
}

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

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о задаче. Строка.
id Идентификатор задачи. Строка.
key Ключ задачи. Строка.
version Версия задачи. Каждое изменение параметров задачи увеличивает номер версии. Число.
lastCommentUpdatedAt Дата и время последнего добавленного комментария. Строка.
summary Название задачи. Строка.
parent Объект с информацией о родительской задаче. Объект.
aliases Массив с информацией об альтернативных ключах задачи. Массив строк.
updatedBy Объект с информацией о последнем сотруднике, изменявшим задачу. Объект.
description Описание задачи. Строка.
sprint Массив объектов с информацией о спринте. Массив объектов.
type Объект с информацией о типе задачи. Объект.
priority Объект с информацией о приоритете. Объект.
createdAt Дата и время создания задачи. Строка.
followers Массив объектов с информацией о наблюдателях задачи. Массив объектов.
createdBy Объект с информацией о создателе задачи. Объект.
votes Количество голосов за задачу. Число.
assignee Объект с информацией об исполнителе задачи. Объект.
queue Объект с информацией об очереди задачи. Объект.
updatedAt Дата и время последнего обновления задачи. Строка.
status Объект с информацией о статусе задачи. Объект.
previousStatus Объект с информацией о предыдущем статусе задачи. Объект.
favorite Признак избранной задачи:
  • true — пользователь добавил задачу в избранное;
  • false — задача не добавлена в избранное.
 Логический.

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

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

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

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

Поля объектов массива sprint

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

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

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

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

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

Поля объектов массива followers

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

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

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

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

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

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

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

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

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

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

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

Возможные коды ответа

200
Запрос выполнен успешно.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
В этой статье: