Параметры записей типа API


НАЧАЛО >> Оглавление >> Сервер приложений ИРБИС 64/128 >> Описание модулей системы >> API - API ИРБИС 64/128 >> Параметры записей типа API📄 Скачать в DOCX


ИмяОписаниеЗначение по умолчаниюТипПоле хранения
ApiKey

Ключ

Стабильный технический ключ API-контракта или профиля интеграции. Используется в ссылках, экспорте, HealthCheck и TestA; после публикации менять его нельзя без миграции ссылок.

String1^A
ApiTitle

Название

Понятное администратору название записи. Отображается в списках, экспорте и диагностике.

String1^B
ApiKind

Тип записи

Определяет, что описывает запись: APIContract, IntegrationAdapterProfile, MappingProfile, ExternalId, SyncPolicy или ConflictPolicy.

contractSelect1^C
ApiVersion

Версия

Версия контракта или профиля. Внешние потребители должны ссылаться на конкретную версию, чтобы обновления были контролируемыми.

1.0String1^D
ApiStatus

Статус публикации

Черновики доступны администраторам и HealthCheck при проверке с includeDraft. В обычный публичный экспорт попадают опубликованные и устаревающие записи.

draftSelect1^E
ApiPurpose

Назначение

Краткое описание того, для чего нужен контракт или профиль интеграции.

TextArea1^F
SupportedTransports

Транспорты

Список транспортов через запятую, например jsonrpc или rest. Transport-модули остаются владельцами приема запросов; API хранит только ссылку на поддерживаемый способ публикации.

jsonrpcString1^G
CompatibilityPolicy

Совместимость

Правило совместимости версии: backward-compatible, breaking, legacy-compatible или другое согласованное значение.

backward-compatibleString1^H
DeprecationPolicy

Правило устаревания

Когда и как контракт или метод могут быть объявлены устаревающими, какие версии остаются доступными и как предупреждаются потребители.

TextArea1^I
HelpRef

Раздел Help

Ключ раздела Help, где описан контракт или профиль, например API/Contracts.

String1^J
TestARefs

TestA-проверки

Список ID TestA-проверок через запятую. Используется для приемки и HealthCheck покрытия API-поверхности.

String1^K
ContractMethods

Методы

Методы, входящие в API-контракт. Legacy JSON-RPC методы добавляются системно; этот список нужен для дополнительных контрактов.

MultyOcc2
ContractResources

Ресурсы

Логические ресурсы, которые описывает контракт: читатели, заказы, записи каталога, термины, фасеты и т.д.

MultyOcc3
ExternalSystem

Внешняя система

Название или класс внешней системы, для которой создается профиль интеграции.

String5^A
ExchangeDirection

Направление обмена

Направление обмена данными. Профиль фиксирует metadata, а policy sync/conflict настраиваются отдельными записями SyncPolicy и ConflictPolicy.

noneSelect5^B
ContractKey

API-контракт

Ключ API-контракта, на который ссылается профиль.

api.legacy-jsonrpc.v1String5^C
ContractVersion

Версия контракта

Версия API-контракта, с которой совместим профиль.

1.0String5^D
TransportProfile

Профиль транспорта

Ссылка на настройки JSONRPC/REST/другого transport-layer. Значения секретов здесь не хранятся.

String5^E
SecuritySubject

Security subject

Сервисная учетная запись, роль или subject, от имени которого работает интеграция. Проверку прав выполняет Security.

String5^F
ServiceAccount

Сервисная учетная запись

Опциональная учетная запись интеграции. Не храните здесь пароль, token или secret value.

String5^G
ProfileDryRun

Dry-run по умолчанию

Если включено, профиль предназначен для проверки без применения изменений до отдельного разрешения администратора.

1Select5^H
IdempotencyPolicy

Политика идемпотентности

Правило построения idempotency key для изменяющих операций.

adapter+operation+object+externalId+fingerprintString5^I
ExternalIdPolicy

Политика external id

Правило использования внешних идентификаторов: required-for-write, optional, alias-history или другое согласованное значение. Реестр ExternalId хранится отдельными API-записями.

required-for-writeString5^J
SecretRefs

Secret refs

Только ссылки на записи Secrets. Значения паролей, tokens и ключей доступа в API-записи хранить нельзя.

MultyOcc6
MappingMetadata

Mapping

