數據更新API- FineBI帮助文档 FineBI帮助文档

概述

版本

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

功能簡介

本文講解FineBI6.0中資料更新相關API。

觸發全局更新

API簡介


API作用	觸發全局更新
APIURL	/v5/api/conf/update/generate
請求類型	GET
注意事項	必須對應內容存在更新任務方可觸發更新

回应實例


請求範例	http://172.17.0.25:37799/webroot/decision/v5/api/conf/update/generate?fine_auth_token=xxx 注：使用API時需要登入，需要傳遞token參數。
回应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "taskInstanceId": "6d161bcd-5070-4687-a44c-81b979eb37e3", "failBeans": [] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截圖示意

請求範例

http://172.17.0.25:37799/webroot/decision/v5/api/conf/update/generate?fine_auth_token=xxx

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

回应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"taskInstanceId": "6d161bcd-5070-4687-a44c-81b979eb37e3",

"failBeans": []

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截圖示意

觸發單表/資料夾更新

API簡介


API作用	根據表轉義名，進行單表/資料夾更新。
APIURL	/v5/api/conf/update/pack/table
請求類型	GET
注意事項	必須對應內容存在更新任務方可觸發更新

請求參數-Query參數

參數名	參數值	是否必填	描述說明
info	{"packageId":"資料夾ID","tableName":"表轉義名","fullLoad":"false"} 注：參數值格式為JSON，使用時需要進行編碼 encodeURIComponent()	是	1）資料夾ID： 2）表轉義名：表轉義名即為在資料準備中看到的表名稱 3）fullload： false：增量更新 true：全量更新不填：預設為 true

參數名

參數值

是否必填

描述說明

info

{"packageId":"資料夾ID","tableName":"表轉義名","fullLoad":"false"}
注：參數值格式為JSON，使用時需要進行編碼 encodeURIComponent()

是

1）資料夾ID：

2）表轉義名：

表轉義名即為在資料準備中看到的表名稱

3）fullload：

false：增量更新

true：全量更新

不填：預設為 true

回应實體


請求範例	編碼前參數值： {"packageId":"6fb11e7b1e6e4ff3bcb907a5747527b0","tableName":"各省招生人數表","fullLoad":"true"} 編碼後參數值： %7B%22packageId%22%3A%226fb11e7b1e6e4ff3bcb907a5747527b0%22%2C%22tableName%22%3A%22%E5%90%84%E7%9C%81%E6%8B%9B%E7%94%9F%E4%BA%BA%E6%95%B0%E8%A1%A8%22%2C%22fullLoad%22%3A%22true%22%7D 連結： http://172.17.0.25:37799/webroot/decision/v5/api/conf/update/pack/table?info=%7B%22packageId%22%3A%226fb11e7b1e6e4ff3bcb907a5747527b0%22%2C%22tableName%22%3A%22%E5%90%84%E7%9C%81%E6%8B%9B%E7%94%9F%E4%BA%BA%E6%95%B0%E8%A1%A8%22%2C%22fullLoad%22%3A%22true%22%7D&fine_auth_token=xxx 注：使用API時需要登入，需要傳遞token參數。
回应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "taskInstanceId": "d9e9eb1d-d88c-482a-8af1-8823d1b1cfd0", "failBeans": [] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截圖示意

請求範例

編碼前參數值：

{"packageId":"6fb11e7b1e6e4ff3bcb907a5747527b0","tableName":"各省招生人數表","fullLoad":"true"}

編碼後參數值：

%7B%22packageId%22%3A%226fb11e7b1e6e4ff3bcb907a5747527b0%22%2C%22tableName%22%3A%22%E5%90%84%E7%9C%81%E6%8B%9B%E7%94%9F%E4%BA%BA%E6%95%B0%E8%A1%A8%22%2C%22fullLoad%22%3A%22true%22%7D

連結：

http://172.17.0.25:37799/webroot/decision/v5/api/conf/update/pack/table?info=%7B%22packageId%22%3A%226fb11e7b1e6e4ff3bcb907a5747527b0%22%2C%22tableName%22%3A%22%E5%90%84%E7%9C%81%E6%8B%9B%E7%94%9F%E4%BA%BA%E6%95%B0%E8%A1%A8%22%2C%22fullLoad%22%3A%22true%22%7D&fine_auth_token=xxx

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

回应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"taskInstanceId": "d9e9eb1d-d88c-482a-8af1-8823d1b1cfd0",

"failBeans": []

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截圖示意

觸發批量更新

API簡介


API作用	根據資料夾ID，進行批量更新。
APIURL	/v5/api/conf/update/batch
請求類型	POST
注意事項	必須對應內容存在更新任務方可觸發更新

請求參數-body參數

body	是否必填	描述說明
[ { "packageId":"資料夾ID", "fullLoad":false } ]	是	1）資料夾ID： 2）fullload： false：增量更新 true：全量更新不填：預設為 true

body

是否必填

描述說明

[

{

"packageId":"資料夾ID",

"fullLoad":false

}

]

是

1）資料夾ID：

2）fullload：

false：增量更新

true：全量更新

不填：預設為 true

回应實體


請求連結	http://172.17.0.25:37799/webroot/decision/v5/api/conf/update/batch?fine_auth_token=xxx 注：使用API時需要登入，需要傳遞token參數。
請求body	[ { "packageId":"6fb11e7b1e6e4ff3bcb907a5747527b0", "fullLoad":false } ]
回应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "taskInstanceId": "e193cba7-2b2c-48c7-8388-c0ff4796975c", "failBeans": [] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截圖示意

獲取此次更新實體的資訊

API簡介


API作用	根據更新任務ID，獲取此次更新資訊。
APIURL	/v5/api/conf/update/instance/{taskInstanceId}
請求類型	GET
注意事項	taskInstanceId為更新任務ID

回应實體


請求範例	http://172.17.0.25:37799/webroot/decision/v5/api/conf/update/instance/e193cba7-2b2c-48c7-8388-c0ff4796975c?fine_auth_token=xxx 注：使用API時需要登入，需要傳遞token參數。
回应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "taskInstanceId": "e193cba7-2b2c-48c7-8388-c0ff4796975c", "taskName": "BI-Update_Api_Batch_Update", "startTime": 1669027681571, "endTime": 1669027683766, "state": 1, "waitStatus": 0, "triggerMode": 1, "triggerType": 3, "costTime": 2195, "resultType": 1, "roleName": "API", "baseTableExpect": 6, "baseTableFinish": 6, "analysisTableExpect": 0, "analysisTableFinish": 0, "relationExpect": 0, "relationFinish": 0, "auth": true, "process": 0.0, "cancel": false, "inLine": false }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截圖示意

請求範例

http://172.17.0.25:37799/webroot/decision/v5/api/conf/update/instance/e193cba7-2b2c-48c7-8388-c0ff4796975c?fine_auth_token=xxx

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

回应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"taskInstanceId": "e193cba7-2b2c-48c7-8388-c0ff4796975c",

"taskName": "BI-Update_Api_Batch_Update",

"startTime": 1669027681571,

"endTime": 1669027683766,

"state": 1,

"waitStatus": 0,

"triggerMode": 1,

"triggerType": 3,

"costTime": 2195,

"resultType": 1,

"roleName": "API",

"baseTableExpect": 6,

"baseTableFinish": 6,

"analysisTableExpect": 0,

"analysisTableFinish": 0,

"relationExpect": 0,

"relationFinish": 0,

"auth": true,

"process": 0.0,

"cancel": false,

"inLine": false

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截圖示意

回应參數說明

參數	值說明
taskInstanceId	更新任務ID
taskName	更新任務名稱
startTime	更新開始時間
endTime	更新結束時間
state	更新狀態 1：已結束 2：正在運作中
triggerType	觸發方式 1：手動 2：定時 3：內部
resultType	運作結果 1：全部成功 2：部分成功

上一篇：Web頁面整合常見問題

下一篇：數據表API

有帮助
没帮助
只是浏览
圖片不清晰
用語看不懂
功能說明看不懂
操作說明太簡單
內容有錯誤

中文（简体） English 日本語

中文（繁體）

數據更新API

概述

版本

功能簡介

觸發全局更新

觸發單表/資料夾更新

觸發批量更新

獲取此次更新實體的資訊

附件列表