helpdesk.category.list
Scope:
helpdeskКто может вызывать: Любой авторизованный пользователь.
Список категорий обращений с Mongo-фильтром
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
limit, offset, fetchAll, filter |
— | нет | Пагинация и фильтр |
Поля filter (Mongo)
id, name, sid, sort, responsibleId, siteId, isDefault, description.
Возвращаемые данные
Массив категорий { id, name, sid, sort, description, responsibleId, isDefault, siteId, type, event1..3 } в result.result.
Сайты: в list только siteId — строка FIRST_SITE_ID. Полный массив LID (sites) не отдаётся (в отличие от category.get / add/update).
Пагинация: total и при необходимости next — на верхнем уровне HTTP-ответа. Если следующей страницы нет — ключа next нет. Подробнее: overview.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
UNAUTHORIZED |
Пользователь не авторизован |
INVALID_LIMIT |
limit < 1 |
LIMIT_TOO_LARGE |
limit > 500 |
INVALID_OFFSET |
offset < 0 |
INVALID_FILTER |
Некорректный filter или неизвестное поле |
INVALID_FILTER_OPERATOR |
Неизвестный оператор фильтра |
FETCHALL_LIMIT_EXCEEDED |
При fetchAll=true подходящих записей больше защитного лимита (5000) |
INTERNAL |
Внутренняя ошибка сервера |
Пример запроса (GET)
curl -G "https://76575.dev.wehive.digital/rest/1/lus1tijk9ll7mg7h/helpdesk.category.list.json" -H "Accept: application/json" --data-urlencode "limit=2"
Пример ответа
{
"result": {
"result": [
{
"id": 28,
"name": "Служба оснащения - Реклама - Внутреннее и/или внешнее оформление магазина",
"sid": "supply_ads_shop",
"sort": 10,
"description": null,
"responsibleId": 0,
"isDefault": false,
"siteId": "s1",
"type": "C",
"event1": null,
"event2": null,
"event3": null
}
],
"error": null
},
"next": 2,
"total": 11
}
См. также
Предыдущая
Следующая