4.4. Методы API для индексации форм в Elasticsearch

Продолжая работу по внедрению интеграции Synergy и Elasticsearch, мы реализовали новые методы API для запуска и проверки статуса индексирования форм.

4.4.1. Запуск процесса индексации

Метод начинает индексацию форм.

URL метода: rest/api/admin/forms/index

Тип: POST

Данный метод доступен только пользователям с правами суперадминистратора.

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

  • continue(true, false) - продолжить ли предыдущий индекс, по умолчанию имеет значение false;

  • interval(число) - число, интервал индексации на отдельных данных форм (в мс).

Если индексирование начато, метод возвращает код 200.

Если индексирование уже было начато, то метод возвращает объект json вида:

    { 
        "errorCode": 13, 
        "errorMessage":"Индексирование уже начато" 
    }

4.4.2. Проверка статуса текущего процесса индексации

Метод возвращает статус текущего процесса индексации.

URL метода: rest/api/admin/forms/index

Тип: GET

Данный метод доступен только пользователям с правами суперадминистратора.

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

  • messages(true, false) - возвращать ли сообщения индексирования

Если индексирование идет, метод возвращает код 200.

В противном случае возвращается объект json вида:

    { 
        "running": true, 
        "messages": ["first messages", "second message"] 
    }

где "first messages" и "second message" - сообщения о статусе процесса индексации (подробно этот процесс описан в руководстве администратора).