Узнать количество задач
Запрос позволяет узнать количество задач, удовлетворяющих условиям вашего запроса.
Формат запроса
Перед выполнением запроса получите доступ к API.
Для получения числа задач, удовлетворяющих определенным критериям, используйте HTTP-запрос с методом POST. Критерии для поиска передаются в теле запроса в формате JSON:
POST /v2/issues/_count
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"filter": {
"<имя_поля>": "<значение_в_поле>"
},
"query": "<фильтр_на_языке_запросов>"
}
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net -
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>, например:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-IDи идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
Параметры тела запроса
Дополнительные параметры
| Параметр | Описание | Формат |
|---|---|---|
| filter | Параметры фильтрации задач. В параметре можно указать название любого поля и значение, по которому будет производиться фильтрация. | Объект |
| query | Фильтр на языке запросов. | Строка |
Запрос количества задач с указанием дополнительных параметров фильтрации:
- Используется HTTP-метод POST.
- Ответ должен содержать только количество задач из очереди «JUNE», в которых не указан исполнитель.
POST /v2/issues/_count HTTP/1.1 Host: api.tracker.yandex.net Authorization: OAuth <OAuth-токен> X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации> { "filter": { "queue": "JUNE", "assignee": "empty()" } }
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.
В ответе содержится число задач, удовлетворяющих условиям вашего запроса.
5221186
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.