API модуля he3


НАЧАЛО >> he3 - редактор записей >> Руководство администратора >> API модуля he3📄 Скачать в DOCX


Большинство рабочих действий he3 вызывается как action модуля WIrbis. Ответы рабочих endpoints возвращаются в конверте ApiResponse с признаками success, data и message.

1. Открытие

Action Назначение
he3/Show Самостоятельная HTML-страница редактора.
he3/GetSidEditor JS-действие для открытия модального окна редактора по MFN или SID.
he3/GetSidEditorNew Открытие новой записи; сбрасывает MFN/SID и вызывает GetSidEditor.

2. Схема и черновики

Action Назначение
he3/GetSchema Возвращает схему WS/WSS, defaultFields и вкладку «Добавочные».
he3/InitDraft Создает серверный черновик.
he3/GetDraft Читает черновик по draftId.
he3/UpdateDraft Обновляет черновик и проверяет версию.
he3/CommitDraft Сохраняет черновик в основную базу.

3. Проверка и просмотр

Action Назначение
he3/PreviewDraft Форматирует черновик выбранным PFT.
he3/ValidateDraft Выполняет серверную ФЛК по черновику.

4. Справочники и специализированный ввод

Action Назначение
he3/GetDictionary Меню, словари и узлы деревьев.
he3/GetAuthority Поиск и выбор авторитетных записей.
he3/GetThesaurus Тезаурус: фрагмент, дерево, полный список, путь.
he3/GetServerFiles Список или чтение серверных файлов.
he3/UploadFile Загрузка локального файла.
he3/EvaluateDynInput Вычисление динамического метода ввода через PFT.
he3/EvaluateDynWss Вычисление динамической структуры подполей.
he3/GenerateAiPrompt Подготовка prompt по черновику и PFT.
he3/AskAi Выполнение AI-запроса, если сервис настроен.

5. Версионность черновика

UpdateDraft принимает текущую версию черновика. Если версия на сервере уже изменилась, endpoint возвращает ошибку конфликта. Это защищает от перезаписи данных из устаревшего окна редактора.

Для WSS-схемы в he3/GetSchema нужно передать schemaType=wss и recordFieldTag - номер поля записи, подполя которого описывает WSS. Сервер возвращает схему, привязанную к этому полю записи, а клиентский he3 показывает подполя WSS как строки основного экрана и сохраняет их обратно в recordFieldTag; вкладка «Добавочные» не добавляется.

Для полей с InMode=7 DopInf может быть обычным .mnu или JSON-настройкой вида {"optionsSource":"Module:section"}. В этом случае he3/GetSchema передает в указанный модуль контекст projectKey, recordType, projectObjectTypeKey и получает варианты через GetWorkflowFilterOptions(). Остальные JSON-настройки из DopInf передаются источнику вариантов в settings.