Подключиться
Yandex Tracker

Добавить запись о затраченном времени

Статья создана

Запрос позволяет добавить запись о времени, затраченном на выполнение задачи.

Примечание

В Yandex Tracker учет времени ведется в рабочих неделях (5 дней) и рабочих днях (8 часов).

Например, если передать временной интервал, равный 5 дням (P5D), в ответе на запрос и при просмотре задачи отобразится значение 1 неделя (P1W).

Формат запроса

Чтобы создать запись о затраченном на задачу времени, используйте HTTP-запрос с методом POST. Параметры запроса передаются в его теле в формате JSON:

POST /v2/issues/<issue-id>/worklog
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>

{
  "start": "2021-09-21T15:30:00.000+0500",
  "duration": "P5DT20M",
  "comment": "важный комментарий"
}
Заголовки

  • Host

    Адрес узла, предоставляющего API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <значение токена>, например:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID

    Идентификатор организации.

Ресурс
Параметр Описание Тип данных
<issues-id> Идентификатор или ключ задачи. Строка
Параметры тела запроса

Обязательные параметры

Параметр Описание Тип данных
start Дата и время начала работы над задачей в формате: YYYY-MM-DDThh:mm:ss.sss±hhmm Строка
duration Затраченное время в формате PnYnMnDTnHnMnS, PnW в соответствии с ISO 8601.

Чтобы отделить часы, минуты, секунды, используйте букву T.

Например, значению P6W соответствует интервал в 6 недель (30 рабочих дней), значению PT300M — интервал в 300 минут (5 часов), значению P0Y0M30DT2H10M25S — интервал в 30 дней, 2 часа, 10 минут, 25 секунд.		 Строка

Дополнительные параметры

Параметр Описание Тип данных
comment Текст комментария к записи. Комментарий сохранится в Отчёте по затратам времени. Строка

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 201 Created.

Тело ответа содержит 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": "2021-09-28T08:42:06.258+0000",
  "updatedAt": "2021-09-28T08:42:06.258+0000",
  "start": "2021-09-21T10:30:00.000+0000",
  "duration": "P1WT20M"
}
Параметры ответа
Параметр Описание Тип данных
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
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
В этой статье: