最新历史版本 :公共数据文件夹接口 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

概述编辑

版本

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

功能简介

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

添加文件夹编辑

接口简介



接口作用添加文件夹
接口URL

/v5/api/pack/{groupId}/add

请求类型GET
注意事项

1）使用该接口添加文件夹时，无法指定文件夹的命名，只能添加默认文件夹

2）groupId为父文件夹ID

响应实例




请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/pack/6fb11e7b1e6e4ff3bcb907a5747527b0/add?fine_auth_token=XXX

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "id": "2cfe4508927f4f46a6611026177a4fe0",

        "name": "文件夹",

        "initTime": 1669101345235,

        "editable": true,

        "createBy": "1",

        "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

        "coopAnalysis": false,

        "creatorAuth": false,

        "folders": [],

        "subjects": [],

        "tables": {}

    },

    "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://172.17.0.25:37799/webroot/decision/v5/api/pack/2cfe4508927f4f46a6611026177a4fe0/rename?newName=银行金融业&fine_auth_token=XXX

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意

删除文件夹编辑

接口简介




接口作用删除文件夹
接口URL

/v5/api/pack/delete

请求类型POST
注意事项

与5.X接口不同


请求参数-body参数

body是否必填描述说明

{"packIds":"文件夹ID"}

是

packIds为待删除的文件夹ID

响应实例



请求链接

http://172.17.0.25:37799/webroot/decision/v5/api/pack/delete?fine_auth_token=XXX

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

请求body{

"packIds":"2cfe4508927f4f46a6611026177a4fe0"

}

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "success": {

            "tableNames": [],

            "widgetIds": [],

            "reportIds": [],

            "subjectIds": [],

            "packIds": []

        },

        "fail": {

            "tableNames": [],

            "widgetIds": [],

            "reportIds": [],

            "subjectIds": [],

            "packIds": []

        },

        "errorDetailBeanMap": {}

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意

获取文件夹信息编辑

接口简介



接口作用获取文件夹信息
接口URL

/v5/api/conf/packs/{packId}/structure

请求类型GET
注意事项

1）packId为文件夹ID

2）与5.X接口不同

响应实例



请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/conf/packs/6fb11e7b1e6e4ff3bcb907a5747527b0/structure?fine_auth_token=XXX

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "id": "6fb11e7b1e6e4ff3bcb907a5747527b0",

        "name": "教育培训",

        "initTime": 1660903942357,

        "editable": true,

        "createBy": "1",

        "parentId": "2802469f40b14094aa7372ea2488a830",

        "position": "公共数据/行业数据/教育培训",

        "coopAnalysis": false,

        "creatorAuth": false,

        "folders": [

            {

                "id": "2cfe4508927f4f46a6611026177a4fe0",

                "name": "银行金融业",

                "initTime": 1669101345235,

                "editable": true,

                "createBy": "1",

                "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

                "coopAnalysis": false,

                "creatorAuth": false,

                "folders": [],

                "subjects": [],

                "tables": {}

            }

        ],

        "subjects": [],

        "tables": {}

    },

    "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://172.17.0.25:37799/webroot/decision/v5/api/conf/packs/6fb11e7b1e6e4ff3bcb907a5747527b0?fine_auth_token=XXX

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "id": "6fb11e7b1e6e4ff3bcb907a5747527b0",

        "name": "教育培训",

        "initTime": 1660903942357,

        "editable": true,

        "createBy": "1",

        "parentId": "2802469f40b14094aa7372ea2488a830",

        "position": "公共数据/行业数据/教育培训",

        "coopAnalysis": false,

        "creatorAuth": false,

        "folders": [

            {

                "id": "2cfe4508927f4f46a6611026177a4fe0",

                "name": "银行金融业",

                "initTime": 1669101345235,

                "editable": true,

                "createBy": "1",

                "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

                "coopAnalysis": false,

                "creatorAuth": false,

                "folders": [],

                "subjects": [],

                "tables": {}

            }

        ],

        "subjects": [],

        "tables": {

            "availableTables": [

                {

                    "name": "BI Demo_教师信息表",

                    "transferName": "教育_教师信息表",

                    "type": 2,

                    "createBy": "1",

                    "initTime": 0,

                    "comment": null,

                    "validStatus": "VALID",

                    "parentId": "6fb11e7b1e6e4ff3bcb907a5747527b0",

                    "editable": true,

                    "sqlEditable": true,

                    "position": "公共数据/行业数据/教育培训",

                    "publishStatus": 0,

                    "coopAnalysis": false,

                    "creatorAuth": false,

                    "connectionName": "BI Demo",

                    "moduleType": 1,

                    "extractDataSetting": 0,

                    "inherit": false,

                    "belongAnalysis": false,

                    "configUpdateTime": 1655283315926,

                    "engineType": "spider"

                }

            ]

        }

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意


获取公共数据根文件夹信息编辑

接口简介



接口作用获取「公共数据」根文件夹信息
接口URL

/v5/api/conf/groups

请求类型GET

响应实例



请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/conf/groups?fine_auth_token=XXX

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "id": "__root_group__",

        "name": "__root_group__",

        "initTime": 0,

        "editable": true,

        "coopAnalysis": false,

        "creatorAuth": false,

        "folders": [

            {

                "id": "de20c13fdcdd436987289588b232c38c",

                "name": "功能数据",

                "initTime": 1531138781428,

                "editable": true,

                "createBy": "1",

                "parentId": "__root_group__",

                "coopAnalysis": false,

                "creatorAuth": false,

                "folders": [],

                "subjects": [],

                "tables": {}

            },

            {

                "id": "17bb42b152e3425fa0e2dd827191131a",

                "name": "部门数据",

                "initTime": 1660900345241,

                "editable": true,

                "createBy": "1",

                "parentId": "__root_group__",

                "coopAnalysis": false,

                "creatorAuth": false,

                "folders": [],

                "subjects": [],

                "tables": {}

            },

            {

                "id": "2802469f40b14094aa7372ea2488a830",

                "name": "行业数据",

                "initTime": 1663224796865,

                "editable": true,

                "createBy": "1",

                "parentId": "__root_group__",

                "coopAnalysis": false,

                "creatorAuth": false,

                "folders": [],

                "subjects": [],

                "tables": {}

            }

        ]

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意