1. 概述
1.1 版本
| FineBI 版本 | 功能变动 |
|---|---|
| 7.5 | 指标服务新增「查看指标相关维度」接口 |
1.2 应用场景
模型指标集中的指标可以搭配哪些维度进行分析，可以通过接口直接读取。
接口按指标集 id 和指标 id 返回与该指标相关的维度，返回结果为维度列表，一次性给出该指标可用的全部维度，包含维度 id、维度名、数据类型、描述与标红状态。
1.3 前提条件
接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见 指标中心数据服务接口。
2. 接口信息
2.1 接口简介
| 项目 | 内容 |
|---|---|
接口作用 | 按指标集 id 和指标 id 查看与该指标相关的维度 |
接口 URL | /api/dc/{version}/indicator/metricset/{metricSetId}/metric/{metricId}/relate/dimension |
请求类型 | GET |
2.2 请求参数
Header 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
Authorization | string | 是 | 认证信息，格式为 Authorization: <认证串>，获取方式参见 指标中心数据服务接口 |
Path 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
version | string | 是 | 接口版本号，示例：v1 |
metricSetId | string | 是 | 模型指标集 id |
metricId | string | 是 | 指标 id |
2.3 请求示例
| 示例 | |
|---|---|
| 请求地址 | GET http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/metricset/28f0b7e0-0ab6-414a-8687-03a10ec4724c/metric/f285c544-4714-5355-b606-7acf47733f49/relate/dimension |
| 请求头 | Authorization: ******************** |
注：请求地址中的 IP 与端口为示例，{metricSetId}、{metricId} 需替换为实际的模型指标集 id 与指标 id。
2.4 返回示例
{
"success": true,
"code": "200",
"message": "success",
"data": [
{
"id": "string",
"name": "string",
"type": 16,
"description": "string",
"validStatus": "string"
}
],
"errorCode": null,
"errorMsg": null
}
响应参数说明：
| 参数 | 参数值说明 |
|---|---|
success | 请求是否成功，true：成功，false：失败 |
code | 状态码 |
message | 提示信息 |
data | 与该指标相关的维度列表，元素结构见下表 |
errorCode | 错误码 |
errorMsg | 错误信息 |
——data 中各元素的参数：
| 参数 | 参数值说明 |
|---|---|
id | 维度 id |
name | 维度名 |
type | 数据类型，返回值为枚举值 16、32、48 |
description | 描述 |
validStatus | 标红状态 |
上一篇：查看维度属性
