Bundle API

BundleCommandController、DefinitionCommandController、DefinitionQueryController、DefinitionWorkspaceController、AggregateCommandController、AggregateQueryController 提供定义资源的写入、查询与聚合操作入口,路径前缀均为 /api/v1/definitions。包编辑/安装接口由 PackageCommandController、PackageEditController 提供,前缀为 /api/v1/packages。

Bundle 规格字段

DefinitionBundleSpec 除 metadata / options 外,还承载以下资源集合:

字段类型说明
objectTypesList<ObjectTypeSpecDTO>对象类型定义列表
objectTypePropertiesList<ObjectTypePropertiesSpecDTO>属性定义列表,按对象聚合
linksList<LinkTypeSpecDTO>关联类型定义列表
metricsList<MetricSpecDTO>指标定义列表
actionsList<ActionSpecDTO>动作定义列表
policiesList<AccessPolicySpecDTO>访问策略定义列表
pageViewsList<PageViewSpecDTO>页面视图定义列表
appsList<AppSpecDTO>应用壳定义列表
datasourcesList<DataSourceSpecDTO>数据源定义列表
datasetsList<DatasetSpecDTO>数据集定义列表
pipelinesList<PipelineSpecDTO>管道定义列表
workflowsList<WorkflowSpecDTO>工作流定义列表
analysisPlansList<AnalysisPlanSpecDTO>分析计划定义列表
collectorScriptsList<CollectorScriptSpecDTO>采集脚本列表(import 阶段安装)
collectorTasksList<CollectorTaskSpecDTO>采集任务列表(finalize 阶段安装)
seedDataList<SeedDataEntryDTO>样本数据列表(finalize 阶段导入)
workspaceConfigWorkspaceConfigSpecDTOWorkspace 配置(至多一份)
installPlanList<InstallStepDTO>安装执行计划(编译期生成,随 validate/import 响应返回)

请求/响应 DTO

BundleApplyReqDTO / BundleDryRunReqDTO

字段类型说明
bundleDefinitionBundleSpec统一 Definition Bundle 规格

DefinitionBundleOptions

字段类型说明
dryRunboolean是否仅试运行
continueOnErrorboolean出错时是否继续
skipExistingboolean是否跳过已存在资源
defaultPublishOnInstallbooleanbundle 级默认发布策略;ObjectType 未显式声明 publishOnInstall 时继承该默认值
materializeAfterApplybooleanbundle apply 后是否自动物化 ObjectType
syncModeDefinitionBundleSyncModeEnum同步模式:UPSERT 或 REPLACE
pruneMissingResourcesboolean显式删除本包管理但当前未声明的资源;true 等效于 REPLACE
workspaceStrategystringworkspace 定位策略:CURRENT(默认)/ ENSURE_NAMED
forceDefaultStorageboolean为 true 时强制覆盖 workspace 已有默认存储

Bundle 附属资源 DTO

CollectorScriptSpecDTO

字段类型说明
namestring脚本名(workspace 内自然键)
displayNamestring显示名
descriptionstring描述
targetUrlstring目标站点 URL
traceMap<String, Object>TraceV3 动作树(version=3)
extractorsList<Map<String, Object>>提取器定义(ExtractorSpec[])
transformBindingsMap<String, String>转换绑定(extractor 名 → workflow naturalKey)
debugEvidenceMap<String, Object>调试证据
statusstring生命周期状态

CollectorTaskSpecDTO

字段类型说明
namestring任务名(workspace 内自然键)
displayNamestring显示名
scriptRefstring引用的采集脚本名(CollectorScript.name)
devicestring设备 label;未配对时任务延期安装
paramBindingsMap<String, Object>参数绑定
timeoutSecondsinteger单次运行超时(秒)
captureDebugboolean是否采集调试证据
screenshotboolean是否截图
retentionRunsinteger原始请求留存份数
alertHookMap<String, Object>告警钩子配置
statusstring任务状态
cronExpressionstring定时调度 cron 表达式(5/6 段均支持)
scheduleEnabledboolean是否启用定时调度

SeedDataEntryDTO

字段类型说明
objectNamestring对象 API 名称
primaryKeyPropertystring对象主键属性 API 名称;缺省回落对象 spec.primaryKey
recordsList<Map<String, Object>>记录列表(属性 API 名 → 值)

WorkspaceConfigSpecDTO

