Редактировать запись о затраченном времени
Запрос позволяет изменить запись о времени, затраченном на выполнение задачи.
PATCH
https://api.tracker.yandex.net/v3/issues/<id_задачи>/worklog/<id_записи>В Яндекс Трекере учет времени ведется в рабочих неделях (5 дней) и рабочих днях (8 часов).
Например, если передать временной интервал, равный 5 дням (P5D), в ответе на запрос и при просмотре задачи отобразится значение 1 неделя (P1W).
Формат запроса
Чтобы изменить запись о затраченном на задачу времени, используйте HTTP-запрос с методом PATCH. В теле запроса укажите параметры в формате JSON:
PATCH /v3/issues/<id_задачи>/worklog/<id_записи>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"duration": "PT520M",
"comment": "время изменено!"
}
Заголовки
-
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_задачи> | Идентификатор или ключ задачи. | Строка |
| <id_записи> | Идентификатор записи о затраченном времени. | Строка |
Параметры тела запроса
Обязательные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| duration | Затраченное время в формате PnYnMnDTnHnMnS, PnW в соответствии с ISO 8601.Чтобы отделить часы, минуты, секунды, используйте букву T. Например, значению P6W соответствует интервал в 6 недель (30 рабочих дней), значению PT300M — интервал в 300 минут (5 часов), значению P0Y0M30DT2H10M25S — интервал в 30 дней, 2 часа, 10 минут, 25 секунд. |
Строка |
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| comment | Текст комментария к записи. Комментарий сохранится в Отчете по трудозатратам | Строка |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит JSON-объект с измененной записью о времени, затраченном на выполнение задачи.
{
"self": "https://api.tracker.yandex.net/v3/issues/TEST-324/worklog/1",
"id": 1,
"version": 1402121720882,
"issue": {
"self": "https://api.tracker.yandex.net/v3/issues/TEST-324",
"id": "515ec9eae4b09cfa********",
"key": "TEST-324",
"display": "My issue"
},
"comment": "My comment",
"createdBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v3/users/11********",
"id": "11********",
"display": "Имя Фамилия"
},
"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": "P1DT40M"
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| 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
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.