1. 概述
1.1 版本
| FineBI 版本 | 功能变动 |
|---|---|
| 7.5 | 指标服务新增「获取维度值」接口 |
1.2 应用场景
模型指标集中的维度，其取值清单除了在分析主题中筛选查看，也可通过本接口直接读取，用于在配置分析或填报参数前确认该维度下有哪些维度值。
接口按指标集 id 和维度 id 返回该维度的维度名、数据类型与维度值列表。请求时可在 body 中传入搜索关键词过滤维度值，并指定分页参数，返回结果按页给出，同时返回维度值总数。
1.3 前提条件
接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见 指标中心数据服务接口。
2. 接口信息
2.1 接口简介
| 项目 | 内容 |
|---|---|
接口作用 | 按指标集 id 和维度 id 获取该维度的维度值 |
接口 URL | /api/dc/{version}/indicator/metricset/{metricSetId}/dimension/{dimensionId}/data |
请求类型 | POST |
2.2 请求参数
Header 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
Authorization | string | 是 | 认证信息，格式为 Authorization: <认证串>，获取方式参见 指标中心数据服务接口 |
Path 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
version | string | 是 | 接口版本号，示例：v1 |
metricSetId | string | 是 | 模型指标集 id |
dimensionId | string | 是 | 维度 id |
Body 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
keyword | string | 否 | 搜索关键词，用于过滤维度值 |
limit | object | 是 | 分页参数，其中的参数见下表 |
——limit 中的参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
pageIndex | integer | 是 | 分页页码 |
pageSize | integer | 是 | 分页数据量，即每页返回的维度值条数 |
rowCount | integer | 是 | 总数据量 |
2.3 请求示例
| 示例 | |
|---|---|
| 请求地址 | POST http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/metricset/28f0b7e0-0ab6-414a-8687-03a10ec4724c/dimension/8c2e4f61-9d35-4a78-b1c6-3e7d5a90f2b4/data |
| 请求头 | Authorization: ******************** |
| 请求体 | 见下方代码块 |
{
"keyword": "",
"limit": {
"pageIndex": 1,
"pageSize": 50,
"rowCount": 0
}
}
注：请求地址中的 IP 与端口为示例，{metricSetId}、{dimensionId} 需替换为实际的模型指标集 id 与维度 id。
2.4 返回示例
{
"success": true,
"code": "200",
"message": "success",
"data": {
"dimensionName": "string",
"type": 16,
"data": [
"string"
],
"pageInfo": {
"pageIndex": 0,
"pageSize": 0,
"rowCount": 0
}
},
"errorCode": null,
"errorMsg": null
}
响应参数说明：
| 参数 | 参数值说明 |
|---|---|
success | 请求是否成功，true：成功，false：失败 |
code | 状态码 |
message | 提示信息 |
data | 维度值与分页信息，各字段说明见下表 |
errorCode | 错误码 |
errorMsg | 错误信息 |
——data 中的参数：
| 参数 | 参数值说明 |
|---|---|
dimensionName | 维度名 |
type | 数据类型，返回值为枚举值 16、32、48 |
data | 维度值列表，按请求中的分页参数取当前页 |
pageInfo | 分页信息，其中的参数见下表 |
——data.pageInfo 中的参数：
| 参数 | 参数值说明 |
|---|---|
pageIndex | 当前页码 |
pageSize | 每页返回的维度值条数 |
rowCount | 维度值总数 |
上一篇：查看维度相关指标
