Добавить запись о затраченном времени
Запрос позволяет добавить запись о времени, затраченном на выполнение задачи.
Формат запроса
Чтобы создать запись о затраченном на задачу времени, используйте HTTP-запрос с методом POST
. Параметры запроса передаются в его теле в формате JSON:
POST/v2/issues/<issue-id>/worklog
Host:https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
{
"start": "2014-06-06T08:42:20.258",
"duration": "P5D",
"comment": "важный комментарий"
}
- <issue-id>
- Идентификатор или ключ задачи.
- Host
-
Адрес узла, предоставляющего API:
https://api.tracker.yandex.net
- Authorization
-
OAuth-токен в формате
OAuth <значение токена>
, например:OAuth 0c4181a7c2cf4521964a72ff57a34a07
- X-Org-ID
-
Идентификатор организации.
Тело запроса содержит параметры задачи:
Параметр | Описание | Тип данных |
---|---|---|
start | Дата и время начала работы над задачей в формате:
| Строка. |
duration | Затраченное время в формате в соответствии с ISO 8601. | Строка. |
comment | Текст комментария к записи. Комментарий сохранится в Отчёте по затратам времени. | Строка. |
Параметр | Описание | Тип данных |
---|---|---|
start | Дата и время начала работы над задачей в формате:
| Строка. |
duration | Затраченное время в формате в соответствии с ISO 8601. | Строка. |
comment | Текст комментария к записи. Комментарий сохранится в Отчёте по затратам времени. | Строка. |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 201. Тело ответа содержит 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": "515ec9eae4b09cfa984e2047",
"key": "TEST-324",
"display": "важная задача"
},
"comment": "важный комментарий",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000014909",
"id": "veikus",
"display": "Artem Veikus"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000014909",
"id": "veikus",
"display": "Artem Veikus"
},
"createdAt": "2014-06-06T08:42:06.258+0000",
"updatedAt": "2014-06-06T08:42:06.258+0000",
"start": "2014-06-06T08:41:58.000+0000",
"duration": "P3W"
}
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит запись о затраченном времени. | Строка. |
id | Идентификатор записи о затраченном времени. | Строка. |
version | Версия записи. Каждое изменение записи увеличивает номер версии. | Строка. |
issue | Блок с информацией о задаче. | Объект. |
comment | Текст комментария к записи. Комментарий сохранится в Отчёте по затратам времени. | Строка. |
createdBy | Объект с информацией о создателе записи. | Объект. |
updatedBy | Объект с информацией о пользователе, внесшем изменение в запись. | Объект. |
createdAt | Дата и время создания записи в формате:
| Строка. |
updatedAt | Дата и время обновления записи в формате:
| Строка. |
start | Дата и время начала работы над задачей в формате:
| Строка. |
duration | Затраченное время в формате в соответствии с ISO 8601. | Строка. |
Поля объекта issue | ||
self | Адрес ресурса API, который содержит информацию о задаче. | Строка. |
id | Идентификатор задачи. | Строка. |
key | Ключ задачи. | Строка. |
display | Отображаемое название задачи. | Строка. |
Поля объекта createdBy | ||
self | Адрес ресурса API, который содержит информацию о пользователе Трекера. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Поля объекта updatedBy | ||
self | Адрес ресурса API, который содержит информацию о пользователе Трекера. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Параметр | Описание | Тип данных |
---|---|---|
self | Адрес ресурса API, который содержит запись о затраченном времени. | Строка. |
id | Идентификатор записи о затраченном времени. | Строка. |
version | Версия записи. Каждое изменение записи увеличивает номер версии. | Строка. |
issue | Блок с информацией о задаче. | Объект. |
comment | Текст комментария к записи. Комментарий сохранится в Отчёте по затратам времени. | Строка. |
createdBy | Объект с информацией о создателе записи. | Объект. |
updatedBy | Объект с информацией о пользователе, внесшем изменение в запись. | Объект. |
createdAt | Дата и время создания записи в формате:
| Строка. |
updatedAt | Дата и время обновления записи в формате:
| Строка. |
start | Дата и время начала работы над задачей в формате:
| Строка. |
duration | Затраченное время в формате в соответствии с ISO 8601. | Строка. |
Поля объекта issue | ||
self | Адрес ресурса API, который содержит информацию о задаче. | Строка. |
id | Идентификатор задачи. | Строка. |
key | Ключ задачи. | Строка. |
display | Отображаемое название задачи. | Строка. |
Поля объекта createdBy | ||
self | Адрес ресурса API, который содержит информацию о пользователе Трекера. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Поля объекта updatedBy | ||
self | Адрес ресурса API, который содержит информацию о пользователе Трекера. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
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 временно недоступен. |