Краткие metadata или ссылки на MappingProfile для профиля интеграции. Детальные правила mapping хранятся в отдельных API-записях типа mappingProfile.

MultyOcc7
ExternalSystemForId

Внешняя система

Внешняя система, в которой появился идентификатор. Вместе с adapter profile, object type и external id образует область lookup.

String8^A
ExternalIdAdapterProfile

Профиль интеграции

Ключ IntegrationAdapterProfile, в рамках которого действует внешний идентификатор.

String8^B
ExternalIdObjectType

Тип объекта ИРБИС 128

Внутренний object type. API не хранит структуру доменного объекта, а только стабильную ссылку на его тип.

String8^C
ExternalObjectType

Внешний тип объекта

Тип объекта во внешней системе, если он отличается от внутреннего object type.

String8^D
ExternalIdValue

External id

Идентификатор объекта во внешней системе. Активная связка external system + adapter profile + object type + external id должна быть однозначной.

String8^E
ExternalIdRecordDb

БД внутренней записи

Опциональная БД внутренней записи, если ссылка хранится как db/key или db/mfn.

String8^F
ExternalIdRecordKey

Ключ внутренней записи

Стабильный ключ внутренней записи. Если его нет, нужно указать внутреннюю ссылку recordRef.

String8^G
ExternalIdRecordRef

Ссылка на внутреннюю запись

Безопасная внутренняя ссылка на запись, например SID. Не храните здесь закрытые данные записи.

String8^H
ExternalIdDirection

Направление использования

Направление, в котором используется внешний идентификатор.

noneSelect8^I
ExternalIdStatus

Статус связи

Текущее состояние связи ExternalId. По умолчанию lookup использует только активные связи.

activeSelect8^J
ExternalIdSource

Источник регистрации

Источник появления связи: manual, import, adapter или другое согласованное значение.

manualString8^K
ExternalIdCreatedAt

Создано

Дата первичной регистрации связи. При программной регистрации заполняется автоматически.

String8^L
ExternalIdConfirmedAt

Подтверждено

Дата последнего подтверждения связи при обмене с внешней системой.

String8^M
ExternalIdUniquenessPolicy

Правило уникальности

По умолчанию одна активная связка external system + adapter profile + object type + external id указывает только на одну внутреннюю запись.

strict-activeString8^N
ExternalIdDiagnostics

Диагностика

Безопасная диагностическая заметка или JSON без секретов, скрытых полей и персональных данных без прав.

TextArea8^O
MappingAdapterProfile

Профиль интеграции

Ключ IntegrationAdapterProfile, к которому относится mapping profile.

String9^A
MappingContractKey

API-контракт

Ключ APIContract, версия которого используется при mapping.

api.legacy-jsonrpc.v1String9^B
MappingContractVersion

Версия контракта

Версия APIContract, для которой описан mapping profile.

1.0String9^C
MappingDirection

Направление mapping

Направление применения mapping. Анализ bidirectional sync выполняет SyncPolicy/ConflictPolicy поверх результата mapping.

inboundSelect9^D
MappingObjectType

Тип объекта ИРБИС 128

Внутренний object type, к которому применим mapping.

String9^E
MappingExternalObjectType

Внешний тип объекта

Тип объекта во внешней системе.

String9^F
MappingExternalSystem

Внешняя система

Внешняя система. Если не указана, dry-run попытается взять ее из IntegrationAdapterProfile.

String9^G
MappingStrictMode

Строгая проверка

Если включено, ошибки mapping должны блокировать применение результата доменным модулем.

1Select9^H
MappingRequiredPermissions

Требуемые права

Список прав через запятую. Фактическую проверку выполняет Security, API только возвращает required permissions.

String9^I
MappingNotes

Примечание

Пояснения по назначению mapping profile.

TextArea9^J
MappingExternalIdField

Поле external id в payload

Путь к полю payload, из которого dry-run берет external id. Допускается точечная нотация, например issue.id.

idString9^K
FieldMappings

Поля

Правила преобразования внешних полей в stable field keys FieldConfiguration. Физические номера полей и подполей указывать нельзя.

MultyOcc10
WorkflowMappings

Статусы и переходы

Правила сопоставления внешних статусов с WorkflowProject, WorkflowStatus и WorkflowTransition. API не реализует workflow engine.

MultyOcc11
ParticipantMappings

Участники

