Функции могут быть вызваны как UseModule("API")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| CheckHealth | Проверить состояние API-контрактов
Подробнее...
Выполняет безопасную health-проверку модуля API: наличие legacy JSON-RPC контракта, валидность metadata APIContract, IntegrationAdapterProfile, MappingProfile, ExternalId, SyncPolicy и ConflictPolicy, корректность ссылок профилей, наличие SyncPolicy для bidirectional-профилей и отсутствие secret values в экспорте. | Отсутствуют |
| DeactivateExternalId | Деактивировать ExternalId
Подробнее...
Переводит активную связь ExternalId в неактивное состояние после безопасного lookup и проверки прав. Функция не удаляет доменную запись и не выполняет синхронизацию. | | Тип | Параметр | По умолчанию | Описание | | String | $adapterProfileKey | '' | Ключ IntegrationAdapterProfile. | | String | $externalSystem | '' | Внешняя система. | | String | $objectType | '' | Внутренний тип объекта. | | String | $externalId | '' | Внешний идентификатор. | | Boolean | $skipRightsCheck | false | Пропустить проверку прав. Допустимо только для системного setup/TestA с контролируемым вызовом. |
|
| DryRunMapping | Выполнить dry-run mapping
Подробнее...
Проверяет payload по MappingProfile без сохранения записи и без побочных эффектов: строит normalized result, matched ExternalId, proposed changes, required permissions, workflow/user/file mapping и безопасные diagnostics. | | Тип | Параметр | По умолчанию | Описание | | Array | $request | array (
) | Dry-run запрос: mappingProfileKey или adapterProfileKey/objectType, direction, operation, externalSystem, traceId и payload. |
|
| DryRunSync | Выполнить dry-run sync
Подробнее...
Строит SyncPlan для bidirectional sync/conflict resolution без побочных эффектов: вызывает DryRunMapping, подбирает SyncPolicy и ConflictPolicy, классифицирует field-level conflicts, выбирает explainable decision, формирует SyncApplyRequest contract, idempotency fingerprint, TraceContext и Security summary. | | Тип | Параметр | По умолчанию | Описание | | Array | $request | array (
) | Dry-run sync запрос: syncPolicyKey или adapterProfileKey/objectType, mappingProfileKey, conflictPolicyKey, operation, direction, traceId, idempotencyKey, payload, internalSnapshot и optional diagnostic flags. |
|
| ExportContractRegistry | Экспортировать реестр API-контрактов
Подробнее...
Возвращает машиночитаемый экспорт реестра API: APIContract, IntegrationAdapterProfile, MappingProfile, ExternalId, SyncPolicy, ConflictPolicy, схемы профиля интеграции, mapping, внешних идентификаторов, sync/apply contract, идемпотентности и диагностики, а также границы ответственности зависимых модулей. | | Тип | Параметр | По умолчанию | Описание | | Boolean | $includeDraft | false | Включать черновики контрактов и профилей. |
|
| GetAdapterProfileSchema | Получить схему профиля внешней интеграции
Подробнее...
Возвращает схему IntegrationAdapterProfile: обязательные поля, безопасные ссылки на Secrets, ссылки на mapping metadata/MappingProfile/SyncPolicy, idempotency policy и границы ответственности между API, transport-модулями, Security, Secrets и доменными модулями. | Отсутствуют |
| GetConflictPolicies | Получить ConflictPolicy
Подробнее...
Возвращает политики разрешения конфликтов API из управляемых записей: strategy, timestamp policy, manual resolver, domain module, allowed conflict classes, branches, required permissions и безопасные metadata. | | Тип | Параметр | По умолчанию | Описание | | Boolean | $includeDraft | false | Включать черновики ConflictPolicy. | | Array | $filters | array (
) | Фильтры по key, adapterProfileKey, objectType, operation или strategy. |
|
| GetConflictPolicy | Получить ConflictPolicy по ключу
Подробнее...
Возвращает одну политику разрешения конфликтов API по стабильному ключу. Черновики возвращаются только при includeDraft=true. | | Тип | Параметр | По умолчанию | Описание | | String | $conflictPolicyKey | '' | Ключ ConflictPolicy. | | Boolean | $includeDraft | false | Включать черновики и выключенные записи. |
|
| GetConflictPolicySchema | Получить схему ConflictPolicy
Подробнее...
Возвращает схему политики разрешения конфликтов API: strategy, timestamp policy, manual resolver, domain module, allowed conflict classes, branches, required permissions и границы ответственности. | Отсутствуют |
| GetConflictPolicyWhereUsed | Показать использование ConflictPolicy
Подробнее...
Возвращает where-used по ConflictPolicy: сами политики и ссылки на них из SyncPolicy, включая operation-level override. | | Тип | Параметр | По умолчанию | Описание | | String | $conflictPolicyKey | '' | Ключ ConflictPolicy. | | String | $adapterProfileKey | '' | Ключ IntegrationAdapterProfile. | | String | $objectType | '' | Object type. | | String | $operation | '' | Операция sync. |
|
| GetContractDefinition | Получить API-контракт по ключу
Подробнее...
Возвращает один APIContract из реестра модуля API по стабильному ключу. Используется profile-настройками, экспортом, диагностикой и будущими integration adapter-ами. | | Тип | Параметр | По умолчанию | Описание | | String | $contractKey | '' | Стабильный ключ API-контракта. | | Boolean | $includeDraft | false | Искать также среди черновиков. |
|
| GetContractDefinitions | Получить реестр API-контрактов
Подробнее...
Возвращает список APIContract: системный legacy JSON-RPC контракт и дополнительные API-контракты, заведенные как записи модуля API. По умолчанию черновики скрыты; параметр includeDraft включает их в административный экспорт и HealthCheck. | | Тип | Параметр | По умолчанию | Описание | | Boolean | $includeDraft | false | Включать черновики API-контрактов. |
|
| GetDiagnosticsSchema | Получить схему диагностики API
Подробнее...
Возвращает безопасную схему diagnostics для API-контрактов, методов, profiles, MappingProfile, ExternalId, SyncPolicy и ConflictPolicy. Схема фиксирует contract version, profile, mapping, object type, sync operation, conflict class, external id, subject, trace id, idempotency/security decisions и запрещает раскрытие секретов, скрытых полей и персональных данных без прав. | Отсутствуют |
| GetExternalIdSchema | Получить схему ExternalId
Подробнее...
Возвращает схему записи ExternalId: связь external system, adapter profile, object type, external id и внутренней record reference, правила жизненного цикла и область lookup без раскрытия закрытых данных. | Отсутствуют |
| GetExternalIdWhereUsed | Показать использование ExternalId
Подробнее...
Возвращает безопасный where-used для ExternalId: связанные записи ExternalId, mapping profiles, sync policies и опубликованные API-методы, которые могут использовать эти profiles. Функция не раскрывает закрытые данные доменных записей. | | Тип | Параметр | По умолчанию | Описание | | String | $externalId | '' | Внешний идентификатор. | | String | $adapterProfileKey | '' | Ключ IntegrationAdapterProfile. | | String | $externalSystem | '' | Внешняя система. | | String | $objectType | '' | Внутренний object type. | | String | $recordKey | '' | Стабильный внутренний ключ записи. | | String | $recordRef | '' | Внутренняя ссылка на запись, например SID. |
|
| GetExternalIds | Получить реестр ExternalId
Подробнее...
Возвращает записи ExternalId из модуля API. По умолчанию показывает только активные связи; фильтры позволяют ограничить результат по adapterProfileKey, externalSystem, objectType, externalId, recordKey или recordRef. | | Тип | Параметр | По умолчанию | Описание | | Boolean | $includeInactive | false | Включать неактивные, конфликтные и архивные связи ExternalId. | | Array | $filters | array (
) | Фильтры по полям ExternalId: adapterProfileKey, externalSystem, objectType, externalId, recordKey, recordRef. |
|
| GetIdempotencyPolicySchema | Получить схему идемпотентности API
Подробнее...
Возвращает общий API-level контракт идемпотентности для изменяющих операций и sync dry-run: состав scope, fingerprint payload/SyncPlan, TTL и решения при первом вызове, повторе с тем же payload и конфликте с другим payload. | Отсутствуют |
| GetIntegrationAdapterProfiles | Получить профили внешней интеграции
Подробнее...
Возвращает список IntegrationAdapterProfile, заведенных как записи модуля API. Профиль содержит ссылку на APIContract, transport profile, security subject, secret refs, mapping metadata, idempotency policy, external id policy, dry-run и безопасные диагностические признаки. | | Тип | Параметр | По умолчанию | Описание | | Boolean | $includeDraft | false | Включать черновики профилей интеграции. |
|
| GetJsonRPCServer | Получить JSON-RPC сервер модуля API
Подробнее...
Создает объект JSON-RPC сервера модуля API. Сервер сохраняет совместимость с существующей точкой JSONRPC.php?i128Module=API и публикует legacy-методы работы с читателями, заказами, продлением, поиском, терминами, фасетами и экземплярами. | Отсутствуют |
| GetLegacyJsonRpcMethodMetadata | Получить metadata legacy JSON-RPC методов API
Подробнее...
Возвращает стандартизированное описание существующих JSON-RPC методов модуля API без изменения их поведения: ключ метода, модуль-владелец, параметры, тип ответа, права, класс идемпотентности, поддержку TraceContext и dry-run. | Отсутствуют |
| GetMappingProfile | Получить один mapping profile
Подробнее...
Возвращает MappingProfile по стабильному ключу. Черновик возвращается только при includeDraft=true, чтобы публичный runtime не использовал неопубликованные настройки. | | Тип | Параметр | По умолчанию | Описание | | String | $mappingProfileKey | '' | Ключ mapping profile. | | Boolean | $includeDraft | false | Разрешить возврат черновика. |
|
| GetMappingProfileSchema | Получить схему mapping profile
Подробнее...
Возвращает схему MappingProfile для внешних интеграций: связь с IntegrationAdapterProfile и APIContract, object type, external id field, правила field/workflow/participant/file mapping и границы ответственности зависимых модулей. | Отсутствуют |
| GetMappingProfiles | Получить mapping profiles
Подробнее...
Возвращает записи MappingProfile модуля API: связь с IntegrationAdapterProfile и APIContract, object type, направление, external id field, field/workflow/participant/file mapping, required permissions и безопасные metadata для dry-run. | | Тип | Параметр | По умолчанию | Описание | | Boolean | $includeDraft | false | Включать черновики mapping profile. | | Array | $filters | array (
) | Фильтры по key, adapterProfileKey, contractKey, objectType, externalSystem или direction. |
|
| GetObjectExternalIds | Получить ExternalId внутреннего объекта
Подробнее...
Возвращает все ExternalId, связанные с внутренним object type и record key или record reference. Один внутренний объект может иметь несколько external ids в разных profiles и external systems. | | Тип | Параметр | По умолчанию | Описание | | String | $objectType | '' | Внутренний тип объекта. | | String | $recordKey | '' | Стабильный ключ внутренней записи. | | String | $recordRef | '' | Внутренняя ссылка на запись, например SID. | | String | $adapterProfileKey | '' | Опциональный фильтр по IntegrationAdapterProfile. | | String | $externalSystem | '' | Опциональный фильтр по внешней системе. | | Boolean | $includeInactive | false | Включать неактивные, конфликтные и архивные связи. |
|
| GetSyncApplyContractSchema | Получить схему SyncApply contract
Подробнее...
Возвращает стандартный контракт SyncPlan, SyncApplyRequest и SyncApplyResult для передачи результата анализа синхронизации доменному модулю без прямого изменения записей внутри API. | Отсутствуют |
| GetSyncPolicies | Получить SyncPolicy
Подробнее...
Возвращает политики синхронизации API из управляемых записей: связь с IntegrationAdapterProfile, APIContract, MappingProfile, object type, direction, source-of-truth, ConflictPolicy, идемпотентность, TraceContext и operation policies. | | Тип | Параметр | По умолчанию | Описание | | Boolean | $includeDraft | false | Включать черновики SyncPolicy. | | Array | $filters | array (
) | Фильтры по key, adapterProfileKey, mappingProfileKey, conflictPolicyKey, objectType, operation или direction. |
|
| GetSyncPolicy | Получить SyncPolicy по ключу
Подробнее...
Возвращает одну политику синхронизации API по стабильному ключу. Черновики возвращаются только при includeDraft=true. | | Тип | Параметр | По умолчанию | Описание | | String | $syncPolicyKey | '' | Ключ SyncPolicy. | | Boolean | $includeDraft | false | Включать черновики и выключенные записи. |
|
| GetSyncPolicySchema | Получить схему SyncPolicy
Подробнее...
Возвращает схему политики синхронизации API: связь с профилем интеграции, APIContract, MappingProfile, object type, направлением, source-of-truth, ConflictPolicy, идемпотентностью, TraceContext, retry eligibility и operation policies. | Отсутствуют |
| GetSyncPolicyWhereUsed | Показать использование SyncPolicy
Подробнее...
Возвращает where-used по SyncPolicy: политики, adapter profiles, MappingProfile, ConflictPolicy, object type и operations, связанные с заданными фильтрами. | | Тип | Параметр | По умолчанию | Описание | | String | $syncPolicyKey | '' | Ключ SyncPolicy. | | String | $adapterProfileKey | '' | Ключ IntegrationAdapterProfile. | | String | $mappingProfileKey | '' | Ключ MappingProfile. | | String | $conflictPolicyKey | '' | Ключ ConflictPolicy. | | String | $objectType | '' | Object type. | | String | $operation | '' | Операция sync. |
|
| LookupExternalId | Найти запись по ExternalId
Подробнее...
Выполняет безопасный lookup внутренней записи по ExternalId в области adapter profile + external system + object type + external id. При неоднозначности возвращает ошибку и не выбирает случайную запись. | | Тип | Параметр | По умолчанию | Описание | | String | $adapterProfileKey | '' | Ключ IntegrationAdapterProfile. | | String | $externalSystem | '' | Внешняя система. | | String | $objectType | '' | Внутренний тип объекта. | | String | $externalId | '' | Внешний идентификатор объекта. |
|
| PrepareRecordIndexes | Подготовить индексы API-записи
Подробнее...
Обновляет поле 920 и поисковые термины 1288 для API-контракта, профиля интеграции, MappingProfile, ExternalId, SyncPolicy и ConflictPolicy: ключ, тип записи, статус, методы, profiles, external ids, object types, field keys, workflow-ссылки, operations, decisions и conflict classes. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataRecord | $record | Обязательный | Запись API-контракта или профиля интеграции. |
|
| RegisterExternalId | Зарегистрировать ExternalId
Подробнее...
Создает или обновляет запись ExternalId в модуле API после проверки прав, обязательных полей, уникальности активной связи и отсутствия secret values. Функция не изменяет доменную запись. | | Тип | Параметр | По умолчанию | Описание | | Array | $externalId | array (
) | ExternalId metadata для регистрации. | | Boolean | $skipRightsCheck | false | Пропустить проверку прав. Допустимо только для системного setup/TestA с контролируемым вызовом. |
|
| ValidateAdapterProfile | Проверить профиль внешней интеграции
Подробнее...
Проверяет структуру IntegrationAdapterProfile: обязательные поля, направление обмена, ссылку на APIContract, массивы secretRefs и mappingMetadata, а также отсутствие паролей, tokens, private keys и других secret values. | | Тип | Параметр | По умолчанию | Описание | | Array | $profile | array (
) | IntegrationAdapterProfile в виде массива metadata. |
|
| ValidateConflictPolicy | Проверить ConflictPolicy
Подробнее...
Проверяет ConflictPolicy: обязательные поля, strategy, safety-инварианты last-writer-wins и manual-resolution, ветви решений, стандартные conflict classes и отсутствие secret values. | | Тип | Параметр | По умолчанию | Описание | | Array | $policy | array (
) | ConflictPolicy metadata. |
|
| ValidateContractMetadata | Проверить metadata API-контракта
Подробнее...
Проверяет структуру APIContract: обязательные поля, supported transports, metadata методов, параметры, response schema, rights metadata и отсутствие secret values. Функция не исполняет API-методы и не заменяет runtime-проверку прав. | | Тип | Параметр | По умолчанию | Описание | | Array | $contract | array (
) | APIContract в виде массива metadata. |
|
| ValidateExternalId | Проверить ExternalId
Подробнее...
Проверяет ExternalId: обязательные поля lookup, статус, направление, внутреннюю record reference, отсутствие secret values и конфликт активного дубля в той же области adapter profile + external system + object type + external id. | | Тип | Параметр | По умолчанию | Описание | | Array | $externalId | array (
) | ExternalId metadata. |
|
| ValidateMappingProfile | Проверить mapping profile
Подробнее...
Проверяет MappingProfile: обязательные поля, направление, массивы правил, запрет физических номеров полей и путей, ссылки на workflow/resolver/FT metadata и отсутствие secret values. | | Тип | Параметр | По умолчанию | Описание | | Array | $profile | array (
) | MappingProfile metadata. |
|
| ValidateSyncPolicy | Проверить SyncPolicy
Подробнее...
Проверяет SyncPolicy: обязательные поля, направление, source-of-truth, безопасное решение по умолчанию, operation policies, ссылку на MappingProfile для mapping-операций и отсутствие secret values. | | Тип | Параметр | По умолчанию | Описание | | Array | $policy | array (
) | SyncPolicy metadata. |
|