1. 概述
1.1 版本
| FineBI 版本 | 功能变动 |
|---|---|
| 7.5 | 指标服务新增「获取模型指标集配置」接口 |
1.2 应用场景
模型指标集的配置除了在 FineBI 的「模型指标集」编辑界面查看，也可通过本接口直接读取。
接口会按 sections 参数返回指标集配置的五个部分，可按需只取其中一部分：
| sections 取值 | 返回内容 |
|---|---|
| details | 指标集的基本信息 |
| datasets | 指标集使用的数据集 |
| relationships | 数据集之间的关联关系 |
| calculateFields | 计算字段（返回的 id 为计算字段 id） |
| metrics | 指标集的指标 |
1.3 前提条件
接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见 指标中心数据服务接口。
2. 接口信息
2.1 接口简介
| 项目 | 内容 |
|---|---|
| 接口作用 | 按指标集 id 获取模型指标集的配置，可指定返回的配置部分 |
| 接口 URL | /api/dc/{version}/indicator/metricset/{metricSetId}/config |
| 请求类型 | POST |
2.2 请求参数
Header 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
Authorization | string | 是 | 认证信息，格式为 Authorization: <认证串>，获取方式参见 指标中心数据服务接口 |
Path 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
version | string | 是 | 接口版本号，示例：v1 |
| metricSetId | string | 是 | 模型指标集 id |
Body 参数：
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| sections | array[string] | 否 | 指定返回的配置部分，可选值：details、datasets、relationships、calculateFields、metrics。为空、不传或传入非法值时返回全部配置 |
2.3 请求示例
| 示例 | |
|---|---|
| 请求地址 | POST http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/metricset/28f0b7e0-0ab6-414a-8687-03a10ec4724c/config
|
| 请求头 | Authorization: ********************
|
| 请求体 | { "sections": null } |
2.4 返回示例
{
"success": true,
"code": "string",
"message": "string",
"data": {
"details": {},
"datasets": [
{}
],
"relationships": [
{}
],
"calculateFields": [
{}
],
"metrics": [
{}
]
},
"errorCode": "string",
"errorMsg": "string"
}
响应参数说明
| 参数 | 参数值说明 |
|---|---|
| success | 请求是否成功，true：成功，false：失败 |
| code | 状态码 |
| message | 提示信息 |
| data | 返回的数据，包含指标集配置的各个分块 |
| data.details | 指标集详情 |
| data.datasets | 指标集关联的数据集列表 |
| data.relationships | 指标集内表间关系 |
| data.calculateFields | 计算字段列表，其中 id 为计算字段 ID |
| data.metrics | 指标列表 |
| errorCode | 错误码 |
| errorMsg | 错误信息 |
上一篇：查看度量属性