字段类型说明
descriptionstring工作空间描述(仅现值为空时回填)
defaultStorageDefaultStorageSpec默认存储绑定意图
modelsList<LlmModelTemplateDTO>LLM 模型模板(按 id upsert)
agentHarnessAgentHarnessConfigDTOAgent Harness 定制
semanticAskSuggestionsList<String>提问建议(append + 去重)

DefaultStorageSpec:adopt(安装后是否绑定默认存储)、dataSourceRef(目标数据源名)。

LlmModelTemplateDTO:id、model、provider、displayName、baseUrl、apiKey(仅允许 ${ENV:VAR} 占位符或空)、temperature、timeoutSeconds、supportsJsonSchema、contextLength。

AgentHarnessConfigDTO:promptSuffix、customProfiles(List<Map<String, Object>>)、profileOverrides(List<Map<String, Object>>)。

InstallStepDTO

字段类型说明
idstring步骤 id(计划内唯一)
actionstring动作:import / runPipelines / finalize
pipelinesList<String>action=runPipelines 时本批运行的管道名
phasestringphase 标签:AFTER_IMPORT / AFTER_ONTOLOGY

BundleApplyRespDTO

字段类型说明
appliedboolean是否已应用(dry-run 为 false)
resultsList<MutationResultDTO>各资源变更结果
messagestring汇总消息
createCountinteger创建数量
updateCountinteger更新数量
unchangedCountinteger无变化数量
deleteCountinteger删除数量
blockedCountinteger被阻止数量

MutationResultDTO

所有 Definition API 写入操作(save / sync / bundle apply / dry-run)均返回此结构,作为 CLI install、FE authoring 与模块内部写入服务的统一反馈契约。

字段类型说明
resourceTypestring资源类型,例如 ObjectType / Property / LinkType / Metric / Action / AccessPolicy
naturalKeystring自然键,资源在定义域内的稳定标识,例如对象名、属性 apiName
resourceIdstring平台分配的资源 ID
actionMutationActionEnum变更动作:CREATED / UPDATED / UNCHANGED / DELETED / RESTORED / BLOCKED
statusMutationResultStatusEnum阶段状态:APPLIED / STAGED / MATERIALIZED / PUBLISHED / SKIPPED_NOT_MATERIALIZED / FAILED
changedFieldsList<string>发生变化的字段列表
warningsList<string>变更警告,例如字段降级、引用未来得及解析
messagestring变更说明或错误信息
versionlong写入后的定义版本号
definitionDeletedbooleanPR-071:定义层是否会被删除
runtimeDeletesList<string>PR-071:运行态将被删除的资源标识列表(resourceType:naturalKey)
schemaDeletedColumnsList<string>PR-071:schema 层面将被 soft drop 的列名列表
hardDropEnabledbooleanPR-071:是否启用了物理删列(hard drop)

DefinitionSaveReqDTO

字段类型说明
specobject资源 spec,结构由 resourceType 决定

PropertySyncReqDTO

Property 删除可通过 mode = REPLACE 或 /object-types/{objectName}/properties/{propertyApiName}:remove 完成。

字段类型说明
modePropertySyncMode同步模式:MERGE 合并,REPLACE 全量替换
propertiesList<PropertySpecDTO>属性规格列表

DefinitionPublishReqDTO

字段类型说明
versionlong要发布的版本号,留空表示发布最新草稿版本
dryRunboolean是否仅预演,不实际发布到运行态

说明:发布 API 只暴露统一 lifecycle contract。bundle 路径若需要在安装后推进运行态,只通过 DefinitionBundleOptions.defaultPublishOnInstall 与 ObjectType 级 publishOnInstall 做默认策略补齐,不再对外暴露独立的 bundle/materialize 编排开关。

DefinitionSaveVersionReqDTO

将当前草稿显式固化为一个新的不可变草稿版本,不影响 runtime。

字段类型说明
reasonstring保存原因
changeSummarystring变更摘要

DefinitionRollbackReqDTO

字段类型说明
targetVersionlong目标版本号(必填)
reasonstring回滚原因
dryRunboolean是否仅预演,不实际回滚

DefinitionRestoreDraftReqDTO

将某个历史版本的 spec 恢复为新的当前草稿,不影响 runtime。

字段类型说明
targetVersionlong目标版本号(必填)
reasonstring恢复原因
dryRunboolean是否仅预演,不实际恢复

DefinitionRollbackPublishedReqDTO

