更新时间:2024-12-02 GMT+08:00
分享

数据架构API概览

表1 数据架构API类型

类型

说明

概览

概览接口。

信息架构接口

信息架构接口。

数据标准接口

数据标准接口

数据源接口

数据源接口。

码表管理接口

码表管理接口。

流程架构接口

流程架构接口。

数据标准模板接口

数据标准模板接口。

审批管理接口

审批管理接口。

主题管理接口

主题管理接口。

主题层级接口

主题层级接口。

目录管理

目录管理,码表和数据标准的目录。

原子指标接口

原子指标接口。

衍生指标接口

衍生指标接口。

复合指标接口

复合指标接口。

维度接口

维度接口。

限定接口

限定接口,包含时间限定、通用限定。

维度表接口

维度表接口。

事实表接口

事实表接口。

汇总表接口

汇总表接口。

业务指标接口

业务指标接口。

版本信息接口

版本信息接口。

关系建模接口

表模型。

导入导出接口

导入导出接口。

自定义项接口

自定义项接口。

标签接口

标签接口。

质量规则接口

质量规则接口。

概览

表2 概览

API

说明

API流量限制(次/min)

用户流量限制(次/min)

总览统计信息

总览统计信息。

21600

240

模型统计信息

单个模型中的统计信息。

21600

240

关系建模统计信息

关系建模页面,外层的统计信息。

21600

240

标准覆盖率统计信息

查看某个数据标准在所有模型字段中的覆盖率,即使用该标准的字段占总字段的百分比。

21600

240

信息架构接口

表3 信息架构接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查询多种类型的表信息

从信息架构中查询多种类型的表信息,包括逻辑实体、物理表、维度表、事实表、汇总表。

21600

240

数据标准接口

表4 数据标准接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

获取数据标准集合

根据查询条件分页获取数据标准集合,按修改时间降序排序。

21600

240

创建数据标准

创建数据标准。

10800

120

删除数据标准

删除数据标准。

10800

120

修改数据标准

修改数据标准。

10800

120

查看数据标准详情

通过ID获取数据标准详情信息。

21600

240

关联属性与数据标准

关联属性与数据标准。

10800

120

数据源接口

表5 数据源接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

获取数据连接信息

获取指定类型下的数据连接信息。

21600

240

码表管理接口

表6 码表管理接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查询码表列表

查询码表列表。

21600

240

创建码表

创建码表。

10800

120

删除码表

删除码表。

10800

120

修改码表

修改码表。

10800

120

查看码表详情

通过ID查看码表的详情信息。

21600

240

查看码表字段值

查看码表字段值。

21600

240

编辑码表字段值

编辑码表字段值。

10800

120

流程架构接口

表7 流程架构接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

获取所有流程架构目录树

获取所有目录树。

21600

240

查询流程架构列表

查询流程架构列表。

21600

240

创建流程架构

创建流程架构。

10800

120

修改流程架构

修改流程架构。

10800

120

删除流程架构

删除流程架构。

10800

120

查找流程架构详情

查找流程架构详情。

21600

240

数据标准模板接口

表8 数据标准模板接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查询数据标准模板

查询当前工作空间下的数据标准模板。

21600

240

创建数据标准模板

创建当前工作空间下的数据标准模板自定义项。

10800

120

修改数据标准模板

修改数据标准模板。

10800

120

删除数据标准模板

删除数据标准模板。

10800

120

初始化数据标准模板

初始化数据标准模板。

10800

120

审批管理接口

表9 审批管理接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

获取审批单

获取审批单。

21600

240

撤回审批单

撤回审批单。

10800

120

审批单处理

审批驳回/通过,单个或多个action-id=reject/resolve。

10800

120

批量发布

批量发布。

10800

120

批量下线

批量下线。

10800

120

创建审批人

创建审批人。

10800

120

查询审批人列表

查询审批人列表。

21600

240

删除审批人

删除审批人。

10800

120

删除实体下展

当已发布的实体被编辑时,其会生成下展,该接口用于删除实体的下展信息。

10800

120

获取下展信息与已发布实体的差异

当已发布的实体被编辑时,其会生成下展,该接口用于获取下展信息与已发布实体的差异。

21600

240

