helpdesk.ticket.search

Scope: helpdesk

Кто может вызывать: Авторизованный; результаты фильтруются по ACL как в ticket.list.

Поиск обращений по тексту (заголовок, индекс TicketSearchTable, stemming)

HTTP: GET

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

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

Параметр Тип Обяз. Описание
query string да Поисковый запрос (мин. 3 символа; алиасы: q, search, SEARCH_WORD)
limit, offset, fetchAll, filter — нет Как в ticket.list

Примечание

При запросе короче 3 символов:

{
          "result": {
            "result": null,
            "error": {
              "code": "SEARCH_TOO_SHORT",
              "message": "Поисковый запрос должен содержать не менее 3 символов.",
              "details": { "min": 3 }
            }
          }
        }

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

  • result.result — массив обращений
  • total / next — верхний уровень; next только если есть следующая страница (overview)

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Пустой query
SEARCH_TOO_SHORT Менее 3 символов
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.search.json" -H "Accept: application/json" --data-urlencode "query=Postman" --data-urlencode "limit=10"

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

{
          "result": {
            "result": [
              {
                "id": 2,
                "title": "Postman test ticket",
                "statusId": 43,
                "priority": 0,
                "isClosed": false
              }
            ],
            "error": null
          },
          "total": 1
        }

См. также

Предыдущая
helpdesk.ticket.assign
Следующая
helpdesk.ticket.getMy