数据目录文件夹接口- FineBI帮助文档 FineBI帮助文档

版本

FineBI服务器版本	功能变更
7.0	-

功能简介

本文讲解FineBI中「数据目录」下文件夹相关接口。

接口简介


接口作用	添加文件夹
接口URL	/v5/api/pack/{groupId}/add
请求类型	GET
注意事项	1）使用该接口添加文件夹时，无法指定文件夹的命名，只能添加默认文件夹 2）groupId为父文件夹ID

响应实例


请求示例	http://192.168.101.92:8883/webroot/decision/v5/api/pack/13dd317974a144f886dbaaec51df46c6/add 注：使用接口时需要登录，需要传递token参数。正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录测试阶段可通过「Authorization>Bearer Token」输入 token 值
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "id": "c09f77ee6a964b2787e8967f43152f45", "name": "文件夹", "initTime": 1767749976286, "visible": false, "editable": true, "usable": true, "createBy": "admin", "parentId": "13dd317974a144f886dbaaec51df46c6", "coopAnalysis": false, "creatorAuth": false, "folders": [], "subjects": [], "tables": {}, "indexes": {}, "dimensions": {}, "businessModels": {} }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://192.168.101.92:8883/webroot/decision/v5/api/pack/13dd317974a144f886dbaaec51df46c6/add

注：使用接口时需要登录，需要传递token参数。

正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录
测试阶段可通过「Authorization>Bearer Token」输入 token 值

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"id": "c09f77ee6a964b2787e8967f43152f45",

"name": "文件夹",

"initTime": 1767749976286,

"visible": false,

"editable": true,

"usable": true,

"createBy": "admin",

"parentId": "13dd317974a144f886dbaaec51df46c6",

"coopAnalysis": false,

"creatorAuth": false,

"folders": [],

"subjects": [],

"tables": {},

"indexes": {},

"dimensions": {},

"businessModels": {}

},

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

响应参数说明

参数	参数值说明
id	创建的文件夹ID
name	创建的文件夹名称
initTime	创建文件夹的时间
editable	是否可编辑 true：是 false：否
createBy	文件夹创建者用户名
parentID	文件夹所在父文件夹ID
coopAnalysis	是否协作给当前用户 true：是 false：否
creatorAuth	是否拥有和创建者相等的权限 true：是 false：否

接口简介


接口作用	重命名文件夹
接口URL	/v5/api/pack/{packId}/rename
请求类型	GET
注意事项	packId为文件夹ID

请求参数-Query参数

参数名	参数值	是否必填
newName	业务包新名称	是

响应实例


请求示例	http://192.168.101.92:8883/webroot/decision/v5/api/pack/13dd317974a144f886dbaaec51df46c6/rename?newName=银行金融业注：使用接口时需要登录，需要传递token参数。正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录测试阶段可通过「Authorization>Bearer Token」输入 token 值
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://192.168.101.92:8883/webroot/decision/v5/api/pack/13dd317974a144f886dbaaec51df46c6/rename?newName=银行金融业

注：使用接口时需要登录，需要传递token参数。

正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录
测试阶段可通过「Authorization>Bearer Token」输入 token 值

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": [],

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

接口简介


接口作用	删除文件夹
接口URL	/v5/api/pack/delete
请求类型	POST

请求参数-body参数

body	是否必填	描述说明
{"packIds":["文件夹ID"]}	是	packIds为待删除的文件夹ID

响应实例


请求链接	http://192.168.101.92:8883/webroot/decision/v5/api/pack/delete 注：使用接口时需要登录，需要传递token参数。正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录测试阶段可通过「Authorization>Bearer Token」输入 token 值
请求body	{ "packIds":["6b1034a0175b4654a20250a9603933f7"] }
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": [] "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

接口简介


接口作用	获取文件夹信息
接口URL	/v5/api/conf/packs/{packId}/structure
请求类型	GET
注意事项	packId为文件夹ID

响应实例