主题管理接口

表10 主题管理接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找主题列表

通过名称(支持模糊查询)、创建者、责任人、状态、修改时间分页查找主题。

21600

240

删除主题

删除主题。

10800

120

创建主题

创建主题。

10800

120

修改主题

修改主题。

10800

120

获取主题树信息

获取数据资产主题树信息l1,l2,l3。

21600

240

查找主题列表(新)

查找主题(新)。

21600

240

删除主题(新)

删除主题(新)。

10800

120

创建主题(新)

创建主题(新)。

10800

120

修改主题(新)

修改主题(新)。

10800

120

主题层级接口

表11 主题层级接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

获取主题层级

获取主题层级。

21600

240

修改或删除主题层级

修改或删除主题层级。

10800

120

目录管理

表12 目录管理

API

说明

API流量限制(次/min)

用户流量限制(次/min)

获取所有目录

获取所有目录(数据标准、码表)。

21600

240

创建目录

创建目录(数据标准、码表)。

10800

120

修改目录

修改目录(数据标准、码表)。

10800

120

删除目录

删除目录(数据标准、码表)。

10800

120

原子指标接口

表13 原子指标接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找原子指标

通过中英文名称、创建者、审核人、状态、修改时间分页查找原子指标信息看,中英文名称支持模糊查询。

21600

240

新建原子指标

新建单个原子指标。

10800

120

更新原子指标

更新单个原子指标。

10800

120

删除原子指标

批量删除原子指标。

10800

120

查看原子指标详情

通过ID获取原子指标详情信息。

21600

240

衍生指标接口

表14 衍生指标接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找衍生指标

通过中英文名称、创建者、审核人、状态、修改时间、l3Id分页查找衍生指标信息。

21600

240

新建衍生指标

根据参数,新建衍生指标指标。

10800

120

更新衍生指标

根据传入参数,更新衍生指标。

10800

120

删除衍生指标

根据衍生指标ID,删除衍生指标。

10800

120

查看衍生指标详情

通过ID获取衍生详情信息。

21600

240

复合指标接口

表15 复合指标接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找复合指标

通过中英文名称、创建者、审核人、状态、修改时间、l3Id分页查找复合指标信息。

21600

240

新建复合指标

根据参数,新建复合指标。

10800

120

更新复合指标

根据参数,更新复合指标。

10800

120

删除复合指标

根据ID集合删除复合指标。

10800

120

查看复合指标详情

通过ID获取复合指标详情信息。

21600

240

维度接口

表16 维度接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找维度

通过中英文名称、描述、创建者、审核人、状态、l3Id、衍生指标idList、修改时间分页查找维度信息。

21600

240

新建维度

根据参数新建维度。

10800

120

更新维度

根据参数,更新维度信息。

10800

120

删除维度

根据传入的维度ID,删除维度。

10800

120

查看维度详情

通过ID查看维度详情信息。

21600

240

查看维度颗粒度

查询维度颗粒度,依据tableId查询涉及所有维度,不传tableId查询所有维度组颗粒度。

21600

240

查看逆向维度表任务

查看逆向维度表任务。

21600

240

限定接口

表17 限定接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找业务限定

通过中英文名称、描述、创建者、审核人、限定分组id、修改时间状态分页查找限定信息。

21600

240

查看限定详情

通过ID查看限定详情信息。

21600

240

维度表接口

表18 维度表接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找维度表

通过中英文名称、创建者、审核人、状态、修改时间分页查找维度表信息。

21600

240

删除维度表

根据维度表ID,删除维度表。

10800

120

查看维度表详情

通过ID查看维度表的详情信息。

21600

240

事实表接口

表19 事实表接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找事实表

通过中英文名称、创建者、审核人、状态、修改时间分页查找事实表信息。

21600

240

删除事实表

根据ID集合删除事实表。

10800

120

查看事实表详情

通过ID查看事实表的详情信息。

21600

240

查看逆向事实表任务

查看逆向事实表任务。

21600

240

汇总表接口

表20 汇总表接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找汇总表

通过中英文名称、创建者、审核人、状态、修改时间分页查找汇总表信息,中英文名称支持模糊查询。

21600

240

新建汇总表

根据入参,手动创建汇总表。

