资源搜索- FineBI帮助文档 FineBI帮助文档

文档创建者：Lily.Wang

历史版本：1

1. 概述

1.1 版本

FineBI 版本	功能变动
7.5	-

1.2 应用场景

需要在指标服务中按关键字检索资源时，可通过本接口直接搜索。

1.3 前提条件

接口认证：已完成指标服务认证。调用接口前需在请求 Header 中添加 Authorization 参数，认证方式参见指标中心数据服务接口。

2. 接口信息

2.1 接口简介

项目	内容
接口作用	按关键字搜索指标集、数据集、计算字段、指标、维度等资源，可指定资源类型
接口 URL	/api/dc/{version}/indicator/search
请求类型	POST

2.2 请求参数

Header 参数：

参数名	类型	是否必填	说明
Authorization	string	是	认证信息，格式为 Authorization: <认证串>，获取方式参见指标中心数据服务接口

Path 参数：

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

Body 参数：

参数名	类型	是否必填	说明
keyword	string	否	搜索关键字
packageId	string	否	搜索范围所属的资源包 id
pageIndex	integer	否	页码，用于指定返回第几页数据
pageSize	integer	否	每页返回的条数
filter	object	否	搜索过滤条件，说明见下表

——filter 中的参数：

参数名	类型	是否必填	说明
itemTypes	array[integer]	否	限定搜索的资源类型，取值如下： 67：指标集 72：数据集 73：计算字段 65：指标 66：维度 itemTypes 可传入多个类型，接口会按传入的类型范围返回搜索结果；不传时按接口默认范围搜索。

参数名

类型

是否必填

说明

itemTypes

array[integer]

否

限定搜索的资源类型，取值如下：

67：指标集
72：数据集
73：计算字段
65：指标
66：维度

itemTypes 可传入多个类型，接口会按传入的类型范围返回搜索结果；不传时按接口默认范围搜索。

2.3 请求示例

示例

	示例
请求地址	POST http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/search
请求头	Authorization: ********************
请求体	见下方代码块 { "queryId": "18898ce1-4af9-4132-97eb-8a3487e0ea11", "keyword": "1", "force": false, "privilege": "use", "pageIndex": 1, "pageSize": 50, "filter": { "tableTypes": [ 2, 3 ], "itemTypes": [ 3 ], "creators": [ "b5f0c2ee-640f-4039-a4d4-918b55354898" ], "tags": [ "69c069ea-0e89-45a8-a3cb-7bdeaf61ca14", "8b3cef90-77ee-4ae1-add1-8feb996f682d" ], "extensionProperties": [ { "id": "b2667637-9bfc-414f-abc6-2520c60e01ab", "filterValue": [ "3" ] } ] } }

请求地址

POST http://192.168.16.143:10888/webroot/decision/api/dc/v1/indicator/search

请求头

Authorization: ********************

请求体

见下方代码块

{
    "queryId": "18898ce1-4af9-4132-97eb-8a3487e0ea11",
    "keyword": "1",
    "force": false,
    "privilege": "use",
    "pageIndex": 1,
    "pageSize": 50,
    "filter": {
        "tableTypes": [
            2,
            3
        ],
        "itemTypes": [
            3
        ],
        "creators": [
            "b5f0c2ee-640f-4039-a4d4-918b55354898"
        ],
        "tags": [
            "69c069ea-0e89-45a8-a3cb-7bdeaf61ca14",
            "8b3cef90-77ee-4ae1-add1-8feb996f682d"
        ],
        "extensionProperties": [
            {
                "id": "b2667637-9bfc-414f-abc6-2520c60e01ab",
                "filterValue": [
                    "3"
                ]
            }
        ]
    }
}

2.4 返回示例

{
    "success": true,
    "code": "string",
    "message": "string",
    "data": null,
    "errorCode": "string",
    "errorMsg": "string"
}

参数	参数值说明
success	请求是否成功，true：成功，false：失败
code	状态码
message	提示信息
data	搜索结果，结构待补充
errorCode	错误码
errorMsg	错误信息

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

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

有帮助
没帮助
只是浏览

中文（繁體） English 日本語

中文（简体）

资源搜索