概述
建立儀表板
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":"e5c58a91c26143299551ba73d856242f","reportName":"範例儀表板"} 編碼後參數值： %7B%22subjectId%22%3A%22e5c58a91c26143299551ba73d856242f%22%2C%22reportName%22%3A%22%E7%A4%BA%E4%BE%8B%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%7D 連結： http://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/reports?data=%7B%22subjectId%22%3A%22e5c58a91c26143299551ba73d856242f%22%2C%22reportName%22%3A%22%E7%A4%BA%E4%BE%8B%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%7D&fine_auth_token=xxx 注：使用API時需要登入，需要傳遞token參數。 |
| 回应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "範例儀表板", "initTime": 0, "lastUpdateTime": 0, "id": "eac08a88be5d42d2878870eed76dc2ab", "shared": false, "publishStatus": 0, "editable": true, "publicLink": { "shared": false, "passProtected": false, "deadline": 0 }, "coopAnalysis": false, "creatorAuth": false }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截圖示意 |  |
回应參數說明
| 參數 | 參數值說明 |
|---|---|
| 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://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/report?reportId=eac08a88be5d42d2878870eed76dc2ab&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/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":"c2594718581f493f951f055b0f3122f6","nameUpdateBean":{"name": "新手入門範例","mouduleType": "2"}} 編碼後參數值： %7B%22reportId%22%3A%22c2594718581f493f951f055b0f3122f6%22%2C%22nameUpdateBean%22%3A%7B%22name%22%3A%22%E6%96%B0%E6%89%8B%E5%85%A5%E9%97%A8%E7%A4%BA%E4%BE%8B%22%2C%22mouduleType%22%3A%222%22%7D%7D 連結： http://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/rename?info=%7B%22reportId%22%3A%22c2594718581f493f951f055b0f3122f6%22%2C%22nameUpdateBean%22%3A%7B%22name%22%3A%22%E6%96%B0%E6%89%8B%E5%85%A5%E9%97%A8%E7%A4%BA%E4%BE%8B%22%2C%22mouduleType%22%3A%222%22%7D%7D&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/platform/dashboard/saveas |
| 請求類型 | POST |
請求參數-body參數
| 參數 | 是否必填 | 描述說明 |
|---|---|---|
{ "subjectId":"主題ID", "originReportId":"儀表板ID", "name": "新儀表板名稱" } | 是 | 1）subjectId：儀表板需要複製到的主題ID 2）originReportId：待複製的儀表板ID 3）name：新儀表板的名稱 |
回应實體
| 請求連結 | http://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/saveas?fine_auth_token=xxx 注：使用API時需要登入，需要傳遞token參數。 |
| 請求body | { "subjectId":"e5c58a91c26143299551ba73d856242f", "originReportId":"c2594718581f493f951f055b0f3122f6", "name": "新儀表板" } |
| 回应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "新儀表板", "initTime": 0, "lastUpdateTime": 0, "id": "d50955bcbe8e4823b9d5c206e71c8672", "shared": false, "publishStatus": 0, "editable": true, "publicLink": { "shared": false, "passProtected": false, "deadline": 0 }, "coopAnalysis": false, "creatorAuth": false }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截圖示意 | |
建立公共連結
API簡介
| API作用 | 建立儀表板的公共連結 |
| APIURL | /v5/api/platform/dashboard/{reportId}/create |
| 請求類型 | GET |
| 注意事項 | reportID為儀表板ID |
回应實體
| 請求範例 | http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/6aae904df9284bef823921fac05fb247/create?fine_auth_token=xxx 注：使用API時需要登入，需要傳遞token參數。 |
| 回应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "shared": true, "uri": "eyJhbGciOiJIUzI1NiJ9.eyJyZXBvcnRJZCI6IjZhYWU5MDRkZjkyODRiZWY4MjM5MjFmYWMwNWZiMjQ3IiwidXNlcklkIjoiYjVmMGMyZWUtNjQwZi00MDM5LWE0ZDQtOTE4YjU1MzU0ODk4IiwianRpIjoiand0In0.yYFVpSwlmFieGoK01ghIOTHw5HudraJ5dzvYdtvzfCw", "reportId": "6aae904df9284bef823921fac05fb247", "linkId": "tMnh", "userId": "b5f0c2ee-640f-4039-a4d4-918b55354898", "password": null, "passProtected": false }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
| 截圖示意 | |
