数据目录搜索接口- FineBI帮助文档 FineBI帮助文档

文档创建者：April陶

历史版本：4

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

1. 概述

1.1 版本

FineBI 版本	功能变动
7.0.7	-

1.2 应用场景

本文讲解 FineBI 中「数据目录」搜索相关的 API 接口。对应 FineBI 的功能如下图所示：

1.3 前置条件

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

2. 接口信息

接口简介


接口作用	获取用户想要的资源
接口URL	/api/dc/{version}/indicator/search
请求类型	POST

请求参数

Path 参数

参数名	类型	参数值	是否必填
version	string	接口版本号示例：v1	是

参数名

类型

参数值

是否必填

version

string

接口版本号

示例：v1

是

Body 参数

参数名	子参数名	类型	参数值	是否必填
keyword	-	string	搜索关键词	是
packageId	-	string	文件夹id 支持在文件夹下搜索，缺省时表示全局搜索	否
queryId	-	string	搜索id	否
pageIndex	-	integer	分页页码	是
pageSize	-	integer	分页数据量	是
force	-	boolean	true 则不纠错	是
privilege	-	enum<string>	权限 view：元数据权限 use：使用权限	是
filter	-	object(过滤 req)	过滤条件	否
filter	itemTypes	array [anyOf]	类型枚举值: 3：表 65：指标 66：维度 67：业务模型 49：文件夹	否
	tableTypes	array[integer]	表类型枚举值: 2：sql表 3：excel表 4：自助数据集 5：服务器数据集 9：etl数据集	否
	tags	array[string]	标签 id	否
	fields	array[string]	字段名	否
	creators	array[string]	创建者 id	否
	initTime	object	创建时间 startTime（integer，必填） endTime（integer，必填）	否
extensionProperties	-	array [object]	扩展字段	否
extensionProperties	id	string	扩展字段id	是
extensionProperties	filterValue	array[string]	扩展字段值	是

响应实例


请求示例	http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/search
响应成功	返回数据目录下满足筛选条件的数据资源
截图示意	请求：响应： { "success": true, "code": "200", "message": "success", "data": { "keyword": "毛利率", "items": [ { "id": "a2594100-58bf-4d4d-af00-839722e86a43", "modelId": "ffb74eda-091d-4f00-910a-76ce38449472", "name": "毛利率", "engineType": "spider", "initTime": 1766661174825, "editTime": 0, "parentId": "ae16c3429bca46ab926210d3c01e1809", "usable": true, "resourceType": 65, "position": "数据目录/数据目录", "type": 32, "constant": false, "tags": [ { "id": "6608baae-bc1f-4835-bde6-0d456b09f941", "name": "A" } ], "fields": [ "毛利率" ], "path": [ { "id": "__root_group__", "name": "数据目录" }, { "id": "ae16c3429bca46ab926210d3c01e1809", "name": "数据目录" } ], "approver": [], "authApplyStatus": 2, "itemType": 65 } ], "highlight": [ "毛利率" ], "count": 1, "pageCount": 1, "pageIndex": 1, "total": 1373, "type": 1 }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }

请求示例

http://secure.finedevelop.com:63702/webroot/decision/api/dc/v1/indicator/search

响应成功

返回数据目录下满足筛选条件的数据资源

截图示意

请求：

响应：

{
    "success": true,
    "code": "200",
    "message": "success",
    "data": {
        "keyword": "毛利率",
        "items": [
            {
                "id": "a2594100-58bf-4d4d-af00-839722e86a43",
                "modelId": "ffb74eda-091d-4f00-910a-76ce38449472",
                "name": "毛利率",
                "engineType": "spider",
                "initTime": 1766661174825,
                "editTime": 0,
                "parentId": "ae16c3429bca46ab926210d3c01e1809",
                "usable": true,
                "resourceType": 65,
                "position": "数据目录/数据目录",
                "type": 32,
                "constant": false,
                "tags": [
                    {
                        "id": "6608baae-bc1f-4835-bde6-0d456b09f941",
                        "name": "A"
                    }
                ],
                "fields": [
                    "毛利率"
                ],
                "path": [
                    {
                        "id": "__root_group__",
                        "name": "数据目录"
                    },
                    {
                        "id": "ae16c3429bca46ab926210d3c01e1809",
                        "name": "数据目录"
                    }
                ],
                "approver": [],
                "authApplyStatus": 2,
                "itemType": 65
            }
        ],
        "highlight": [
            "毛利率"
        ],
        "count": 1,
        "pageCount": 1,
        "pageIndex": 1,
        "total": 1373,
        "type": 1
    },
    "errorCode": null,
    "detailErrorMsg": null,
    "errorMsg": null
}

响应参数说明

参数	参数值
keyword	搜索关键词
highlight	高亮词
items	搜索结果集
count	总数
pageCount	分页数据量
pageIndex	分页页码
type	搜索类型区分普通搜索、高级搜索、AI搜索枚举值: 普通搜索增强搜索 AI搜索
correct（增强搜索）	是否纠错
correctWord	纠错之后的搜索关键词

更多详情返回响应的参数详情请参见：API服务-搜索

上一篇：指标中心数据服务接口

下一篇：指标/维度语义信息接口

有帮助
没帮助
只是浏览

中文（繁體） English 日本語

中文（简体）

数据目录搜索接口

1. 概述

1.1 版本

1.2 应用场景

1.3 前置条件

2. 接口信息

附件列表