Получить историю изменений задачи
Запрос позволяет получить историю изменений задачи. Ответ может быть расположен на нескольких страницах.
Формат запроса
GET /v2/issues/<issue-id>/changelog?id=<идентификатор предыдущего изменения>&perPage=<изменения на странице>&field=<измененный параметр>&type=<тип изменения>
Host:https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
- <issue-id>
- Идентификатор или ключ задачи.
- Host
-
Адрес узла, предоставляющего API:
https://api.tracker.yandex.net
- Authorization
-
OAuth-токен в формате
OAuth <значение токена>
, например:OAuth 0c4181a7c2cf4521964a72ff57a34a07
- X-Org-ID
-
Идентификатор организации.
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор изменения, за которым следуют запрашиваемые изменения. | Строка. |
perPage | Количество изменений на странице. | Число. |
field | Измененный параметр задачи. | Строка. |
type | Тип изменения. | Строка. |
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор изменения, за которым следуют запрашиваемые изменения. | Строка. |
perPage | Количество изменений на странице. | Число. |
field | Измененный параметр задачи. | Строка. |
type | Тип изменения. | Строка. |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит JSON-массив с историей изменений очереди.
- Заголовки ответа
-
Заголовки
Link
содержат ссылки на первую и последующую страницы ответа. По умолчанию на каждой странице располагается 50 изменений.
...
Link: <https://api.tracker.yandex.net/v2/issues/SCR-8/changelog?perPage=50>; rel="first"
Link: <https://api.tracker.yandex.net/v2/issues/SCR-8/changelog?id=5b9a1a88f7c605001c0e14a5&perPage=50>; rel="next"
...
- Тело ответа
[
{
"id" : "50616d66e4b07c95fbd35684",
"self" : "https://api.tracker.yandex.net/v2/issues/DESIGN-1/changelog/50616d66e4b07c95fbd35684",
"issue" : {
"self" : "https://api.tracker.yandex.net/v2/issues/DESIGN-1",
"id" : "4ff3e8dae4b0e2ac27f6eb43",
"key" : "DESIGN-1",
"display" : "Сверстать прототип страницы"
},
"updatedAt" : "2012-09-25T08:37:58.243+0000",
"updatedBy" : {
"self" : "https://api.tracker.yandex.net/v2/users/1120000000007837",
"id": "rodique",
"display" : "Rodion Volchkov"
},
"type" : "IssueUpdated",
"fields" : [ {
"field" : {
"self" : "https://api.tracker.yandex.net/v2/fields/priority",
"id" : "priority",
"display" : "Priority"
},
"from" : {
"self" : "https://api.tracker.yandex.net/v2/priorities/2",
"id" : "2",
"key" : "normal",
"display" : "Normal"
},
"to" : {
"self" : "https://api.tracker.yandex.net/v2/priorities/3",
"id" : "3",
"key" : "minor",
"display" : "Minor"
}
},
...
]
},
...
]
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор изменения. | Строка. |
self | Адрес ресурса API, который содержит информацию об изменении. | Строка. |
issue | Блок с информацией о задаче. | Объект. |
updatedAt | Дата и время изменения задачи в формате YYYY-MM-DDThh:mm:ss.sss±hhmm . | Строка. |
updatedBy | Блок с информацией о пользователе, который внес изменение в задачу. | Объект. |
type | Тип изменения. | Строка. |
fields | Массив объектов с информацией об измененных параметрах задачи. | Массив. |
Поля объекта issue | ||
self | Ссылка на задачу. | Строка. |
id | Идентификатор задачи. | Строка. |
key | Ключ задачи. | Строка. |
display | Отображаемое название задачи. | Строка. |
Поля объекта updatedBy | ||
self | Ссылка на пользователя. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Поля объектов массива fields | ||
field | Блок с информацией об измененном параметре задачи. | Объект. |
from | Блок с информацией о значении параметра до изменения. | Объект. |
to | Блок с информацией о значении параметра после изменения. | Объект. |
Поля объекта field | ||
self | Ссылка на измененный параметр задачи. | Строка. |
id | Идентификатор параметра задачи. | Строка. |
display | Отображаемое название параметра задачи. | Строка. |
Поля объектов from и to | ||
self | Ссылка на значение параметра задачи. | Строка. |
id | Идентификатор значения параметра задачи. | Строка. |
key | Ключ значения параметра. | Строка. |
display | Отображаемое название значения параметра. | Строка. |
Параметр | Описание | Тип данных |
---|---|---|
id | Идентификатор изменения. | Строка. |
self | Адрес ресурса API, который содержит информацию об изменении. | Строка. |
issue | Блок с информацией о задаче. | Объект. |
updatedAt | Дата и время изменения задачи в формате YYYY-MM-DDThh:mm:ss.sss±hhmm . | Строка. |
updatedBy | Блок с информацией о пользователе, который внес изменение в задачу. | Объект. |
type | Тип изменения. | Строка. |
fields | Массив объектов с информацией об измененных параметрах задачи. | Массив. |
Поля объекта issue | ||
self | Ссылка на задачу. | Строка. |
id | Идентификатор задачи. | Строка. |
key | Ключ задачи. | Строка. |
display | Отображаемое название задачи. | Строка. |
Поля объекта updatedBy | ||
self | Ссылка на пользователя. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Поля объектов массива fields | ||
field | Блок с информацией об измененном параметре задачи. | Объект. |
from | Блок с информацией о значении параметра до изменения. | Объект. |
to | Блок с информацией о значении параметра после изменения. | Объект. |
Поля объекта field | ||
self | Ссылка на измененный параметр задачи. | Строка. |
id | Идентификатор параметра задачи. | Строка. |
display | Отображаемое название параметра задачи. | Строка. |
Поля объектов from и to | ||
self | Ссылка на значение параметра задачи. | Строка. |
id | Идентификатор значения параметра задачи. | Строка. |
key | Ключ значения параметра. | Строка. |
display | Отображаемое название значения параметра. | Строка. |
Тип изменения | Описание |
---|---|
IssueUpdated | Задача изменена. |
IssueCreated | Задача создана. |
IssueMoved | Задача перемещена в другую очередь. |
IssueCloned | Создан клон задачи. |
IssueCommentAdded | Добавлен комментарий к задаче. |
IssueCommentUpdated | Изменен комментарий к задаче. |
IssueCommentRemoved | Удален комментарий к задаче. |
IssueWorklogAdded | Добавлена запись о затраченном времени. |
IssueWorklogUpdated | Изменена запись о затраченном времени. |
IssueWorklogRemoved | Удалена запись о затраченном времени. |
IssueCommentReactionAdded | За комментарий проголосовали. |
IssueCommentReactionRemoved | Отозван голос за комментарий. |
IssueVoteAdded | За задачу проголосовали. |
IssueVoteRemoved | Отозван голос за задачу. |
IssueLinked | Создана связь с другой задачей. |
IssueLinkChanged | Изменен тип связи с другой задачей. |
IssueUnlinked | Удалена связь с другой задачей. |
RelatedIssueResolutionChanged | Изменена резолюция связанной задачи. |
IssueAttachmentAdded | К задаче прикреплен файл. |
IssueAttachmentRemoved | Прикрепленный к задаче файл удален. |
IssueWorkflow | Изменен статус задачи. |
Тип изменения | Описание |
---|---|
IssueUpdated | Задача изменена. |
IssueCreated | Задача создана. |
IssueMoved | Задача перемещена в другую очередь. |
IssueCloned | Создан клон задачи. |
IssueCommentAdded | Добавлен комментарий к задаче. |
IssueCommentUpdated | Изменен комментарий к задаче. |
IssueCommentRemoved | Удален комментарий к задаче. |
IssueWorklogAdded | Добавлена запись о затраченном времени. |
IssueWorklogUpdated | Изменена запись о затраченном времени. |
IssueWorklogRemoved | Удалена запись о затраченном времени. |
IssueCommentReactionAdded | За комментарий проголосовали. |
IssueCommentReactionRemoved | Отозван голос за комментарий. |
IssueVoteAdded | За задачу проголосовали. |
IssueVoteRemoved | Отозван голос за задачу. |
IssueLinked | Создана связь с другой задачей. |
IssueLinkChanged | Изменен тип связи с другой задачей. |
IssueUnlinked | Удалена связь с другой задачей. |
RelatedIssueResolutionChanged | Изменена резолюция связанной задачи. |
IssueAttachmentAdded | К задаче прикреплен файл. |
IssueAttachmentRemoved | Прикрепленный к задаче файл удален. |
IssueWorkflow | Изменен статус задачи. |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
HTTP-код ошибки | Описание ошибки |
---|---|
400 Bad Request | Один из параметров запроса имеет недопустимое значение или формат данных. |
403 Forbidden | У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен. |
404 Not Found | Запрашиваемый ресурс не найден. |
422 Unprocessable Entity | Ошибка валидации JSON, запрос отклонен. |
500 Internal Server Error | Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время. |
503 Service Unavailable | Сервис API временно недоступен. |
HTTP-код ошибки | Описание ошибки |
---|---|
400 Bad Request | Один из параметров запроса имеет недопустимое значение или формат данных. |
403 Forbidden | У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен. |
404 Not Found | Запрашиваемый ресурс не найден. |
422 Unprocessable Entity | Ошибка валидации JSON, запрос отклонен. |
500 Internal Server Error | Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время. |
503 Service Unavailable | Сервис API временно недоступен. |