10800

120

更新汇总表

更新汇总表。

10800

120

删除汇总表

批量删除汇总表,只能删除状态为草稿、已线下、已驳回的表。

10800

120

查看汇总表详情

通过ID查看汇总表的详情信息。

21600

240

业务指标接口

表21 业务指标接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查询业务指标信息

通过名称、创建者、修改时间分页查找业务指标信息。

21600

240

创建业务指标

创建业务指标。

10800

120

更新业务指标

更新业务指标。

10800

120

删除业务指标

删除业务指标。

10800

120

查看指标详情

通过ID查看指标的详情信息。

21600

240

查看指标维度信息

查看指标维度信息。

21600

240

查看指标责任人信息

查看指标责任人信息。

21600

240

获取指标关联信息

获取当前指标图谱。

21600

240

版本信息接口

表22 版本信息接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找版本信息

通过名称、创建者、修改时间查找版本信息。

21600

240

比较版本信息

通过两个版本id,比较两者差异。

60

24

关系建模接口

表23 关系建模接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查找表模型列表

通过中英文名称、创建者、审核人、状态、修改时间分页查找关系建模中的表模型信息,包括逻辑实体、物理表和其属性。

21600

240

创建表模型

在关系建模中创建一个表模型,包括逻辑实体和物理表。

10800

120

更新表模型

在关系建模中更新一个表模型及其属性,包括逻辑实体和物理表。

10800

120

删除表模型

在关系建模中删除一个表模型及其属性,包括逻辑实体和物理表。

10800

120

查询关系

通过关系名称(支持模糊查询)、创建人、开始时间、结束时间等分页查找关系信息。

21600

240

查看关系详情

通过ID获取关系详情信息。

21600

240

查询模型下所有关系

查询模型下所有关系。

21600

240

查看表模型详情

通过ID获取模型表详情信息。

21600

240

获取模型

获取当前空间下的全部模型信息。

21600

240

新建模型工作区

新建模型工作区。

10800

120

更新模型工作区

更新模型工作区。

10800

120

删除模型工作区

删除模型工作区。

10800

120

查询模型详情

查询物理模型或逻辑模型的工作区空间详情。

21600

240

查询目的表和字段(待下线)

查询目的表和字段(待下线)。

21600

240

导出模型中表的DDL语句

根据模型ID导出指定表的DDL语句。

10

4

转换逻辑模型为物理模型

转换逻辑模型为物理模型,转换成功则显示转换后的目标模型信息。

10800

120

获取操作结果

获取批量操作的结果,如逻辑模型转物理模型和逆向数据库操作。

21600

240

导入导出接口

表24 导入导出接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

导入主题

用于导入主题。

10

4

导入模型,关系建模,维度建模,码表,业务指标以及流程架构

导入模型,关系建模,维度建模,码表,业务指标以及流程架构。

10

4

查询导入结果

查询导入excel的处理结果(其中参数uuid获取为:/design/models/action或/design/catalogs/action接口返回结果)。

21600

240

导出业务数据

根据请求参数,导出业务数据,可以导出:码表、数据标准、原子指标、衍生指标、复合指标、汇总表、业务指标、主题、流程、逻辑模型、物理模型、维度、事实表。

10

4

获取excel导出结果

根据请求导出业务数据(/export-model)时返回的uuid,获取excel导出结果。

21600

240

自定义项接口

表25 自定义项接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

查询自定义项

查询自定义项(包括表自定义项、属性自定义项、主题自定义项、业务指标自定义项)。

21600

240

修改自定义项

修改自定义项(包括表自定义项、属性自定义项、主题自定义项、业务指标自定义项)。

10800

120

标签接口

表26 标签接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

添加标签

根据资产(表或属性)的ID给资产打上标签。

10800

120

删除标签

根据资产(表或属性)的ID删除资产标签。

10800

120

质量规则接口

表27 质量规则接口

API

说明

API流量限制(次/min)

用户流量限制(次/min)

更新表的异常数据输出配置

更新表的异常数据输出配置,包括是否生成异常数据、设置异常数据数据库或Schema、设置异常表表前缀/表后缀。

10800

120

清空质量规则

清空表的质量规则。

10800

120

相关文档