仪表板编辑接口- FineBI帮助文档 FineBI帮助文档

文档创建者：Carly

历史版本：3

最近更新：Carly 于 2023-05-18

概述

版本

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

功能简介

本文讲解FineBI中仪表板编辑相关接口。

新建仪表板

接口简介


接口作用	新建仪表板
接口URL	/v5/api/platform/dashboard/reports
请求类型	GET

请求参数-Query参数

参数名	参数值	是否必填	描述说明
data	{ "subjectId":"主题ID", "reportName":"仪表板名称" }注：参数值格式为JSON，使用时需要进行编码 encodeURIComponent()	是	1）subjectId：仪表板所在主题ID 选中主题后，URL中subject后面的ID即为主题ID 2）reportName：仪表板名称

参数名

参数值

是否必填

描述说明

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 注：使用接口时需要登录，需要传递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 })
截图示意

请求示例

编码前参数值：

{"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

注：使用接口时需要登录，需要传递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：否

删除仪表板

接口简介


接口作用	删除仪表板
接口URL	/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 注：使用接口时需要登录，需要传递token参数。
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/report?reportId=eac08a88be5d42d2878870eed76dc2ab&fine_auth_token=xxx

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

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": [],

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

重命名仪表板

接口简介


接口作用	重命名仪表板
接口URL	/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：我的分析）

参数名

参数值

是否必填

描述说明

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 注：使用接口时需要登录，需要传递token参数。
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": [], "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

编码前参数值：

{"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

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

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": [],

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

仪表板另存为

接口简介


接口作用	仪表板另存
接口URL	/v5/api/platform/dashboard/saveas
请求类型	POST

请求参数-body参数

参数	是否必填	描述说明
{ "subjectId":"主题ID", "originReportId":"仪表板ID", "name": "新仪表板名称" }	是	1）subjectId：仪表板需要复制到的主题ID 2）originReportId：待复制的仪表板ID 3）name：新仪表板的名称

参数

是否必填

描述说明

{

"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 注：使用接口时需要登录，需要传递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 })
截图示意

创建公共链接

接口简介


接口作用	创建仪表板的公共链接
接口URL	/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 注：使用接口时需要登录，需要传递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 })
截图示意

请求示例

http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/6aae904df9284bef823921fac05fb247/create?fine_auth_token=xxx

注：使用接口时需要登录，需要传递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

})

截图示意