SterBasedocs
ster.by

Runtime API

61 операция собственного runtime API SterBase: подключение named pipe, контекст сеанса, формы, данные, результаты и восстановление.

Runtime API — собственный локальный интерфейс работающего Enterprise SterBase. Он работает с текущим пользователем, базой и открытыми объектами через named pipe. Это самостоятельный runtime SterBase; нативная платформа 1С для выполнения этих операций не используется.

Каталог включает 61 операцию. Перед работой проверьте session_describe, доступные возможности сеанса и актуальный контекст. Внешний MCP-адаптер вызывает этот же API, а C ABI и C++ SDK служат для интеграции на другом уровне.

Полный каталог операций runtime API

Операция runtime APIНазначениеСтандартный внешний MCP
session_describeТекущая база, пользователь, права, готовность и поддерживаемые операции.sterbase_session_describe
reference_getЧтение по устойчивому адресу ContextReference; константы, планы и счета, документы и справочники. Текущая база и права проверяются заново.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
system_parameters_getРабочая дата, режим блокировки справочников/констант и ревизия системных параметров.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
system_parameters_setИзменение поддерживаемого параметра working_date или lock_catalogs_and_constants с expected_revision.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
form_context_actionsКонтекстные команды доступного элемента формы; результат содержит опубликованные токены действий.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
form_context_invokeВыполнение контекстного действия через тот же обработчик, что используется приложением.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
constants_openОткрытие журнала констант с текущими правами и значениями на рабочую дату.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
periodic_history_openОткрытие истории периодического реквизита по объекту/полю либо принадлежащей API карточке.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
periodic_manageШтатная команда периодических реквизитов для открытой формы; при необходимости возвращает выбор реквизита.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_rowsЧтение страницы строк табличного редактора, до 200 строк, с актуальной ревизией.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_selectВыбор строки табличного редактора.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_dateДата представления периодических значений.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_editНачало редактирования выбранной строки.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_newЧерновик новой строки периодической истории.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_setЗадание скалярного значения/даты или типизированной ссылки черновика.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_saveСохранение через общий обработчик с committed и readback_confirmed.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_chooseТипизированный подбор значения с продолжением selection_get/selection_choose.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_clearОчистка значения текущего черновика.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_cancelОтмена несохранённого изменения.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_deleteУдаление разрешённой записи истории через её штатный жизненный цикл.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_historyИстория выбранной константы или реквизита.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
tabular_refreshОбновление представления без повторной записи.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
period_dialog_getЧтение принадлежащего операции календарного диалога без его подтверждения.sterbase_period_dialog_get
period_dialog_completeПрименение или отмена периода через штатный обработчик диалога.sterbase_period_dialog_complete
list_period_setИзменение периода своего журнала с сохранением фильтров и порядка.sterbase_list_period_set
accounting_totals_recalculateШтатный пересчёт итогов с подтверждением, правом обслуживания и фактическим монопольным доступом.sterbase_accounting_totals_recalculate
marked_delete_openОткрытие штатного удаления помеченных объектов; список выбора изначально пуст.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
marked_delete_selectЯвный выбор объектов в принадлежащем API сеансе удаления.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
marked_delete_checkПроверка ссылок и допустимости удаления выбранных объектов.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
marked_delete_executeПодтверждённое удаление выбранного набора с проверкой ревизии и текущих прав; результат проверяется по объектам.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
marked_delete_closeЗакрытие принадлежащего API сеанса удаления.Прямой runtime API; отдельный инструмент стандартного адаптера не опубликован.
selection_getЧтение ожидающего типизированного выбора, включая печатную форму; операция ничего не выбирает.sterbase_selection_get
selection_chooseПродолжение опубликованного выбора: index начинается с нуля, -1 отменяет.sterbase_selection_choose
forms_listРеальные открытые формы без передачи владения пользовательскими окнами.sterbase_forms_list
form_viewsВкладки и табличные области с ревизией и токенами навигации.sterbase_form_views
form_view_setПереход к вкладке или строке через обычный обработчик, без записи и проведения.sterbase_form_view_set
metadata_listПостраничный список читаемых метаданных.sterbase_metadata_list
metadata_getПоля метаданных, типы, длины, точность и допустимые ссылочные цели.sterbase_metadata_get
object_listЧтение справочников и документов без открытия формы.sterbase_object_list
object_getЧтение точного объекта и его полей/строк по выданному токену.sterbase_object_get
list_openОткрытие списка или бухгалтерского журнала, при необходимости с периодом.sterbase_list_open
form_getСемантическое состояние своей формы; закрытый токен не переадресуется другому окну.sterbase_form_get
list_selectВыбор точного объекта и выполнение обработчиков позиционирования.sterbase_list_select
list_activateАктивация объекта с учётом перенаправления формы или штатной отмены.sterbase_list_activate
form_snapshotPNG-снимок готовой собственной формы вместе с её состоянием.sterbase_form_snapshot
form_closeШтатное закрытие собственной формы с уважением отказа обработчика.sterbase_form_close
session_closeЗакрытие только принадлежащих API форм в обратном порядке.sterbase_session_close
session_shutdownЗавершение форм и явно назначенного собственного сеанса.sterbase_session_shutdown
operation_getОпрос запущенной операции без повторения побочных эффектов; показывает доступные дочерние формы.sterbase_operation_get
form_setИзменение опубликованных полей через обычные обработчики; не подтверждает запись.sterbase_form_set
form_actionsДоступные действия формы с одноразовыми токенами и ревизией.sterbase_form_actions
form_invokeВыполнение опубликованного действия через обычный обработчик команды.sterbase_form_invoke
form_openОткрытие отчёта или обработки по точным метаданным.sterbase_form_open
object_draft_createЧерновик справочника или документа в памяти.sterbase_object_draft_create
object_draft_applyТипизированные поля и полный набор строк версии черновика.sterbase_object_draft_apply
reference_selectПостраничный подбор типизированной ссылки с ограничениями поля.sterbase_reference_select
object_createФиксация подготовленного черновика через штатную запись; повтор того же черновика сверяет прежний результат.sterbase_object_create
object_saveЗапись полей существующего объекта с контролем версии и состояния commit.sterbase_object_save
object_set_delete_markУстановка или снятие пометки удаления по текущим правам.sterbase_object_set_delete_mark
document_set_postedПроведение или отмена через общий жизненный цикл; открытая карточка требует владения и ревизии.sterbase_document_set_posted
accounting_totalЧтение бухгалтерского показателя за период по счёту.sterbase_accounting_total

