此手册用于记录大数据开发与管理平台中，模型设计中心产品所有对外开放的OpenAPI，阅读此手册，你将了解模型设计中心产品开放的OpenAPI能力与调用方法。

一、公共参数

1.1 响应格式

名称 类型 描述
code Number 响应码
reqId String 请求ID
cost Number 耗时，单位：ms
msg String 响应消息
result Object 响应结果

1.2 异常响应码

响应码 说明
-1 系统异常
-2 请求参数错误

1.3 枚举列表

1.3.1 TableTypeEnum

表类型

枚举值 类型 名称
DIMENSION String 维度表
FACT String 事实表
OTHER String 其它表
1.3.2 DimensionTableTypeEnum

维表类型

枚举值 类型 名称
MAIN String 主维表
SUB String 次维表

1.4 表

1.4.1 TableType

表类型

字段 类型 描述
table String 表名
tableType TableTypeEnum 表类型
dimTableType DimensionTableTypeEnum 维表类型
hasRelation Boolean 是否有关联表
1.4.2 FieldRelation

字段关联

字段 类型 描述
originField String 原始字段
relationField String 关联字段
1.4.3 TableRelation

表关联

字段 类型 描述
db String 数据库
table String 表
fieldRelations List<FieldRelation> 关联字段列表
1.4.4 TableListRequest

表列表请求

字段 类型 描述
datasourceId Number 数据源id（和数据源标识只用传递一个）
catalog String 数据源标识（和数据源id只用传递一个）
db String 数据库
tables List<String> 表名列表

二、OpenAPI列表

2.1 OpenAPI总览

模块名称支持版本状态请求方法请求路径
表

查询表类型和是否有关联表v1.6.1设计中POST /table/v1/type/list
查询事实表关联的主维度表v1.6.1设计中GET /table/v1/dim-relation/get

2.2 表API

2.2.1 查询表类型和是否有关联表

POST /table/v1/type/list

产品版本：v1.6.1

描述：查询表类型和是否有关联表

URL参数/请求体

名称 类型 描述 必须 默认值
tableListRequest TableListRequest 表类型查询请求 是 无

响应体

名称 类型 描述
code Number 状态码
msg String 错误信息
cost Number 接口消耗毫秒数
reqId String 请求ID
result List<TableType> 表类型列表

响应示例：


{

"code": 0,

"reqId": "91035",

"cost": 169,

"msg": "success",

"result": \[

{

"table": "a",

"tableType": "DIMENSION",

"dimTableType": "MAIN",

"hasRelation": false

},

{

"table": "b",

"tableType": "FACT",

"dimTableType": null,

"hasRelation": true

}

\]

}
2.2.2 查询事实表关联的主维度表

GET /table/v1/dim-relation/get

产品版本：v1.6.1

描述：查询事实表关联的主维度表

URL参数/请求体

名称 类型 描述 必须 默认值
datasourceId Number 数据源id（和数据源标识只用传递一个） 否
catalog String 数据源标识（和数据源id只用传递一个） 否
db String 数据库 是
table String 表名 是 无

请求示例：

?datasourceId=1&db=dev&table=test

?catalog=dev4-catalog&db=dev&table=test

响应体

名称 类型 描述
code Number 状态码
msg String 错误信息
cost Number 接口消耗毫秒数
reqId String 请求ID
result List<TableRelation> 关联表

响应示例：


{

"code": 0,

"reqId": "91035",

"cost": 169,

"msg": "success",

"result": \[

{

"db": "dev",

"table": "a",

"fieldRelations": \[

{

"originField": "a",

"relationField": "a"

}

\]

},

{

"db": "dev",

"table": "b",

"fieldRelations": \[

{

"originField": "b",

"relationField": "c"

}

\]

}

\]

}