请求示例	http://192.168.101.92:8883/webroot/decision/v5/api/conf/packs/13dd317974a144f886dbaaec51df46c6/structure 注：使用接口时需要登录，需要传递token参数。正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录测试阶段可通过「Authorization>Bearer Token」输入 token 值
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "id": "13dd317974a144f886dbaaec51df46c6", "name": "示例数据", "initTime": 1761804371586, "visible": false, "editable": true, "usable": true, "createBy": "admin", "parentId": "__root_group__", "position": "数据目录/示例数据", "coopAnalysis": false, "creatorAuth": false, "folders": [], "subjects": [], "tables": {}, "indexes": {}, "dimensions": {}, "businessModels": {} }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://192.168.101.92:8883/webroot/decision/v5/api/conf/packs/13dd317974a144f886dbaaec51df46c6/structure

注：使用接口时需要登录，需要传递token参数。

正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录
测试阶段可通过「Authorization>Bearer Token」输入 token 值

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"id": "13dd317974a144f886dbaaec51df46c6",

"name": "示例数据",

"initTime": 1761804371586,

"visible": false,

"editable": true,

"usable": true,

"createBy": "admin",

"parentId": "__root_group__",

"position": "数据目录/示例数据",

"coopAnalysis": false,

"creatorAuth": false,

"folders": [],

"subjects": [],

"tables": {},

"indexes": {},

"dimensions": {},

"businessModels": {}

},

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

响应参数说明

参数	参数值说明
id	文件夹ID
name	文件夹名称
initTime	文件夹创建时间
editable	文件夹是否可编辑
createBy	文件夹创建者用户名
parentID	文件夹所在父文件夹ID
position	文件夹位置信息
coopAnalysis	是否协作给当前用户 true：是 false：否
creatorAuth	是否拥有和创建者相等的权限 true：是 false：否
folders	文件夹下子文件夹信息

接口简介


接口作用	获取文件夹中表信息
接口URL	/v5/api/conf/packs/{packId}
请求类型	GET
注意事项	packId为文件夹ID

响应实例


请求示例	http://192.168.101.92:8883/webroot/decision/v5/api/conf/packs/6fb11e7b1e6e4ff3bcb907a5747527b0 注：使用接口时需要登录，需要传递token参数。正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录测试阶段可通过「Authorization>Bearer Token」输入 token 值
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "id": "6fb11e7b1e6e4ff3bcb907a5747527b0", "name": "教育培训", "initTime": 1727573099210, "visible": false, "editable": true, "usable": true, "createBy": "admin", "parentId": "2802469f40b14094aa7372ea2488a830", "position": "数据目录/行业数据/教育培训", "coopAnalysis": false, "creatorAuth": false, "folders": [], "subjects": [], "tables": { "availableTables": [ { "name": "d8a353cb33b7445ba20fd29c9c675247", "transferName": "客户跟踪信息2", "type": 2, "createBy": "admin", "initTime": 1767518035654, "comment": null, "validStatus": "VALID", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "editable": true, "usable": true, "sqlEditable": true, "position": "数据目录/行业数据/教育培训", "publishStatus": 0, "coopAnalysis": false, "creatorAuth": false, "connectionName": "BI Demo", "moduleType": 1, "extractDataSetting": 0, "inherit": false, "belongAnalysis": false, "configUpdateTime": 1767518035654, "activeType": 0, "updateMode": 0, "consanguinityLevel": 1, "consanguinityOverLimit": false, "canSwitchRealtime": false, "dbMode": 0, "engineType": "direct" }, { "name": "30f2a03bc5f744539a10800b8b369967", "transferName": "产品", "type": 2, "createBy": "admin", "initTime": 1765941342336, "comment": "234", "validStatus": "VALID", "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0", "editable": true, "usable": true, "sqlEditable": true, "position": "数据目录/行业数据/教育培训", "publishStatus": 0, "coopAnalysis": false, "creatorAuth": false, "connectionName": "FRDemo", "moduleType": 1, "extractDataSetting": 0, "inherit": false, "belongAnalysis": false, "configUpdateTime": 1765941342336, "activeType": 0, "updateMode": 0, "consanguinityLevel": 1, "consanguinityOverLimit": false, "canSwitchRealtime": false, "dbMode": 0, "engineType": "direct" }, ] }, "indexes": { "availableIndexes": [] }, "dimensions": { "availableDimensions": [] }, "businessModels": { "availableModels": [] } }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://192.168.101.92:8883/webroot/decision/v5/api/conf/packs/6fb11e7b1e6e4ff3bcb907a5747527b0

