DAM 开发者 API 参考
DAM REST API 面向企业门户、数据开发平台、数据目录、质量运营和智能应用的集成。建议先接入“发现对象、读取定义、查询治理状态”这类只读能力,再根据业务职责接入更新、审批和任务执行。
本指南从实际接口定义中筛选常用集成能力,按业务对象和使用场景组织。接口定义中存在的测试、界面埋点、图标、缓存、服务重启、内部同步、绕过权限检查及历史兼容接口不作为推荐集成入口。入选表示适合评估对接,不代表厂商已对其作出独立的公共 API 稳定性承诺。
从任务开始
| 要解决的问题 | 阅读路径 | 交付结果 |
|---|---|---|
| 外部门户要查表和字段的业务含义 | 接入约定 → 元数据接口 | 可定位到来源系统的表、字段、描述和标准关联 |
| 将统一标准和代码值同步给开发、建模或填报系统 | 标准与指标接口 | 标准定义、版本和码值快照 |
| 把质量结果接入运营看板或问题工单 | 质量与任务接口 | 规则、执行记录、问题和核验状态 |
| 在企业门户中展示资产目录及负责人 | 资产与安全接口 | 经当前身份授权可见的目录、资产详情与分类分级信息 |
| 发版前评估表字段变更的影响 | 血缘与图谱接口 | 上下游对象、转换逻辑及影响清单 |
| 不确定该怎样组合接口 | 集成场景 | 调用顺序、对象关联、结果核对及异常处理 |
API Base 地址
API 地址由企业部署的统一入口和服务前缀组成。例如 https://dam.example.com/metadata/entities/123/get。下面的前缀需要加在对应服务路径之前,不能按页面菜单名称推断路径。
| 环境变量 | Base 地址(示例) | 核心职责 |
|---|---|---|
BASE_BASE_URL | https://<host>/base | 应用系统、标签及基础公共能力 |
METADATA_BASE_URL | https://<host>/metadata | 数据源、表字段、报表和元模型对象 |
DOMAIN_BASE_URL | https://<host>/domain | 数据标准、标准代码及指标 |
QUALITY_BASE_URL | https://<host>/quality | 质量规则、检核任务和问题 |
ASSETS_BASE_URL | https://<host>/assets | 资产目录、编目和资产详情 |
DATASECURITY_BASE_URL | https://<host>/datasecurity | 分类分级、识别结果和访问策略 |
SQLINK_BASE_URL | https://<host>/sqlink | 专业血缘、解析及影响分析 |
GRAPH_BASE_URL | https://<host>/graph | 跨对象关系和统一资产访问 |
JOB_BASE_URL | https://<host>/job | 通用任务调度和执行记录 |
USER_BASE_URL | https://<host>/user | 用户、组织和访问凭据 |
版本与兼容性
当前手册以 DAM 9.1.2 为基线。服务的 info.version 不能单独作为产品发行版本判断依据,实际可用范围以目标部署的 Swagger/OpenAPI 定义和权限配置为准。
实施时应保存目标环境的接口定义、实际服务构建版本及联调记录。Graph v2、统一资产访问等能力单列为部署可选能力,未确认目标环境存在前不纳入基础集成。9.2 升级时先比较接口方法、路径、请求/响应 Schema、权限与状态枚举,再回归典型场景;不要仅因界面功能相近就假定接口完全兼容。
示例使用虚构域名、对象标识和已配置的认证变量。参数表列出调用所需的关键字段,完整字段及最终可用范围以客户部署环境的 Swagger 为准。本文未将任何真实账号、密码或 Token 作为示例。
实施顺序
- 为集成建立专用身份,按业务域和模块授予需要的访问权限。
- 按认证与请求约定核对统一入口、凭据携带方式和会话有效期。
- 在测试范围中查询少量对象,保存来源标识、分页规则和响应结构。
- 按场景组合接口,核对 DAM 页面与 API 返回的一致性。
- 明确增量同步、失败重试、权限变更和版本升级后的回归责任,再扩大接入范围。
REST API 的治理对象集成与数据服务发布的业务数据 API 是两个层次。前者主要管理和查询治理信息;后者按获批范围交付业务查询能力。获取表定义或资产详情不等于已经获准读取业务数据。
