helpdesk.observer.list
Scope:
helpdeskКто может вызывать: Доступ к обращению.
Список наблюдателей обращения
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ticketId / TICKET_ID |
int |
да* | ID обращения. *Обязателен в одном из мест: query/body или в filter (см. ниже). Если нигде нет / ≤ 0 — INVALID_ID |
limit, offset, fetchAll |
— | нет | Пагинация (как в overview: limit 1–500, offset ≥ 0, fetchAll с лимитом 5000). Список режется in-memory после загрузки наблюдателей обращения |
filter |
object |
нет | Используется только как альтернативный способ передать ticketId |
Параметр filter
Mongo-фильтр наблюдателей не применяется (нет полей вроде userId / login для отбора).
Допустимо только извлечение ID обращения, если top-level ticketId не передан:
| Вариант | Пример |
|---|---|
| Плоское значение | filter[ticketId]=2 или filter[TICKET_ID]=2 |
Оператор $eq |
filter[ticketId][$eq]=2 |
Приоритет: top-level ticketId / TICKET_ID, иначе значение из filter.
Возвращаемые данные
Ответ: массив пользователей { id, login, name, lastName, secondName [, email] }; email — только admin/support.
Пагинация: total / next на верхнем уровне HTTP-ответа; next только если есть следующая страница (overview).
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
INVALID_ID |
Не указан ticketId (ни в параметрах, ни в filter) |
TICKET_NOT_FOUND |
Обращение не найдено |
ACCESS_DENIED |
Нет доступа |
INVALID_LIMIT |
limit < 1 |
LIMIT_TOO_LARGE |
limit > 500 |
INVALID_OFFSET |
offset < 0 |
FETCHALL_LIMIT_EXCEEDED |
При fetchAll=true записей больше 5000 |
INTERNAL |
Внутренняя ошибка |
Пример запроса (GET)
curl -G "https://76575.dev.wehive.digital/rest/1/lus1tijk9ll7mg7h/helpdesk.observer.list.json" -H "Accept: application/json" --data-urlencode "ticketId=2"
Альтернатива через filter:
curl -G "https://76575.dev.wehive.digital/rest/1/lus1tijk9ll7mg7h/helpdesk.observer.list.json" -H "Accept: application/json" --data-urlencode "filter[ticketId][\$eq]=2"
Пример ответа
{
"result": {
"result": [],
"error": null
},
"total": 0
}
См. также
Предыдущая
Следующая