指标/维度语义信息接口- FineBI帮助文档 FineBI帮助文档

文档创建者：April陶

历史版本：3

最近更新：April陶于 2026-01-28

1. 概述

1.1 版本

FineBI 版本	功能变动
7.0.7	-

1.2 应用场景

本文讲解 FineBI 中发布到「数据目录」的指标维度相关信息查看的 API 接口。

1.3 前置条件

认证方式请参考文档：指标服务

2. 查看指标属性

接口简介


接口作用	查看指标属性
接口URL	/api/dc/{version}/indicator/metric/{metricId}/info
请求类型	GET
权限	元数据权限

请求参数

Path 参数

参数名	类型	参数值	是否必填
version	string	接口版本号示例：v1	是
metricId	string	指标id 示例：c99a001e-edbd-4ead-acbe-ef762d4b7990	是

参数名

类型

参数值

是否必填

version

string

接口版本号

示例：v1

是

metricId

string

指标id

示例：c99a001e-edbd-4ead-acbe-ef762d4b7990

是

响应实例


请求示例	http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/metric/c99a001e-edbd-4ead-acbe-ef762d4b7990/info
响应成功	查看对应指标的指标属性信息
截图示意

请求示例

http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/metric/c99a001e-edbd-4ead-acbe-ef762d4b7990/info

响应成功

查看对应指标的指标属性信息

截图示意

响应参数说明

参数	参数值
id	指标/维度id
pId	父文件夹id
approver	审批者 userld：用户id displayName：用户显示名 userName：用户
creator	创建者用户显示名
createTime	创建时间
editTime	编辑时间
type	数据类型 16：文本 32：数值 48：时间
tags	标签 id：标签id name：标签名 description：标签描述
extensionProperties	扩展字段 type：扩展字段类型枚举值: 16：字符串 32：数值 48：文本 64：单选 65：多选 80：用户单选 81：用户多选 required：是否启用 value：扩展字段值
validStatus	标红状态枚举值: VALID：正常 INVALID：标红
caliber	计算口径 id：指标/维度id name：指标/维度名 formula：公式 fields：公式所用字段 type：公式类型；固定值：1

更多详情返回响应的参数详情请参见：API服务-指标属性

3. 查看指标血缘

接口简介


接口作用	查看指标血缘
接口URL	/api/dc/{version}/indicator/metric/{metricId}/consanguinity
请求类型	GET
权限	元数据权限

请求参数

Path 参数

参数名	类型	参数值	是否必填
version	string	接口版本号示例：v1	是
metricId	string	指标id 示例：c99a001e-edbd-4ead-acbe-ef762d4b7990	是

参数名

类型

参数值

是否必填

version

string

接口版本号

示例：v1

是

metricId

string

指标id

示例：c99a001e-edbd-4ead-acbe-ef762d4b7990

是

响应实例


请求示例	http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/metric/c99a001e-edbd-4ead-acbe-ef762d4b7990/consanguinity
响应成功	返回指标的血缘信息
截图示意

请求示例

http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/metric/c99a001e-edbd-4ead-acbe-ef762d4b7990/consanguinity

响应成功

返回指标的血缘信息

截图示意

响应参数说明

参数	参数值
nodeInfo	所有节点属性 id：节点id showName：id名称 engineType：引擎类型 status：状态 publishstatus：发布状态 consanguinityLevel：血缘层级 consanguinityOverlimit：血缘层级是否超限 idparentld：父文件夹 manageable：管理权限 usable：使用权限 viewable：元数据权限 knots：下游节点数 moduleType：数据目录/我的分析 resourceType：资源类型 tableType：表类型
parentEdges	父节点展示指标的血缘视图中父节点的上下游节点id
childEdges	子节点展示指标的血缘视图中子节点的上下游节点id

参数

参数值

nodeInfo

所有节点属性

id：节点id
showName：id名称
engineType：引擎类型
status：状态
publishstatus：发布状态
consanguinityLevel：血缘层级
consanguinityOverlimit：血缘层级是否超限
idparentld：父文件夹
manageable：管理权限
usable：使用权限
viewable：元数据权限
knots：下游节点数
moduleType：数据目录/我的分析
resourceType：资源类型
tableType：表类型