将某个已发布历史版本重新发布到 runtime,影响运行态。

字段类型说明
releaseSnapshotIdstring目标 Release Snapshot ID(优先使用)
targetVersionlong目标版本号(兼容字段,未提供 releaseSnapshotId 时使用)
reasonstring回滚原因
dryRunboolean是否仅预演,不实际回滚

DefinitionDiffReqDTO

字段类型说明
fromVersionlong源版本号,留空表示当前最新版本
targetVersionlong目标版本号(必填)

ObjectTypeAggregateRollbackReqDTO

字段类型说明
targetVersionlong指定要恢复的聚合历史版本号;为空时回到各成员当前已发布版本
reasonstring回滚原因
dryRunboolean是否仅预演,不实际回滚

DefinitionApplyRespDTO

字段类型说明
resultMutationResultDTO变更结果
previousLatestVersionlongapply 前 latest version
previousPublishedVersionlongapply 前 published version
appliedVersionlong本次 apply 产生的 version;无草稿时可等于已有 latest version

DefinitionPublishRespDTO

字段类型说明
resultMutationResultDTO发布结果
previousPublishedVersionlong发布前已发布版本号
publishedVersionlong发布后已发布版本号(兼容字段,同 targetVersion)
targetVersionlong目标 Resource Revision 版本号
releaseSnapshotIdstring生成的 Release Snapshot ID
previewDefinitionDiffRespDTOdryRun 时的 diff 预览
materializePlanList<string>物化计划摘要
impactedRuntimeResourcesList<string>受影响的运行态资源
warningsList<string>发布警告信息
publishResultDefinitionPublishResultDTO发布执行结果明细(commit 后填充)

DefinitionPublishResultDTO

字段类型说明
resourceTypeDefinitionResourceTypeEnum资源类型
naturalKeystring资源自然键
statusStatus执行状态:SUCCEEDED / FAILED / SKIPPED
publishedVersionlong发布到的版本号
publishedAtLocalDateTime发布完成时间
messagestring成功提示或失败原因
errorsList<string>失败的详细错误信息

DefinitionSaveVersionRespDTO

字段类型说明
resultMutationResultDTO变更结果
unchangedboolean是否未发生变化(幂等返回)
versionlong生成的版本号
versionIntentDefinitionVersionIntentEnum版本意图
versionMetadataDefinitionResourceVersionDTO版本元信息
createdAtLocalDateTime创建时间
createdBystring创建人

DefinitionRollbackRespDTO

字段类型说明
resultMutationResultDTO变更结果
rolledBackFromVersionlong回滚前版本号
rolledBackToVersionlong回滚目标版本号
versionlong回滚后产生的新版本号
previewDefinitionDiffRespDTOdryRun 时的 diff 预览

DefinitionRestoreDraftRespDTO

字段类型说明
resultMutationResultDTO变更结果
rolledBackFromVersionlong恢复前版本号
rolledBackToVersionlong恢复目标版本号
newDraftVersionDefinitionResourceVersionDTO恢复后产生的新草稿版本
previewDefinitionDiffRespDTOdryRun 时的 diff 预览

DefinitionRollbackPublishedRespDTO

字段类型说明
resultMutationResultDTO变更结果
rolledBackFromPublishedVersionlong回滚前已发布版本号
rolledBackToPublishedVersionlong回滚目标已发布版本号
publishedVersionlong回滚后当前已发布版本号
releaseSnapshotIdstring生成的 Release Snapshot ID(回滚类型)
previewDefinitionDiffRespDTOdryRun 时的 diff 预览

DefinitionDiffRespDTO

字段类型说明
fromVersionlong源版本号
toVersionlong目标版本号
addedFieldsList<string>新增的字段路径(兼容字段,已 @Deprecated)
removedFieldsList<string>删除的字段路径(兼容字段,已 @Deprecated)
modifiedFieldsList<string>修改的字段路径(兼容字段,已 @Deprecated)
changedFieldsList<string>所有发生变更的字段路径(兼容字段,已 @Deprecated)
semanticChangedFieldsList<string>定义语义变化字段路径
physicalChangedFieldsList<string>物理映射变化字段路径
schemaPlanMaterializationPlanDTODDL / Schema 计划,仅 MANAGED 对象发布预览时填充
summaryItemsList<string>中文业务变化摘要
warningsList<string>变更警告,例如字段移除或关键字段变更
specPreviewobject目标版本的完整 Spec 对象