Подключение и первый запрос

Работающий Enterprise публикует локальный endpoint SterBase-api-<PID>; имя можно задать переменной STERBASE_API_PIPE. Доступен только текущий пользователь Windows, сетевые клиенты pipe отклоняются. Python-клиент использует Python 3 и pywin32; после подключения сначала проверяйте session_describe.

from sterbase_api_client import Client

api = Client("SterBase-api-<PID>")
try:
    session = api.call("session_describe")
    if session.get("ok") and session.get("state") == "ready":
        page = api.call("metadata_list", object_kind="catalog", limit=50)
finally:
    api.close()

Это пример чтения. Идентификаторы метаданных, токены и ревизии берутся из ответа текущего сеанса, а не угадываются. Для следующей страницы используется возвращённый cursor. Операции с данными выполняются под правами пользователя базы.

Результат, ожидание и восстановление

Изменяющий вызов отправляют один раз. Если получен operation_token, последующие запросы идут в operation_get; повтор открытия, записи или проведения не является опросом. operation_state описывает завершение команды, state — в том числе готовность результирующей формы. При pending требуется ожидать, а при interaction_required — обработать опубликованный выбор или дочернюю форму.

Перед изменением проверяются владение формой, тип токена и expected_revision. version_token относится к версии объекта, form_revision — к форме. form_set меняет поля и вызывает их обработчики, но сам по себе не подтверждает запись. Изменения нескольких полей могут быть частичными; проверяйте applied_count.

Фактическое сохранение определяется committed и контрольным чтением. reconciliation_required либо неизвестный исход требуют сверки до нового изменения. Внешний API не обещает долговечный exactly-once журнал после перезапуска. Устойчивый ContextReference сохраняет адрес для чтения, но не старые разрешения или временные токены.

Общие поля запроса и ограничения

Поле / пределКонтракт
operationСтроковое поле wire API; используется только поддерживающей его операцией.
form_tokenСтроковое поле wire API; используется только поддерживающей его операцией.
object_kindСтроковое поле wire API; используется только поддерживающей его операцией.
metadata_idСтроковое поле wire API; используется только поддерживающей его операцией.
object_tokenСтроковое поле wire API; используется только поддерживающей его операцией.
cursorСтроковое поле wire API; используется только поддерживающей его операцией.
limitСтроковое поле wire API; используется только поддерживающей его операцией.
action_tokenСтроковое поле wire API; используется только поддерживающей его операцией.
expected_revisionСтроковое поле wire API; используется только поддерживающей его операцией.
operation_tokenСтроковое поле wire API; используется только поддерживающей его операцией.
draft_tokenСтроковое поле wire API; используется только поддерживающей его операцией.
version_tokenСтроковое поле wire API; используется только поддерживающей его операцией.
field_tokenСтроковое поле wire API; используется только поддерживающей его операцией.
queryСтроковое поле wire API; используется только поддерживающей его операцией.
flagСтроковое поле wire API; используется только поддерживающей его операцией.
period_fromСтроковое поле wire API; используется только поддерживающей его операцией.
period_toСтроковое поле wire API; используется только поддерживающей его операцией.
account_codeСтроковое поле wire API; используется только поддерживающей его операцией.
metricСтроковое поле wire API; используется только поддерживающей его операцией.

Wire v1: little-endian uint32 длины, UTF-8 поля, changes и rows. Запрос до 65 536 байт, ответ до 16 MiB. Даты — ISO YYYY-MM-DD в соответствующих полях; Python-клиент преобразует допустимые скалярные значения в wire-представление. Точные типы и required поля стандартного MCP ниже заданы JSON Schema.

reference_get читает catalog/document/constant/chart/account. Для периодической константы требуется явная дата; при готовом reference_path в query не смешивают новые селекторы. Табличный редактор требует актуальную ревизию; записи истории, созданные документом, доступны для просмотра, а не произвольной ручной перезаписи.

Поиск по SterBase

Загрузка индекса…

Индекс хранится на сайте. Поисковые запросы не отправляются внешним сервисам.