parentEdges

父节点

展示指标的血缘视图中父节点的上下游节点id

childEdges

子节点

展示指标的血缘视图中子节点的上下游节点id

4. 查看指标相关维度

接口简介


接口作用	查看指标相关维度
接口URL	/api/dc/{version}/indicator/metric/{metricId}/relate/dimension
请求类型	GET
权限	元数据权限

请求参数

Path 参数

参数名	类型	参数值	是否必填
version	string	接口版本号示例：v1	是
metricId	string	指标id 示例：c99a001e-edbd-4ead-acbe-ef762d4b7990	是

参数名

类型

参数值

是否必填

version

string

接口版本号

示例：v1

是

metricId

string

指标id

示例：c99a001e-edbd-4ead-acbe-ef762d4b7990

是

响应实例


请求示例	http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/metric/c99a001e-edbd-4ead-acbe-ef762d4b7990/relate/dimension
响应成功	返回指标的相关维度信息
截图示意

请求示例

http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/metric/c99a001e-edbd-4ead-acbe-ef762d4b7990/relate/dimension

响应成功

返回指标的相关维度信息

截图示意

响应参数说明

参数	参数值
id	指标/维度id
name	指标/维度名
type	数据类型 16：文本 32：数值 48：时间
description	描述
validStatus	标红状态枚举值: VALID：正常 INVALID：标红

5. 查看维度属性

接口简介


接口作用	查看维度属性
接口URL	/api/dc/{version}/indicator/dimension/{dimensionId}/info
请求类型	GET
权限	元数据权限

请求参数

Path 参数

参数名	类型	参数值	是否必填
version	string	接口版本号示例：v1	是
dimensionId	string	维度id 示例：e174341b-6730-4579-89e8-abe62355ec23	是

参数名

类型

参数值

是否必填

version

string

接口版本号

示例：v1

是

dimensionId

string

维度id

示例：e174341b-6730-4579-89e8-abe62355ec23

是

响应实例


请求示例	http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/dimension/e174341b-6730-4579-89e8-abe62355ec23/info
响应成功	返回维度属性信息
截图示意

请求示例

http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/dimension/e174341b-6730-4579-89e8-abe62355ec23/info

响应成功

返回维度属性信息

截图示意

响应参数说明

参数	参数值
id	指标/维度id
pId	父文件夹id
description	数据描述
approver	审批者 userld：用户id displayName：用户显示名 userName：用户
creator	创建者用户显示名
createTime	创建时间
editTime	编辑时间
type	数据类型 16：文本 32：数值 48：时间
tags	标签 id：标签id name：标签名 description：标签描述
extensionProperties	扩展字段 type：扩展字段类型枚举值: 16：字符串 32：数值 48：文本 64：单选 65：多选 80：用户单选 81：用户多选 required：是否启用 value：扩展字段值
validStatus	标红状态枚举值: VALID：正常 INVALID：标红
caliber	计算口径 id：指标/维度id name：指标/维度名 formula：公式 fields：公式所用字段 type：公式类型；固定值：1

更多详情返回响应的参数详情请参见：API服务-维度属性

6. 查看维度血缘

接口简介


接口作用	查看指标血缘
接口URL	/api/dc/{version}/indicator/dimension/{dimensionId}/consanguinity
请求类型	GET
权限	元数据权限

请求参数

Path 参数

参数名	类型	参数值	是否必填
version	string	接口版本号示例：v1	是
dimensionId	string	维度id 示例：e174341b-6730-4579-89e8-abe62355ec23	是

参数名

类型

参数值

是否必填

version

string

接口版本号

示例：v1

是

dimensionId

string

维度id

示例：e174341b-6730-4579-89e8-abe62355ec23

是

响应实例


请求示例	http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/dimensionId/e174341b-6730-4579-89e8-abe62355ec23/consanguinity
响应成功	返回维度的血缘信息
截图示意

请求示例

http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/dimensionId/e174341b-6730-4579-89e8-abe62355ec23/consanguinity

响应成功

返回维度的血缘信息