ObjectTypeAggregateApplyRespDTO

字段类型说明
objectNamestringObjectType 名称
resultsList<MutationResultDTO>成员 apply 结果

ObjectTypeAggregateMaterializeRespDTO

字段类型说明
objectNamestringObjectType 名称
materializedboolean是否已完成物化

ObjectTypeAggregateSnapshotDetailRespDTO

字段类型说明
objectNamestring对象名称
snapshotObjectTypeAggregateSnapshotDTO快照信息
currentReleaseSnapshotId / currentReleaseSnapshotSequencestring / long当前生效的发布快照及序号
currentDraftSnapshotId / currentDraftSnapshotSequencestring / long当前草稿快照及序号
baseReleaseSnapshotIdstring当前草稿所基于的发布快照 ID
aggregateLifecycleStatusObjectTypeAggregateLifecycleStatusEnum聚合生命周期状态
currentRelease / currentDraftboolean是否当前发布/草稿
sourceDraftSnapshotId / rollbackFromSnapshotIdstring来源草稿快照/回滚来源快照
membersList<MemberRefDTO>兼容字段(已 @Deprecated)
fullMembersList<MemberRefDTO>完整成员清单
deltaMembersList<DeltaMemberRefDTO>相对上一检查点的变化成员
warningsList<String>聚合级警告

DeltaMemberRefDTO:changeType(ADDED / MODIFIED / REMOVED / UNCHANGED)、resourceType、naturalKey、ownerScope、resourceVersion、previousResourceVersion。

ObjectTypeAggregatePublishRespDTO

字段类型说明
objectNamestringObjectType 名称
resultsList<DefinitionPublishRespDTO>成员 publish 结果
warningsList<string>聚合级警告
materializationPlanMaterializationPlanDTO物化计划

ObjectTypeAggregateRollbackRespDTO

字段类型说明
objectNamestringObjectType 名称
resultsList<DefinitionRollbackRespDTO>成员 rollback 结果
warningsList<string>聚合级警告

ObjectTypeAggregateCompareRespDTO

字段类型说明
objectNamestringObjectType 名称
itemsList<ObjectTypeAggregateCompareItemDTO>成员 compare 结果
warningsList<string>聚合级警告

ObjectTypeAggregateCompareItemDTO

字段类型说明
resourceTypeDefinitionResourceTypeEnum资源类型
naturalKeystring自然键
diffDefinitionDiffRespDTO成员 diff

ObjectTypeAggregateSaveVersionRespDTO

字段类型说明
objectNamestringObjectType 名称
aggregateSnapshotIdstring聚合草稿快照 ID
resultsList<DefinitionSaveVersionRespDTO>成员保存版本结果
affectedMembersList<AggregateRevisionRefDTO>本次快照影响的成员引用
createdRevisionRefsList<AggregateRevisionRefDTO>本次为变更成员创建的 Resource Revision 引用

AggregateRevisionRefDTO

字段类型说明
resourceTypestring资源类型
naturalKeystring自然键
ownerScopestring成员所属作用域
resourceVersionlongResource Revision 版本号

ObjectTypeAggregateHistoryRespDTO

字段类型说明
objectNamestringObjectType 名称
entriesList<ObjectTypeAggregateHistoryEntryDTO>聚合历史条目

ObjectTypeAggregateHistoryEntryDTO

字段类型说明
resourceTypeDefinitionResourceTypeEnum资源类型
naturalKeystring自然键
ownerObjectNamestring所属对象名(PROPERTY 等子资源时存在)
versionlong版本号
changeSummarystring变更摘要
createdBystring创建人
createdAtLocalDateTime创建时间
currentboolean是否为当前版本
publishedboolean是否为已发布版本

ObjectTypeAggregateSnapshotListRespDTO

字段类型说明
objectNamestringObjectType 名称
snapshotsList<ObjectTypeAggregateSnapshotDTO>聚合快照列表(按创建时间倒序)

ObjectTypeAggregateSnapshotDTO

字段类型说明
idstring快照 ID
snapshotKindstring快照类型:DRAFT / RELEASE
aggregateTypestring聚合类型,如 OBJECT_TYPE
aggregateKeystring聚合自然键,如 ObjectType 名称
changeSummarystring变更摘要(Draft Snapshot)
reasonstring发布原因(Release Snapshot)
sourceSnapshotIdstring来源 Draft Snapshot ID(Release Snapshot 指向其来源)
createdBystring创建人
createdAtLocalDateTime创建时间
membersList<MemberRefDTO>快照包含的成员 Revision 引用