注：使用接口时需要登录，需要传递token参数。

正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录
测试阶段可通过「Authorization>Bearer Token」输入 token 值

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"id": "6fb11e7b1e6e4ff3bcb907a5747527b0",

"name": "教育培训",

"initTime": 1727573099210,

"visible": false,

"editable": true,

"usable": true,

"createBy": "admin",

"parentId": "2802469f40b14094aa7372ea2488a830",

"position": "数据目录/行业数据/教育培训",

"coopAnalysis": false,

"creatorAuth": false,

"folders": [],

"subjects": [],

"tables": {

"availableTables": [

{

"name": "d8a353cb33b7445ba20fd29c9c675247",

"transferName": "客户跟踪信息2",

"type": 2,

"createBy": "admin",

"initTime": 1767518035654,

"comment": null,

"validStatus": "VALID",

"parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

"editable": true,

"usable": true,

"sqlEditable": true,

"position": "数据目录/行业数据/教育培训",

"publishStatus": 0,

"coopAnalysis": false,

"creatorAuth": false,

"connectionName": "BI Demo",

"moduleType": 1,

"extractDataSetting": 0,

"inherit": false,

"belongAnalysis": false,

"configUpdateTime": 1767518035654,

"activeType": 0,

"updateMode": 0,

"consanguinityLevel": 1,

"consanguinityOverLimit": false,

"canSwitchRealtime": false,

"dbMode": 0,

"engineType": "direct"

},

{

"name": "30f2a03bc5f744539a10800b8b369967",

"transferName": "产品",

"type": 2,

"createBy": "admin",

"initTime": 1765941342336,

"comment": "234",

"validStatus": "VALID",

"parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

"editable": true,

"usable": true,

"sqlEditable": true,

"position": "数据目录/行业数据/教育培训",

"publishStatus": 0,

"coopAnalysis": false,

"creatorAuth": false,

"connectionName": "FRDemo",

"moduleType": 1,

"extractDataSetting": 0,

"inherit": false,

"belongAnalysis": false,

"configUpdateTime": 1765941342336,

"activeType": 0,

"updateMode": 0,

"consanguinityLevel": 1,

"consanguinityOverLimit": false,

"canSwitchRealtime": false,

"dbMode": 0,

"engineType": "direct"

},

]

},

"indexes": {

"availableIndexes": []

},

"dimensions": {

"availableDimensions": []

},

"businessModels": {

"availableModels": []

}

},

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

接口简介


接口作用	获取「数据目录」根文件夹信息
接口URL	/v5/api/conf/groups
请求类型	GET

响应实例

请求示例
http://192.168.101.92:8883/webroot/decision/v5/api/conf/groups
注：使用接口时需要登录，需要传递token参数。
正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录
测试阶段可通过「Authorization>Bearer Token」输入 token 值
响应成功
callback({
"success": true,
"code": "200",
"message": "success",
"data": {
"id": "__root_group__",
"name": "__root_group__",
"initTime": 0,
"visible": false,
"editable": true,
"usable": false,
"coopAnalysis": false,
"creatorAuth": false,
"folders": [
{
"id": "13dd317974a144f886dbaaec51df46c6",
"name": "示例数据",
"initTime": 1761804371586,
"visible": true,
"editable": true,
"usable": true,
"createBy": "admin",
"parentId": "__root_group__",
"coopAnalysis": false,
"creatorAuth": false,
"folders": [],
"subjects": [],
"tables": {},
"indexes": {},
"dimensions": {},
"businessModels": {}
},
{
"id": "2802469f40b14094aa7372ea2488a830",
"name": "行业数据",
"initTime": 1727573097890,
"visible": true,
"editable": true,
"usable": true,
"createBy": "admin",
"parentId": "__root_group__",
"coopAnalysis": false,
"creatorAuth": false,
"folders": [],
"subjects": [],
"tables": {},
"indexes": {},
"dimensions": {},
"businessModels": {}
}
],
"order": []
},
"errorCode": null,
"detailErrorMsg": null,
"errorMsg": null
})
截图示意

数据目录文件夹接口

概述

版本

功能简介

添加文件夹

重命名文件夹

删除文件夹

获取文件夹信息

获取文件夹中表信息

获取数据目录根文件夹信息

附件列表