1. 概述
1.1 版本
| FineBI 版本 | 功能变动 |
|---|---|
| 7.5 | 指标服务新增「查看维度属性」接口 |
1.2 应用场景
模型指标集中维度的属性，除了在 FineBI 的「模型指标集」编辑界面查看，也可通过本接口直接读取。
接口按指标集 id 和维度 id 返回该维度的属性，包含基础信息、审批者、标签、扩展字段与计算口径。
其中计算口径 caliber 按维度的计算口径类型返回不同结构，分为公式、指标可视化、维度标签三种，字段说明见「2.4 返回示例」下方的响应参数说明。
1.3 前提条件
接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见 指标中心数据服务接口。
2. 接口信息
2.1 接口简介
| 项目 | 内容 |
|---|---|
接口作用 | 按指标集 id 和维度 id 查看维度属性 |
接口 URL | /api/dc/{version}/indicator/metricset/{metricSetId}/dimension/{dimensionId}/info |
请求类型 | GET |
2.2 请求参数
Header 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
Authorization | string | 是 | 认证信息，格式为 Authorization: <认证串>，获取方式参见 指标中心数据服务接口 |
Path 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
version | string | 是 | 接口版本号，示例：v1 |
metricSetId | string | 是 | 模型指标集 id |
dimensionId | string | 是 | 维度 id |
2.3 请求示例
| 示例 | |
|---|---|
| 请求地址 | GET http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/metricset/28f0b7e0-0ab6-414a-8687-03a10ec4724c/dimension/8c2e4f61-9d35-4a78-b1c6-3e7d5a90f2b4/info |
| 请求头 | Authorization: ******************** |
注：请求地址中的 IP 与端口为示例，{metricSetId}、{dimensionId} 需替换为实际的模型指标集 id 与维度 id。
2.4 返回示例
{
"success": true,
"code": "200",
"message": "success",
"data": {
"id": "string",
"pId": "string",
"description": "string",
"approver": [
{
"userId": "string",
"displayName": "string",
"userName": "string"
}
],
"creator": "string",
"createTime": 0,
"editTime": 0,
"type": 16,
"tags": [
{
"id": "string",
"name": "string",
"description": "string"
}
],
"extensionProperties": [
{
"id": "string",
"name": "string",
"type": 16,
"required": true,
"value": {}
}
],
"validStatus": "VALID",
"caliber": {
"id": "string",
"name": "string",
"formula": "string",
"fields": [
{
"id": "string",
"tableId": "string",
"name": "string",
"transferName": "string",
"type": 0,
"nodeType": 0,
"validStatus": "string",
"inactive": true
}
],
"type": 1
}
},
"errorCode": null,
"errorMsg": null
}
响应参数说明：
| 参数 | 参数值说明 |
|---|---|
success | 请求是否成功，true：成功，false：失败 |
code | 状态码 |
message | 提示信息 |
data | 维度属性，各字段说明见下表 |
errorCode | 错误码 |
errorMsg | 错误信息 |
——data 中的参数：
| 参数 | 参数值说明 |
|---|---|
id | 维度 id |
pId | 父文件夹 id |
description | 数据描述 |
approver | 审批者列表，元素结构见下表 |
creator | 创建者用户显示名 |
createTime | 创建时间，时间戳格式 |
editTime | 编辑时间，时间戳格式 |
type | 数据类型，返回值为枚举值 16、32、48 |
tags | 标签列表，元素结构见下表 |
extensionProperties | 扩展字段列表，元素结构见下表 |
validStatus | 标红状态，VALID：未标红，INVALID：标红 |
caliber | 计算口径，结构见下表 |
——approver 中的参数：
| 参数 | 参数值说明 |
|---|---|
userId | 用户 id |
displayName | 用户显示名 |
userName | 用户名 |
——tags 中的参数：
| 参数 | 参数值说明 |
|---|---|
id | 标签 id |
name | 标签名 |
description | 标签描述 |
——extensionProperties 中的参数：
| 参数 | 参数值说明 |
|---|---|
id | 扩展字段 id |
name | 扩展字段名 |
type | 扩展字段类型，返回值为枚举值 16、32、48、64、65、80、81 |
required | 是否启用 |
value | 扩展字段值 |
——caliber 中的参数：
| 参数 | 参数值说明 |
|---|---|
id | 指标/维度 id |
name | 指标/维度名 |
type | 计算口径类型。取不同值时 caliber 的结构不同，分为公式、指标可视化、维度标签三种，见下表 |
formula | 公式。仅计算口径为公式时返回 |
fields | 计算口径所用字段，元素结构见下表 |
field | 计算口径对应的字段，含 id（字段 id）、type（字段类型）。仅计算口径为指标可视化时返回 |
filter | 过滤条件。仅计算口径为指标可视化时返回 |
summaryType | 汇总方式。仅计算口径为指标可视化时返回 |
summary | 是否聚合。仅计算口径为指标可视化时返回 |
analysisMethod | 时间衍生配置。type 区分默认累计、自定义累计、同环比三种衍生方式；默认累计含 accumulateType，自定义累计含 start 与 end，同环比含 calculateType。仅计算口径为指标可视化时返回 |
additivity | 半累加配置，含 nonAdditiveDimension（不可累加维度）、windowPartitionFields（窗口分组）与 calculateType（1 最大值、2 最小值）。仅计算口径为指标可视化时返回 |
labels | 赋值内容，每项含 label（赋值为，取值含 value、type）与 condition（过滤条件）。仅计算口径为维度标签时返回 |
other | 其他，取值含 value、type。仅计算口径为维度标签时返回 |
——caliber.fields 中的参数：
| 参数 | 参数值说明 |
|---|---|
id | 字段 id |
tableId | 字段所属数据集 id |
name | 字段名 |
transferName | 字段转义名 |
type | 字段类型 |
nodeType | 节点类型 |
validStatus | 标红状态 |
inactive | 是否删除 |
上一篇：查看维度血缘