MemberRefDTO

字段类型说明
resourceTypestring资源类型
naturalKeystring自然键
ownerScopestring成员所属作用域
resourceVersionlongResource Revision 版本号

ObjectTypeAggregateViewRespDTO

字段类型说明
objectNamestring对象名称
latestVersionlong聚合最新版本
publishedVersionlong聚合已发布版本
draftStateDefinitionDraftStateEnum聚合草稿状态
hasUnpublishedChangesboolean是否存在未发布变更
projectionStatusDefinitionProjectionStatusEnum投影状态
lastPublishErrorstring最近发布错误
lastPublishedAtLocalDateTime最近发布时间
lastPublishedBystring最近发布人
membersList<ObjectTypeAggregateMemberRespDTO>聚合成员
datasetBindingModeDatasetBindingModeEnum主数据集绑定模式:EXTERNAL 外部映射 / MANAGED 平台托管

ObjectTypeAggregateMemberRespDTO

字段类型说明
resourceTypeDefinitionResourceTypeEnum资源类型
naturalKeystring自然键
scopeResourceScopeDTO资源作用域
latestVersionlong最新版本
publishedVersionlong已发布版本
draftStateDefinitionDraftStateEnum草稿状态
hasUnpublishedChangesboolean是否存在未发布变更

接口列表

Bundle

方法路径请求体响应说明
POST/api/v1/definitions/bundles:dry-runBundleDryRunReqDTOBundleApplyRespDTOBundle 试运行,返回变更预览
POST/api/v1/definitions/bundles:applyBundleApplyReqDTOBundleApplyRespDTOBundle 应用,执行实际写入

单一资源保存

通用路径 /api/v1/definitions/resources/{resourceType}/{naturalKey}:save 兼容所有资源类型,请求体为 DefinitionSaveReqDTO,并支持通过查询参数补充作用域:

查询参数说明
ownerObjectName归属对象名(PROPERTY / ACTION / METRIC / ACCESS_POLICY)
sourceObjectName源对象名(LINK_TYPE)
targetObjectName目标对象名(LINK_TYPE)

各资源类型的具体保存路径如下:

方法路径请求体说明
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:saveDefinitionSaveReqDTO保存定义资源草稿(兼容层)
POST/api/v1/definitions/object-types/{objectName}:saveObjectTypeSpecDTO保存对象类型定义草稿
POST/api/v1/definitions/workflows/{name}:saveWorkflowSpecDTO保存工作流定义草稿
POST/api/v1/definitions/apps/{name}:saveAppSpecDTO保存应用定义草稿
POST/api/v1/definitions/page-views/{name}:savePageViewSpecDTO保存页面视图定义草稿
POST/api/v1/definitions/datasets/{name}:saveDatasetSpecDTO保存数据集定义草稿
POST/api/v1/definitions/data-sources/{name}:saveDataSourceSpecDTO保存数据源定义草稿
POST/api/v1/definitions/pipelines/{name}:savePipelineSpecDTO保存流水线定义草稿
POST/api/v1/definitions/access-policies/{name}:saveAccessPolicySpecDTO保存访问策略定义草稿
POST/api/v1/definitions/analysis-plans/{name}:saveAnalysisPlanSpecDTO保存分析计划定义草稿
POST/api/v1/definitions/object-types/{objectName}/properties/{apiName}:savePropertySpecDTO保存对象属性定义草稿
POST/api/v1/definitions/link-types/{name}:saveLinkTypeSpecDTO保存关联类型定义草稿
POST/api/v1/definitions/actions/{name}:saveActionSpecDTO保存动作定义草稿
POST/api/v1/definitions/metrics/{apiName}:saveMetricSpecDTO保存指标定义草稿

包编辑与安装

PackageCommandController 与 PackageEditController 提供包级校验、导入、编辑与安装接口:

方法路径说明
POST/api/v1/packages:validate校验已编译包
POST/api/v1/packages:validate-yaml校验 YAML 包
POST/api/v1/packages:import导入已编译包
POST/api/v1/packages:import-yaml导入 YAML 包
POST/api/v1/packages/{slug}:finalize完成包安装
GET/api/v1/packages/{slug}/edit-files列出包编辑文件
GET/api/v1/packages/edit-files自动解析当前 workspace 包并列出编辑文件
GET/api/v1/packages/{slug}/edit-files/file读取文件
POST/api/v1/packages/{slug}/edit-files:batch-get批量读取文件
PUT/api/v1/packages/{slug}/edit-files/file写入文件
POST/api/v1/packages/{slug}/edit-files/file:edit编辑文件
DELETE/api/v1/packages/{slug}/edit-files/file删除文件
POST/api/v1/packages/{slug}:validate-edit校验编辑后的包
POST/api/v1/packages/{slug}:install安装基线
POST/api/v1/packages/{slug}:install-file安装单个文件
POST/api/v1/packages/{slug}:reverse-generate反向生成包文件
POST/api/v1/packages/workspace-baseline:adopt采纳当前 workspace 为基线
POST/api/v1/packages/workspace-baseline:reset-baseline重置 workspace 基线

属性同步与下线

方法路径请求体响应说明
POST/api/v1/definitions/object-types/{objectName}/properties:syncPropertySyncReqDTOList<MutationResultDTO>同步对象属性
POST/api/v1/definitions/object-types/{objectName}/properties/{propertyApiName}:remove-boolean下线对象属性
POST/api/v1/definitions/object-types/{objectName}/properties/{propertyApiName}:restore-boolean恢复已下线对象属性

Workspace 级编排

方法路径请求体响应说明
GET/api/v1/definitions/workspace-changes-WorkspaceChangesRespDTO查询工作区未发布变更
POST/api/v1/definitions/workspace:applyWorkspaceApplyReqDTO(可选)WorkspaceApplyRespDTO对工作区目标集合执行 apply
POST/api/v1/definitions/workspace:publish-previewWorkspacePublishReqDTO(可选)WorkspacePublishRespDTO预演工作区批量发布
POST/api/v1/definitions/workspace:publishWorkspacePublishReqDTO(可选)WorkspacePublishRespDTO执行工作区批量发布
POST/api/v1/definitions/workspace:rollbackWorkspaceRollbackReqDTO(可选)WorkspaceRollbackRespDTO回滚工作区目标集合到各自已发布版本
POST/api/v1/definitions/workspace:compareWorkspaceCompareReqDTO(可选)WorkspaceCompareRespDTO比较工作区目标集合的未发布差异

Workspace 响应统一为 items + warnings 结构;WorkspaceChangesRespDTO 仅含 items(WorkspaceChangeItemDTO)。

Workspace 请求 DTO:WorkspaceApplyReqDTO / WorkspacePublishReqDTO / WorkspaceCompareReqDTO 均含 targets: List<WorkspaceDefinitionTargetDTO>(为空表示对当前工作区所有未发布变更生效);WorkspaceRollbackReqDTO 另含 reason / dryRun。WorkspaceDefinitionTargetDTO 字段为 resourceType / naturalKey。

ObjectType 聚合操作

方法路径请求体响应说明
POST/api/v1/definitions/object-types/{objectName}:apply-ObjectTypeAggregateApplyRespDTO聚合 apply ObjectType 及其子资源
POST/api/v1/definitions/object-types/{objectName}:materialize-ObjectTypeAggregateMaterializeRespDTO聚合物化 ObjectType 及其子资源
POST/api/v1/definitions/object-types/{objectName}:publish-previewDefinitionPublishReqDTOObjectTypeAggregatePublishRespDTO聚合预览发布 ObjectType 及其子资源
POST/api/v1/definitions/object-types/{objectName}:publishDefinitionPublishReqDTOObjectTypeAggregatePublishRespDTO聚合发布 ObjectType 及其子资源
POST/api/v1/definitions/object-types/{objectName}:rollbackObjectTypeAggregateRollbackReqDTOObjectTypeAggregateRollbackRespDTO聚合回滚 ObjectType 及其子资源到各自已发布版本
POST/api/v1/definitions/object-types/{objectName}:compare-ObjectTypeAggregateCompareRespDTO聚合比较 ObjectType 及其子资源的未发布差异
POST/api/v1/definitions/object-types/{objectName}:save-versionDefinitionSaveVersionReqDTOObjectTypeAggregateSaveVersionRespDTO聚合保存 ObjectType 及其子资源草稿版本

单资源版本管理

