Отобрать записи по параметрам

Запрос позволяет выбрать данные о времени, затраченном конкретным пользователем или в определенный промежуток времени. Вы можете использовать запрос с методом GET или с методом POST.

GET

https://api.tracker.yandex.net/v3/worklog?createdBy=<логин_или_id_пользователя>&createdAt=from:<начало>&createdAt=to:<окончание>

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

Чтобы получить записи о затраченном времени, используйте HTTP-запрос с методом GET:

GET /v3/worklog?createdBy=<логин_или_id_пользователя>&createdAt=from:<начало>&createdAt=to:<окончание>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
  • 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.

    Чтобы узнать идентификатор организации, перейдите на страницу АдминистрированиеОрганизации и скопируйте значение поля идентификатор.

Параметры запроса

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

Параметр Описание Тип данных
createdBy Идентификатор или логин автора записи. Необязательный параметр. Строка
createdAt=from Начало временного диапазона, в который созданы записи. Формат: YYYY-MM-DDThh:mm:ss.sss±hhmm
Необязательный параметр. При использовании этого параметра укажите значение createdBy.
Строка
createdAt=to Окончание временного диапазона, в который созданы записи. Формат: YYYY-MM-DDThh:mm:ss.sss±hhmm
Необязательный параметр. При использовании этого параметра укажите значение createdBy.
Строка

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

Чтобы получить записи о затраченном времени, используйте HTTP-запрос с методом POST:

POST /v3/worklog/_search
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "createdBy": "veikus",
  "createdAt": {
    "from": "2018-06-06T08:42:15.258",
    "to": "2018-06-06T08:42:20.258"
  }
}
Заголовки
  • 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.

    Чтобы узнать идентификатор организации, перейдите на страницу АдминистрированиеОрганизации и скопируйте значение поля идентификатор.

Параметры тела запроса
Параметр Описание Тип данных
createdBy Идентификатор или логин автора записи. Необязательный параметр. Строка
createdAt Объект с информацией о времени и дате создания записей. Необязательный параметр. Объект

Поля объекта createdAt

Параметр Описание Тип данных
from Начало временного диапазона, в который созданы записи. Формат: YYYY-MM-DDThh:mm:ss.sss±hhmm Строка
to Окончание временного диапазона, в который созданы записи. Формат: YYYY-MM-DDThh:mm:ss.sss±hhmm Строка

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

В случае успешного выполнения запроса 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": "2018-06-06T08:42:06.258+0000",
  "updatedAt": "2018-06-06T08:42:06.258+0000",
  "start": "2018-06-06T08:41:58.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
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.