1. 概述
1.1 版本
| FineBI 版本 | 功能变动 |
|---|---|
| 7.5 | 指标服务新增「查看指标血缘」接口 |
1.2 应用场景
模型指标集中指标的血缘关系，除了在数据目录中查看，也可通过本接口直接读取。
接口按指标集 id 和指标 id 返回该指标的血缘，返回内容分为三部分：
| 返回内容 | 说明 |
|---|---|
| nodeInfo | 血缘图中全部节点的属性，以节点 id 为键 |
| parentEdges | 上游节点关系，记录节点之间的父、子指向 |
| childEdges | 下游节点关系，记录节点之间的父、子指向 |
1.3 前提条件
接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见 指标中心数据服务接口。
2. 接口信息
2.1 接口简介
| 项目 | 内容 |
|---|---|
接口作用 | 按指标集 id 和指标 id 查看指标血缘 |
接口 URL | /api/dc/{version}/indicator/metricset/{metricSetId}/metric/{metricId}/consanguinity |
请求类型 | 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/consanguinity |
| 请求头 | Authorization: ******************** |
注：请求地址中的 IP 与端口为示例，{metricSetId}、{metricId} 需替换为实际的模型指标集 id 与指标 id。
2.4 返回示例
{
"success": true,
"code": "200",
"message": "success",
"data": {
"nodeInfo": {
"8da09af019094758ac32ca423939d971": {
"id": "string",
"showName": "string",
"engineType": "string",
"status": 0,
"publishStatus": 0,
"consanguinityLevel": 0,
"consanguinityOverLimit": true,
"parentId": "string",
"manageable": true,
"usable": true,
"viewable": true,
"knots": 0,
"moduleType": 0,
"resourceType": 0,
"tableType": 0
}
},
"parentEdges": [
{
"parent": "string",
"child": "string"
}
],
"childEdges": [
{
"parent": "string",
"child": "string"
}
]
},
"errorCode": null,
"errorMsg": null
}
响应参数说明：
| 参数 | 参数值说明 |
|---|---|
success | 请求是否成功，true：成功，false：失败 |
code | 状态码 |
message | 提示信息 |
data | 指标的血缘信息，包含节点属性、上游节点关系与下游节点关系，各字段说明见下表 |
errorCode | 错误码 |
errorMsg | 错误信息 |
——data 中的参数：
| 参数 | 参数值说明 |
|---|---|
nodeInfo | 血缘图中全部节点的属性，以节点 id 为键，每个节点的字段说明见下表 |
parentEdges | 上游节点关系列表，元素结构见下表 |
childEdges | 下游节点关系列表，元素结构见下表 |
——nodeInfo 中各节点的参数：
| 参数 | 参数值说明 |
|---|---|
id | 节点 id |
showName | 节点名称 |
engineType | 引擎类型 |
status | 状态 |
publishStatus | 发布状态 |
consanguinityLevel | 血缘层级 |
consanguinityOverLimit | 血缘层级是否超限，true：超限，false：未超限 |
parentId | 父文件夹 id |
manageable | 管理权限，true：有，false：无 |
usable | 使用权限，true：有，false：无 |
viewable | 元数据权限，true：有，false：无 |
knots | 下游节点数 |
moduleType | 节点所在模块：数据目录或我的分析 |
resourceType | 资源类型 |
tableType | 表类型 |
——parentEdges、childEdges 中各元素的参数：
| 参数 | 参数值说明 |
|---|---|
parent | 父节点 id，取值对应 nodeInfo 中的键 |
child | 子节点 id，取值对应 nodeInfo 中的键 |
上一篇：查看指标分组
