Получить все записи по задаче
Запрос позволяет получить данные о времени, затраченном на выполнение задачи.
Формат запроса
Чтобы получить записи о затраченном на задачу времени, используйте HTTP-запрос с методом GET:
GET /v2/issues/<ключ_или_идентификатор_задачи>/worklog
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/TEST-324/worklog/1",
"id": 1,
"version": 1402121720882,
"issue": {
"self": "https://api.tracker.yandex.net/v2/issues/TEST-324",
"id": "515ec9eae4b09cfa********",
"key": "TEST-324",
"display": "важная задача"
},
"comment": "важный комментарий",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/66********",
"id": "veikus",
"display": "Artem Veikus"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v2/users/66********",
"id": "veikus",
"display": "Artem Veikus"
},
"createdAt": "2021-09-28T08:42:06.258+0000",
"updatedAt": "2021-09-28T08:42:06.258+0000",
"start": "2021-09-21T10:30:00.000+0000",
"duration": "P3W"
},
...
]
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит запись о затраченном времени. | Строка |
| id | Идентификатор записи о затраченном времени. | Строка |
| version | Версия записи. Каждое изменение записи увеличивает номер версии. | Строка |
| issue | Блок с информацией о задаче. | Объект |
| comment | Текст комментария к записи. Комментарий сохранится в Отчёте по затратам времени. | Строка |
| createdBy | Объект с информацией о создателе записи. | Объект |
| updatedBy | Объект с информацией о пользователе, внесшем изменение в запись. | Объект |
| createdAt | Дата и время создания записи в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm |
Строка |
| updatedAt | Дата и время обновления записи в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm |
Строка |
| start | Дата и время начала работы над задачей в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm |
Строка |
| duration | Затраченное время в формате PnYnMnDTnHnMnS, PnW в соответствии с ISO 8601. |
Строка |
Поля объекта issue
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о задаче. | Строка |
| id | Идентификатор задачи. | Строка |
| key | Ключ задачи. | Строка |
| display | Отображаемое название задачи. | Строка |
Поля объекта createdBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
Поля объекта updatedBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.