Правила подготовки resolver-запросов к Users/Organisations. API не хранит частную копию пользовательской модели.

MultyOcc12
FileMappings

Файлы

Правила mapping ссылок на файлы через FT/TemporaryFiles. Физические пути и внутренние storage identifiers наружу не публикуются.

MultyOcc13
SyncAdapterProfile

Профиль интеграции

Ключ IntegrationAdapterProfile, для которого действует политика синхронизации. API не реализует transport/runtime профиля.

String14^A
SyncContractKey

API-контракт

Ключ APIContract, версия которого используется при построении SyncPlan.

api.legacy-jsonrpc.v1String14^B
SyncContractVersion

Версия контракта

Версия APIContract, совместимая с этой политикой.

1.0String14^C
SyncMappingProfile

MappingProfile

Ключ MappingProfile, который используется для нормализации payload до анализа конфликтов.

String14^D
SyncObjectType

Тип объекта

Внутренний object type, к которому относится политика.

String14^E
SyncOperation

Операция по умолчанию

Операция по умолчанию: create, update, transition, link, unlink, attach, detach, comment или published operation доменного модуля.

updateString14^F
SyncDirection

Направление

Направление синхронизации: inbound, outbound или bidirectional.

inboundSelect14^G
SyncSourceOfTruth

Source of truth

Какая сторона считается авторитетной при расхождении данных. Неявное перезаписывание запрещено.

manualSelect14^H
SyncConflictPolicy

ConflictPolicy

Ключ ConflictPolicy. Если политика не указана, безопасное поведение - reject with explanation.

String14^I
SyncIdempotencyScope

Idempotency scope

Правило построения области идемпотентности sync-операции.

adapter+operation+object+externalId+fingerprintString14^J
SyncTraceRequired

TraceContext обязателен

Если включено, dry-run и apply request должны содержать trace id или явно вернуть предупреждение.

1Select14^K
SyncStalePolicy

Устаревшие данные

Как вести себя при признаках устаревшего external/internal snapshot.

reject-staleSelect14^L
SyncRetryEligibility

Retry

Может ли результат быть повторен через Queue. API описывает eligibility, но не исполняет Queue runtime.

no-auto-retrySelect14^M
SyncDefaultDecision

Решение по умолчанию

Безопасное решение при неполной policy. Рекомендуемое значение - reject-with-explanation.

reject-with-explanationSelect14^N
SyncRequiredPermissions

Требуемые права

Список прав через запятую. Фактическую проверку выполняет Security; API возвращает required permissions в SyncPlan.

String14^O
SyncOperationPolicies

Операции

Разрешенные операции в рамках SyncPolicy. API строит SyncPlan и SyncApplyRequest; фактическое применение выполняет доменный модуль.

MultyOcc15
ConflictAdapterProfile

Профиль интеграции

Ключ IntegrationAdapterProfile, для которого применяется политика конфликтов. Может быть пустым для общей политики.

String16^A
ConflictObjectType

Тип объекта

Object type, для которого действует политика.

String16^B
ConflictOperation

Операция

Операция, для которой действует политика: update, transition, attach и т.д.

updateString16^C
ConflictStrategy

Стратегия

Основная стратегия. По умолчанию конфликт отклоняется с объяснением.

reject-with-explanationSelect16^D
ConflictTimestampPolicy

Timestamp/version policy

Обязательная явная policy для last-writer-wins: какие timestamp/version поля сравниваются.

String16^E
ConflictManualResolver

Resolver ручного решения

Ключ доменного resolver-а или будущей операции ручного разрешения конфликта.

String16^F
ConflictDomainModule

Доменный модуль

Модуль-владелец объекта, которому может быть передан SyncApplyRequest.

String16^G
ConflictAllowedClasses

Допустимые классы

Список conflict classes через запятую. Если пусто, применяются стандартные классы.

String16^H
ConflictDefaultClass

Класс по умолчанию

Conflict class для расхождений, которые не удалось классифицировать точнее.

concurrent-updateSelect16^I
ConflictRequiredPermissions

Требуемые права

Права, необходимые для просмотра/применения решения conflict policy.

String16^J
ConflictNotes

Примечание

Пояснение для администратора и Help.

TextArea16^K
ConflictBranches

Ветви решений

Переопределения решения для конкретных conflict classes. Они формируют explainable decision, но не применяют изменения.

MultyOcc17