公共數據資料夾API

概述

版本

FineBI伺服器版本
功能變更
6.0-

功能簡介

本文講解FineBI中「公共資料」下資料夾相關API。

新增資料夾

API簡介



API作用新增資料夾
APIURL

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

請求類型GET
注意事項

1）使用該API新增資料夾時，無法指定資料夾的命名，只能新增預設資料夾

2）groupId為父資料夾ID

回应實體




請求範例

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

注：使用API時需要登入，需要傳遞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：否

重新命名資料夾

API簡介



API作用重新命名資料夾
APIURL

/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

注：使用API時需要登入，需要傳遞token參數。

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截圖示意

刪除資料夾

API簡介



API作用刪除資料夾
APIURL

/v5/api/pack/delete

請求類型POST
注意事項

與5.XAPI不同

請求參數-body參數

body是否必填描述說明

{"packIds":"資料夾ID"}

是

packIds為待刪除的資料夾ID

回应實體



請求連結

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

注：使用API時需要登入，需要傳遞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

})

截圖示意

獲取資料夾資訊

API簡介



API作用獲取資料夾資訊
APIURL

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

請求類型GET
注意事項

1）packId為資料夾ID

2）與5.XAPI不同

回应實體



請求範例

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

注：使用API時需要登入，需要傳遞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資料夾下子資料夾資訊

獲取資料夾中表資訊

API簡介



API作用獲取資料夾中表資訊
APIURL

/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

注：使用API時需要登入，需要傳遞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

})

截圖示意

獲取公共資料根資料夾資訊

API簡介



API作用獲取「公共資料」根資料夾資訊
APIURL

/v5/api/conf/groups

請求類型GET

回应實體



請求範例

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

注：使用API時需要登入，需要傳遞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

})

截圖示意


附件列表


主题： 部署整合
上一篇：數據表API
下一篇：儀表板查看API
  • 有帮助
  • 没帮助
  • 只是浏览
  • 圖片不清晰
  • 用語看不懂
  • 功能說明看不懂
  • 操作說明太簡單
  • 內容有錯誤
中文（简体） English 日本語
中文（繁體）

滑鼠選中內容，快速回饋問題

滑鼠選中存在疑惑的內容，即可快速回饋問題，我們將會跟進處理。

不再提示

10s後關閉

獲取幫助
線上支援
獲取專業技術支援，快速幫助您解決問題
工作日9:00-12:00，13:30-17:30在线
頁面反饋
針對當前網頁的建議、問題反饋
售前咨詢
獲取報價：
FineReport FineBI
預約演示：
FineReport FineBI
業務咨詢
電話：0933-790886或 0989-092892
郵箱：taiwan@fanruan.com
頁面反饋
*問題分類
不能為空
問題描述
0/1000
不能為空

反馈已提交

网络繁忙