1. 概述
1.1 版本
| FineBI 版本 | 功能变动 |
|---|---|
| 7.5 | - |
1.2 应用场景
获取数据集的数据预览，接口按指标集 id 和数据集 id 返回数据集的数据，支持分页取数，且不设行数上限。返回结果同时给出字段列表、数据行与分页信息，可直接用于核对数据或对接下游系统。
注：本接口不设行数上限，数据量较大时建议通过 pageSize、pageIndex 分页取数，或通过 rowCount 限制单次返回的行数，避免单次响应过大。
1.3 前提条件
接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见 指标中心数据服务接口。
2. 接口信息
2.1 接口简介
| 项目 | 内容 |
|---|---|
| 接口作用 | 按指标集 id 和数据集 id 获取数据集的数据预览 |
| 接口 URL | /api/dc/{version}/indicator/metricset/{metricSetId}/dataset/{tableId}/preview |
| 请求类型 | POST |
2.2 请求参数
Header 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
Authorization | string | 是 | 认证信息，格式为 Authorization: <认证串>，获取方式参见 指标中心数据服务接口 |
Path 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
version | string | 是 | 接口版本号，示例：v1 |
metricSetId | string | 是 | 模型指标集 id |
tableId | string | 是 | 数据集 id |
body 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| rowCount | integer | 否 | 拉取行数，小于等于 0 表示不截断 |
pageSize | integer | 否 | 每页返回的行数 |
pageIndex | integer | 否 | 页码，用于指定返回第几页数据 |
2.3 请求示例
| 示例 | |
|---|---|
| 请求地址 | POST http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/metricset/28f0b7e0-0ab6-414a-8687-03a10ec4724c/dataset/690f5cca07435b161265f340419b2247/preview
|
| 请求头 | Authorization: ******************** |
| 请求体 | { "rowCount": 0, "pageSize": 0, "pageIndex": 0 } |
2.4 返回示例
{
"success": true,
"code": "string",
"message": "string",
"data": {
"fields": [
{}
],
"data": [
[
null
]
],
"pageInfo": {
"rowCount": 0,
"pageSize": 0,
"pageIndex": 0
}
},
"errorCode": "string",
"errorMsg": "string"
}
| 参数 | 参数值说明 |
|---|---|
| success | 请求是否成功，true：成功，false：失败 |
code | 状态码 |
message | 提示信息 |
data | 返回的数据，包含字段列表、数据行与分页信息 |
data.fields | 字段列表，每个元素对应数据集中的一个字段 |
data.data | 数据行，二维数组。外层为行，内层为该行的各字段值，顺序与 data.fields 一致 |
data.pageInfo | 本次取数的分页信息 |
data.pageInfo.rowCount | 拉取行数，小于等于 0 表示不截断 |
data.pageInfo.pageSize | 每页返回的行数 |
data.pageInfo.pageIndex | 页码 |
errorCode | 错误码 |
errorMsg | 错误信息 |
上一篇：获取维度度量明细查询结果
