helpdesk.ticket.list

Scope: helpdesk

Кто может вызывать: Авторизованный пользователь; не админ видит только обращения по ACL. Подробнее: Права доступа

Список обращений с Mongo-фильтром и пагинацией

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет Если true — вернуть все строки (лимит 5000)
filter object нет Mongo-фильтр по полям обращения

Поля filter (Mongo)

Поддерживаемые поля: id, title, statusId, criticalityId, priority (≡ criticalityId), categoryId, responsibleId, ownerId, createdAt, closedAt, timestampX, lastMessageDate, lamp, isOverdue, slaId, markId, siteId, sourceId, modifiedBy, messagesCount.

Операторы: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin.

Пагинация

limit (default 50, max 500), offset, fetchAll (защитный лимит 5000, иначе FETCHALL_LIMIT_EXCEEDED).

Возвращаемые данные

  • result.result — массив обращений
  • result.error — null
  • total — верхний уровень HTTP-ответа
  • next — верхний уровень; смещение следующей страницы. Нет в ответе, если следующей страницы нет (см. overview)

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
ACCESS_DENIED Нет доступа (редко на list; фильтр ACL применяется на сервере)
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.ticket.list.json" \
          -H "Accept: application/json" \
          --data-urlencode "limit=20" \
          --data-urlencode "offset=0"

Пример ответа

Последняя страница (total=1, ключа next нет):

{
          "result": {
            "result": [
              {
                "id": 2,
                "title": "Postman test ticket",
                "statusId": 43,
                "criticalityId": 0,
                "priority": 0,
                "categoryId": 0,
                "responsibleId": 0,
                "ownerId": 1,
                "createdAt": "28.08.2026 09:55:50",
                "closedAt": null,
                "timestampX": "28.08.2026 09:55:50",
                "lastMessageDate": "28.08.2026 09:55:50",
                "lamp": "green",
                "isOverdue": false,
                "slaId": 1,
                "markId": 0,
                "siteId": "s1",
                "sourceId": 0,
                "modifiedBy": 0,
                "messagesCount": 1,
                "supportComments": null,
                "supportDeadline": null,
                "isClosed": false
              }
            ],
            "error": null
          },
          "total": 1
        }

Есть следующая страница (limit=1, total=3 → next=1):

{
          "result": {
            "result": [
              { "id": 2, "title": "Postman test ticket", "isClosed": false }
            ],
            "error": null
          },
          "total": 3,
          "next": 1
        }

См. также

Предыдущая
Обзор раздела
Следующая
helpdesk.ticket.get