Skip to content
Datablau DAM数据治理产品手册
REST API 集成指南 模块手册下载 PDF

标准与指标 API ​

本页 Base 地址:DOMAIN_BASE_URL=https://<host>/domain。

适合将已发布的数据标准、码表和指标口径提供给建模、开发、填报及分析平台。接口读取结果还需结合发布状态、版本和生效范围判断,不能把草稿直接同步为企业有效规范。

核心接口 ​

方法与路径关键输入返回与用途
POST /domain/domains/domain/getPublicPageBody:currentPage、pageSize、categoryId、keyword;可按 domainCode、lastModificationStart、lastModificationEnd 筛选已发布标准分页,content、totalItems
POST /domain/domains/domain/getDomainByIdBody:domainId(String)标准完整定义,包括 domainCode、chineseName、description、dataType、state、version
POST /domain/domains/code/getPageBody:currentPage、pageSize;可按 code、name、categoryId、state 筛选标准代码分页,列表字段为 data,总数为 total
POST /domain/domains/code/getCodeBody:code(String),按实际代码定位返回标准代码及 values,并保留状态和版本
POST /domain/metricManagement/mapping/detailsQuery:metricId(String,必填)指标维度、公式、数据源/表及 metricMappings
POST /domain/querytheme/pageBody:currentPage、pageSize(均必填);可用 keyword、categoryId分页查询指标查询主题,返回 content、totalItems

上述标准搜索的时间字段是 date-time 类型,采用目标环境支持的格式和时区。多个标准/指标目录的 categoryId 不可猜测为固定常量,应从客户环境的相应目录中确认。

读取定义的请求示例 ​

向 /domain/domains/domain/getDomainById 提交:

json
{
  "domainId": "example-domain-id"
}

domainId 是标准内部标识,和可读业务编码 domainCode 不同。返回后应保存 version、state、lastModification,并按需要检查 takeEffectDate、expireDate 和关联的 referenceCode。

向 /domain/domains/code/getPage 提交:

json
{
  "currentPage": 1,
  "pageSize": 20,
  "name": "客户状态"
}

示例名称用于表达筛选方式,不代表环境中一定存在此代码。码值详情通过 getCode 按实际 code 读取。不要假定代码列表均已发布;标准状态枚举为 A、C、D、X,其业务映射和流程配置应与部署环境确认,不仅凭字母推断。

场景:给开发平台提供标准约束 ​

  1. 从已发布标准分页获取目标目录内的有效定义,按 ID 查询详情。
  2. 读取所关联的标准代码和码值,形成同一批次的版本快照。
  3. 在开发或建模平台中显示业务定义、类型、长度/精度、非空和值域约束。
  4. 通过元数据接口读取字段关联的标准,核对是否落标;读取标准定义本身不会自动建立字段映射。
  5. 标准变化后比较版本和引用关系,向使用方输出差异,按组织流程评估模型、接口和校验规则变更。

增量按最近修改时间扫描时使用重叠时间窗,并按 domainId + version 去重。下线、废弃和失去可见权限需要单独核对,不能仅靠某次增量未返回就删除本地规范。

场景:解释指标来源 ​

按指标定义读取业务口径,再使用 metricId 查询映射,核对 modelId、tableId、维度和公式;必要时查询血缘解释来源。指标定义、映射关系和真实指标数值是三件事。

本指南不把动态拼接 SQL 的指标查询接口作为通用取数 API。对外提供指标值应明确数据访问授权、查询范围、性能和审计要求,按数据服务等已批准的交付方式实施。

集成边界 ​

标准代码分页返回 data、total、currentPage、pageSize 等字段;已发布标准分页的成功条件、权限和业务错误结构需结合完整目录条件与目标部署确认,不提供虚构的成功响应。

标准详情、码值详情和指标接口的业务结果应在目标部署用样本验收。