截图示意

响应参数说明

参数	参数值
nodeInfo	所有节点属性 id：节点id showName：名称 engineType：引擎类型 status：状态 publishstatus：发布状态 consanguinityLevel：血缘层级 consanguinityOverlimit：血缘层级是否超限 idparentld：父文件夹 manageable：管理权限 usable：使用权限 viewable：元数据权限 knots：下游节点数 moduleType：数据目录/我的分析 resourceType：资源类型 tableType：表类型
parentEdges	父节点展示指标的血缘视图中父节点的上下游节点id
childEdges	子节点展示指标的血缘视图中子节点的上下游节点id

参数

参数值

nodeInfo

所有节点属性

id：节点id
showName：名称
engineType：引擎类型
status：状态
publishstatus：发布状态
consanguinityLevel：血缘层级
consanguinityOverlimit：血缘层级是否超限
idparentld：父文件夹
manageable：管理权限
usable：使用权限
viewable：元数据权限
knots：下游节点数
moduleType：数据目录/我的分析
resourceType：资源类型
tableType：表类型

parentEdges

父节点

展示指标的血缘视图中父节点的上下游节点id

childEdges

子节点

展示指标的血缘视图中子节点的上下游节点id

7. 查看维度相关指标

接口简介


接口作用	查看维度相关指标
接口URL	/api/dc/{version}/indicator/dimension/{dimensionId}/relate/metric
请求类型	GET
权限	元数据权限

请求参数

Path 参数

参数名	类型	参数值	是否必填
version	string	接口版本号示例：v1	是
metricId	string	维度id 示例：e174341b-6730-4579-89e8-abe62355ec23	是

参数名

类型

参数值

是否必填

version

string

接口版本号

示例：v1

是

metricId

string

维度id

示例：e174341b-6730-4579-89e8-abe62355ec23

是

响应实例


请求示例	http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/dimension/e174341b-6730-4579-89e8-abe62355ec23/relate/metric
响应成功	返回维度的相关指标信息
截图示意

请求示例

http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/dimension/e174341b-6730-4579-89e8-abe62355ec23/relate/metric

响应成功

返回维度的相关指标信息

截图示意

响应参数说明

参数	参数值
id	指标/维度id
name	指标/维度名
type	数据类型 16：文本 32：数值 48：时间
description	描述
validStatus	标红状态枚举值: VALID：正常 INVALID：标红

8. 查看维度值

接口简介


接口作用	查看维度值
接口URL	/api/dc/{version}/indicator/dimension/{dimensionId}/data
请求类型	POST

请求参数

Path 参数

参数名	类型	参数值	是否必填
version	string	接口版本号示例：v1	是
dimensionId	string	维度id 示例：e174341b-6730-4579-89e8-abe62355ec23	是

参数名

类型

参数值

是否必填

version

string

接口版本号

示例：v1

是

dimensionId

string

维度id

示例：e174341b-6730-4579-89e8-abe62355ec23

是

Body 参数

参数名	类型	参数值	是否必填
keyword	string	搜索关键词	否
limit	object	分页	是
queryId	string	搜索id	是
pageIndex	integer	分页页码	是
pageSize	integer	分页数据量	是

响应实例


请求示例	http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/dimension/{dimensionId}/data
响应成功	返回维度字段的值
截图示意	请求：响应：

请求示例

http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/dimension/{dimensionId}/data

响应成功

返回维度字段的值

截图示意

请求：

响应：

响应参数说明

参数	参数值
dimensionName	维度名
type	数据类型 16：文本 32：数值 48：时间
data	维度值
pageinfo	分页
pageCount	分页数据量
pageIndex	分页页码
rowCount	总数据量

下一篇：指标数据查询/校验接口

有帮助
没帮助
只是浏览

中文（繁體） English 日本語

中文（简体）

指标/维度语义信息接口

1. 概述

1.1 版本

1.2 应用场景

1.3 前置条件

2. 查看指标属性

3. 查看指标血缘

4. 查看指标相关维度

5. 查看维度属性

6. 查看维度血缘

7. 查看维度相关指标

8. 查看维度值

附件列表