您正在浏覽的是 FineBI 7.X 幫助文檔，點選跳轉至 FineBI 6.X 幫助文檔。

儀表板編輯API

概述

版本

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

功能簡介

本文講解FineBI中儀表板編輯相關API。

建立儀表板

API簡介



API作用建立儀表板
APIURL/v5/api/platform/dashboard/reports
請求類型GET

請求參數-Query參數

參數名
參數值是否必填描述說明
data

{

"subjectId":"主題ID",

"reportName":"儀表板名稱"

}注：參數值格式為JSON，使用時需要進行編碼 encodeURIComponent()

是

1）subjectId：儀表板所在主題ID

選中主題後，URL中subject後面的ID即為主題ID

2）reportName：儀表板名稱

回应實體



請求範例

編碼前參數值：

{"subjectId":"44cec6b1637c4cb79333410507a50bd5","reportName":"範例儀表板"}

編碼後參數值：

%7B%22subjectId%22:%2244cec6b1637c4cb79333410507a50bd5%22,%22reportName%22:%22%E7%A4%BA%E4%BE%8B%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%7D

連結：

http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/reports?data=%7B%22subjectId%22:%2244cec6b1637c4cb79333410507a50bd5%22,%22reportName%22:%22%E7%A4%BA%E4%BE%8B%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%7D

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

  • 正式工程推薦配置單點登入，否則嵌入式整合後，需要反覆登入

  • 測試階段可透過「Authorization>Bearer Token」輸入 token 值

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "name": "範例儀表板",

        "initTime": 0,

        "lastUpdateTime": 0,

        "id": "d46d49e0c80f474d9f744e23b5b5c44b",

        "shared": false,

        "publishStatus": 0,

        "editable": true,

        "publicLink": {

            "type": 0,

            "shared": false,

            "passProtected": false,

            "deadline": 0,

            "exportable": false

        },

        "coopAnalysis": false,

        "creatorAuth": false

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})


截圖示意Gemini_Generated_Image_w9mh6tw9mh6tw9mh.png

回应參數說明

參數
參數值說明
name儀表板名稱
initTime建立時間

lastUpdateTime

最近修改時間
id儀表板ID
shared

是否分享

true：是

false：否

publicStatus

發佈狀態

0：未發佈

1：已發佈

editable

是否可編輯

true：是

false：否

publicLink公共連結
coopAnalysis

是否協作給當前使用者

true：是

false：否

creatorAuth

是否擁有和建立者相等的權限

true：是

false：否

刪除儀表板

API簡介



API作用刪除儀表板
APIURL/v5/api/platform/dashboard/report
請求類型GET

請求參數-Query參數

參數名
參數值是否必填
reportId

待刪除的儀表板ID

是

回应實體



請求範例

http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/report?reportId=d46d49e0c80f474d9f744e23b5b5c44b

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

  • 正式工程推薦配置單點登入，否則嵌入式整合後，需要反覆登入

  • 測試階段可透過「Authorization>Bearer Token」輸入 token 值

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截圖示意

重新命名儀表板

API簡介



API作用重新命名儀表板
APIURL/v5/api/platform/dashboard/rename
請求類型GET

請求參數-Query參數

參數名
參數值是否必填描述說明
info

{

    "reportId":"儀表板id",

    "nameUpdateBean":

    {

        "name": "儀表板新名稱",

        "mouduleType": "1/2"

    }

}

注：參數值格式為JSON，使用時需要進行編碼 encodeURIComponent()

是

1）reportID：儀表板ID

2）name：儀表板新名稱

3）mouduleType：模組類別（1：公共資料，2：我的分析）

回应實體



請求範例

編碼前參數值：

{"reportId":"274aee6161f54f8eaf38ae3414917ab0","nameUpdateBean":{"name": "新手入門範例","mouduleType": "2"}}

編碼後參數值：

%7B%22reportId%22:%22274aee6161f54f8eaf38ae3414917ab0%22,%22nameUpdateBean%22:%7B%22name%22:%20%22%E6%96%B0%E6%89%8B%E5%85%A5%E9%97%A8%E7%A4%BA%E4%BE%8B%22,%22mouduleType%22:%20%222%22%7D%7D

連結：

http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/rename?info=%7B%22reportId%22:%22274aee6161f54f8eaf38ae3414917ab0%22,%22nameUpdateBean%22:%7B%22name%22:%20%22%E6%96%B0%E6%89%8B%E5%85%A5%E9%97%A8%E7%A4%BA%E4%BE%8B%22,%22mouduleType%22:%20%222%22%7D%7D

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

  • 正式工程推薦配置單點登入，否則嵌入式整合後，需要反覆登入

  • 測試階段可透過「Authorization>Bearer Token」輸入 token 值

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": [],

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截圖示意

儀表板另存為

API簡介



API作用儀表板另存
APIURL/v5/api/platform/dashboard/saveas
請求類型POST

請求參數-body參數

參數是否必填描述說明

{

    "subjectId":"主題ID",

    "originReportId":"儀表板ID",

    "name": "新儀表板名稱"

}

是

1）subjectId：儀表板需要複製到的主題ID

2）originReportId：待複製的儀表板ID

3）name：新儀表板的名稱

回应實體



請求連結

http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/saveas

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

  • 正式工程推薦配置單點登入，否則嵌入式整合後，需要反覆登入

  • 測試階段可透過「Authorization>Bearer Token」輸入 token 值

請求body

{

    "subjectId":"44cec6b1637c4cb79333410507a50bd5",

    "originReportId":"274aee6161f54f8eaf38ae3414917ab0",

    "name": "新儀表板"

}

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "name": "新儀表板",

        "initTime": 0,

        "lastUpdateTime": 0,

        "id": "050cfdce42f2488eaa3f8f2733bbca36",

        "shared": false,

        "publishStatus": 0,

        "editable": true,

        "publicLink": {

            "type": 0,

            "shared": false,

            "passProtected": false,

            "deadline": 0,

            "exportable": false

        },

        "coopAnalysis": false,

        "creatorAuth": false

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截圖示意

建立公共連結

API簡介



API作用建立儀表板的公共連結
APIURL/v5/api/platform/dashboard/{reportId}/create
請求類型GET
注意事項reportID為儀表板ID

回应實體



請求範例

http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/7b489909260045cb8de75f0084156e26/create?userId=b5f0c2ee-640f-4039-a4d4-918b55354898

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

  • 正式工程推薦配置單點登入，否則嵌入式整合後，需要反覆登入

  • 測試階段可透過「Authorization>Bearer Token」輸入 token 值

回应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "type": 0,

        "shared": true,

        "uri": "eyJhbGciOiJIUzI1NiJ9.eyJyZXBvcnRJZCI6IjdiNDg5OTA5MjYwMDQ1Y2I4ZGU3NWYwMDg0MTU2ZTI2IiwidXNlcklkIjoiNjIxYmViODQtNTliNy00MTJjLWIyZjMtNzhhN2I3YWVhYjFhIiwianRpIjoiand0In0.nScnomL8fK_Pu2ofFTFHzCjFAH_kU7tI6_BFCgVtAqs",

        "resourceId": "7b489909260045cb8de75f0084156e26",

        "linkId": "SC5S",

        "userId": "621beb84-59b7-412c-b2f3-78a7b7aeab1a",

        "passProtected": false,

        "deadline": 0,

        "subResource": [],

        "exportable": false

    },

    "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
不能為空

反馈已提交

网络繁忙