以下接口统一作用于 /api/v1/definitions/resources/{resourceType}/{naturalKey},均支持通过查询参数 ownerObjectName、sourceObjectName、targetObjectName 补充作用域:

方法路径请求体响应说明
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:save-versionDefinitionSaveVersionReqDTODefinitionSaveVersionRespDTO将当前草稿保存为新的草稿版本
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:apply-DefinitionApplyRespDTO固化定义资源草稿为版本
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:publish-previewDefinitionPublishReqDTODefinitionPublishRespDTO预览定义资源发布影响
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:publishDefinitionPublishReqDTODefinitionPublishRespDTO发布定义资源到运行态
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:rollbackDefinitionRollbackReqDTODefinitionRollbackRespDTO回滚定义资源到指定版本(兼容入口,建议分别使用 restore-draft / rollback-published)
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:restore-draftDefinitionRestoreDraftReqDTODefinitionRestoreDraftRespDTO恢复草稿到指定历史版本
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:rollback-publishedDefinitionRollbackPublishedReqDTODefinitionRollbackPublishedRespDTO将已发布运行态回滚到指定已发布版本
POST/api/v1/definitions/resources/{resourceType}/{naturalKey}:compareDefinitionDiffReqDTODefinitionDiffRespDTO对比定义资源两个版本的差异
DELETE/api/v1/definitions/resources/{resourceType}/{naturalKey}-MutationResultDTO删除单资源

资源查询

方法路径查询参数响应说明
GET/api/v1/definitions/resourcesresourceType, current, size, keyword, status, objectNamePageVO<DefinitionResourceSummaryDTO>分页查询定义资源
GET/api/v1/definitions/resources/{resourceType}/{naturalKey}ownerObjectName, sourceObjectName, targetObjectNameDefinitionResourceDetailDTO获取定义资源详情
GET/api/v1/definitions/resources/{resourceType}/{naturalKey}/typedownerObjectName, sourceObjectName, targetObjectNameDefinitionResourceDetailDTO<CanonicalSpec>获取定义资源详情(spec 强类型)
GET/api/v1/definitions/resources/{resourceType}/{naturalKey}/versionsownerObjectName, sourceObjectName, targetObjectName, lineList<DefinitionResourceVersionDTO>查询定义资源版本历史
GET/api/v1/definitions/resources/{resourceType}/{naturalKey}/versions/{version}ownerObjectName, sourceObjectName, targetObjectNameDefinitionResourceDetailDTO获取指定版本详情
GET/api/v1/definitions/resources/{resourceType}/{naturalKey}/versions/{version}/typedownerObjectName, sourceObjectName, targetObjectNameDefinitionResourceDetailDTO<CanonicalSpec>获取指定版本详情(spec 强类型)
GET/api/v1/definitions/resources/{resourceType}/{naturalKey}/release-snapshotsownerObjectName, sourceObjectName, targetObjectNameList<DefinitionReleaseSnapshotDTO>查询定义资源 Release Snapshot 历史
GET/api/v1/definitions/object-types/{name}/spec-ObjectTypeSpecDTO获取对象类型最新 Spec
GET/api/v1/definitions/object-types/{name}/history-ObjectTypeAggregateHistoryRespDTO获取对象类型聚合历史
GET/api/v1/definitions/object-types/{name}/snapshots-ObjectTypeAggregateSnapshotListRespDTO获取对象类型聚合快照历史
GET/api/v1/definitions/object-types/{name}/snapshots/{snapshotId}-ObjectTypeAggregateSnapshotDetailRespDTO获取对象类型聚合快照详情
GET/api/v1/definitions/object-types/{name}/aggregate-view-ObjectTypeAggregateViewRespDTO获取对象类型聚合视图

查询参数说明

参数类型说明
resourceTypestring资源类型,如 OBJECT_TYPE、PROPERTY、LINK_TYPE 等
currentlong分页当前页,默认 1
sizelong分页大小,默认 20
keywordstring关键字过滤
statusstring状态过滤
objectNamestring对象名过滤
lineDefinitionHistoryLineEnum版本历史线,默认 ALL
ownerObjectNamestring归属对象名
sourceObjectNamestring源对象名
targetObjectNamestring目标对象名

相关文档

  • 核心概念 — DefinitionBundleSpec、MutationResultDTO、ProjectionContext、ResourceLocatorDTO
  • 枚举总表 — DefinitionResourceTypeEnum / MutationActionEnum / MutationResultStatusEnum / PropertySyncMode