Импортировать записи о затраченном времени
С помощью запроса вы можете импортировать в Трекер записи о времени, затраченном на задачу.
POST
https://api.tracker.yandex.net/v3/issues/<id_задачи>/worklogs/_import
Запрос может быть выполнен только от имени администратора.
Формат запроса
Чтобы импортировать запись о затраченном времени, используйте HTTP-запрос с методом POST. Параметры записи передаются в теле запроса в формате JSON:
POST /v3/issues/<id_задачи>/worklogs/_import
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
Content-Type: application/json
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"duration": "PT1H",
"createdAt": "2025-02-18T16:35:41.740+0000",
"createdBy": "username",
"start": "2025-02-18T16:35:41.740+0000"
}
Заголовки
-
Host: адрес узла, предоставляющего API. -
Authorization: токен для авторизации в одном из форматов:-
OAuth <OAuth-токен>при авторизации по протоколу OAuth 2.0. Читать подробнее -
Bearer <IAM-токен>при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее
-
-
Content-Type: формат тела запроса. Должен иметь значениеapplication/json. -
X-Org-IDилиX-Cloud-Org-ID: идентификатор организации.-
если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок
X-Org-ID, -
если к Трекеру привязана организация Yandex Cloud Organization, используйте заголовок
X-Cloud-Org-ID.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.
-
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <id_задачи> | Ключ задачи, для которой импортируется запись о затраченном времени. | Строка |
Параметры тела запроса
Обязательные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| duration | Затраченное время в формате PnYnMnDTnHnMnS, PnW в соответствии с ISO 8601. Текст ISO 8601Чтобы отделить часы, минуты, секунды, используйте букву T. Например, значению P6W соответствует интервал в 6 недель (30 рабочих дней), значению PT300M — интервал в 300 минут (5 часов), значению P0Y0M30DT2H10M25S — интервал в 30 дней, 2 часа, 10 минут, 25 секунд. |
Строка |
| createdAt | Дата и время создания записи о затраченном времени в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Вы можете указать время в интервале от создания до последнего обновления задачи, для которой импортируется запись о затраченном времени. |
Строка |
| createdBy | Логин или идентификатор пользователя, сделавшего запись о затраченном времени. |
|
| start | Дата и время начала работы над задачей в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm |
Строка |
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| comment | Текст комментария к записи. Комментарий сохранится в Отчете по трудозатратам. | Строка |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
Тело ответа содержит данные записи о затраченном времени в формате JSON:
{
"self": "https://api.tracker.yandex.net/v3/issues/ISSUE-1/worklog/37",
"id": 37,
"version": 1,
"issue": {
"self": "https://api.tracker.yandex.net/v3/issues/ISSUE-1",
"id": "66e4********************",
"key": "ISSUE-1",
"display": "My issue 1"
},
"comment": "My comment",
"createdBy": {
"self": "https://api.tracker.yandex.net/v3/users/80***************",
"id": "80***************",
"display": "Username",
"cloudUid": "aj***************",
"passportUid": 196******
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v3/users/80***************",
"id": "80***************",
"display": "Username",
"cloudUid": "aj***************",
"passportUid": 196******
},
"createdAt": "2025-02-18T16:35:41.740+0000",
"updatedAt": "2025-02-18T16:35:41.740+0000",
"start": "2025-02-18T16:35:41.740+0000",
"duration": "P1DT1H"
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о записи о затраченном времени. | Строка |
| id | Идентификатор записи о затраченном времени. | Число |
| version | Версия записи. | Число |
| issue | Блок с информацией о задаче. | Объект |
| comment | Текст комментария к записи. Комментарий сохранится в Отчете по трудозатратам. | Строка |
| createdBy | Блок с информацией о создателе записи. | Объект |
| updatedBy | Блок с информацией о последнем изменившем запись пользователе. | Объект |
| createdAt | Дата и время создания записи о затраченном времени. | Строка |
| updatedAt | Дата и время изменения записи о затраченном времени. | Строка |
| start | Дата и время начала работы над задачей в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm |
Строка |
| duration | Затраченное время в формате PnYnMnDTnHnMnS, PnW в соответствии с ISO 8601. Текст ISO 8601 |
Строка |
Поля объекта issue
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о задаче. | Строка |
| id | Адрес ресурса API, который содержит информацию о задаче. | Строка |
| key | Ключ задачи. | Строка |
| display | Отображаемое имя задачи. | Строка |
Поля объекта createdBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на пользователя. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
| cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Поля объекта updatedBy
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Ссылка на пользователя. | Строка |
| id | Идентификатор пользователя. | Строка |
| display | Отображаемое имя пользователя. | Строка |
| passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число |
| cloudUid | Уникальный идентификатор пользователя в Yandex Cloud Organization. | Строка |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.