1. 概述
1.1 版本
| FineBI 版本 | 功能变动 |
|---|---|
| 7.5 | 指标服务新增「查看数据集属性」接口 |
1.2 应用场景
获取维度表 / 事实表数据集基础属性，返回数据集 id、名称、原始表、标签、数据描述、创建者、创建时间、扩展字段。
1.3 前提条件
接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见：指标中心数据服务接口。
2. 接口信息
2.1 接口简介
| 项目 | 内容 |
|---|---|
| 接口作用 | 获取维度表 / 事实表数据集基础属性，返回数据集 id、名称、原始表、标签、数据描述、创建者、创建时间、扩展字段。 |
| 接口 URL | /api/dc/{version}/indicator/metricset/{metricSetId}/dataset/{tableId}/info |
| 请求类型 | GET |
2.2 请求参数
header 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
Authorization | string | 是 | 认证信息，格式为 Authorization: <认证串>，获取方式参见 指标中心数据服务接口 |
Path 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| version | string | 是 | 接口版本号，示例：v1 |
| metricSetId | string | 是 | 模型指标集 id |
| tableId | string | 是 | 数据集 id |
2.3 请求示例
| 示例 | |
|---|---|
| 请求地址 | GET http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/metricset/28f0b7e0-0ab6-414a-8687-03a10ec4724c/dataset/690f5cca07435b161265f340419b2247/info
|
| 请求头 | Authorization: ******************** |
注：请求地址中的 IP 与端口为示例，{metricSetId}、{tableId} 需替换为实际的模型指标集 id 与数据集 id。
2.4 返回示例
{
"success": true,
"code": "string",
"message": "string",
"data": {
"id": "string",
"name": "string",
"originalTable": "string",
"tags": ["string"],
"description": "string",
"creator": "string",
"createTime": "string",
"extensionFields": {}
},
"errorCode": "string",
"errorMsg": "string"
}
响应参数说明
| 参数 | 参数值说明 |
|---|---|
success | 请求是否成功，true：成功，false：失败 |
code | 状态码 |
message | 提示信息 |
data | 数据集属性，各字段说明见下表 |
| errorCode | 错误码 |
errorMsg | 错误信息 |
上一篇：查看数据集字段接口
