概述
新建仪表板
接口简介
接口作用 | 新建仪表板 |
接口URL | /v5/api/platform/dashboard/reports |
请求类型 | GET |
请求参数-Query参数
参数名 | 参数值 | 是否必填 | 描述说明 |
---|---|---|---|
dir | {"name":"新建仪表板12","catalog":["新建文件夹"]}注:参数值格式为JSON,使用时需要进行编码 encodeURIComponent() | 是 | 1)name:仪表板名称 2)catalog:仪表板所在文件夹名称 |
响应实例
请求示例 | 编码前参数值: {"name":"销量汇总仪表板","catalog":["管理驾驶舱"]} 编码后参数值: %7B%22name%22%3A%22%E9%94%80%E9%87%8F%E6%B1%87%E6%80%BB%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%2C%22catalog%22%3A%5B%22%E7%AE%A1%E7%90%86%E9%A9%BE%E9%A9%B6%E8%88%B1%22%5D%7D 链接: http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/reports?dir=%7B%22name%22%3A%22%E9%94%80%E9%87%8F%E6%B1%87%E6%80%BB%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%2C%22catalog%22%3A%5B%22%E7%AE%A1%E7%90%86%E9%A9%BE%E9%A9%B6%E8%88%B1%22%5D%7D&fine_auth_token=xxx 注:使用接口时需要登录,需要传递token参数。 |
响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "销量汇总仪表板", "folder": false, "initTime": 1667286510508, "lastUpdateTime": 1667286510508, "id": "7cd524927dcb4913afaa1ef3075b7f92", "createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898", "shared": false, "watermark": true, "hangout": "NORMAL", "publicLink": { "shared": false, "uri": null, "reportId": "7cd524927dcb4913afaa1ef3075b7f92", "linkId": null, "userId": null, "password": null, "passProtected": false }, "mountedDirIds": [], "applyTime": 0, "parents": null, "pId": "e2c8d4b282a64aa0943c9c9162bf2732" }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }) |
截图示意 |
删除仪表板
接口简介
接口作用 | 删除仪表板 |
接口URL | /v5/api/platform/dashboard/report |
请求类型 | GET |
注意事项 | 该接口仅支持删除用户自己创建的仪表板,不支持管理员删除其他用户创建的仪表板 |
请求参数-Query参数
参数名 | 参数值 | 是否必填 | 描述说明 |
---|---|---|---|
info | {"folder":是否是文件夹,"reportId":"模板id"}注:参数值格式为JSON,使用时需要进行编码 encodeURIComponent() | 是 | 1)folder:是否是文件夹 false:仪表板 true:文件夹 2)reportId:模板ID |
响应实例
请求示例 | 编码前参数值: {"folder":false,"reportId":"7cd524927dcb4913afaa1ef3075b7f92"} 编码后参数值: %7B%22folder%22%3Afalse%2C%22reportId%22%3A%227cd524927dcb4913afaa1ef3075b7f92%22%7D 链接: http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/report?info=%7B%22folder%22%3Afalse%2C%22reportId%22%3A%227cd524927dcb4913afaa1ef3075b7f92%22%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/rename |
请求类型 | GET |
请求参数-Query参数
参数名 | 参数值 | 是否必填 | 描述说明 |
---|---|---|---|
info | {"name":"模板名字","newName":"重命名的名字","reportId":"模板id"}注:参数值格式为JSON,使用时需要进行编码 encodeURIComponent() | 是 | 1)name:仪表板名称 2)newname:仪表板新名称 3)reportID:仪表板ID |
响应实例
请求示例 | 编码前参数值: {"name":"地产公司销售监控","newName":"地产部门销量仪表板","reportId":"6aae904df9284bef823921fac05fb247"} 编码后参数值: %7B%22name%22%3A%22%E5%9C%B0%E4%BA%A7%E5%85%AC%E5%8F%B8%E9%94%80%E5%94%AE%E7%9B%91%E6%8E%A7%22%2C%22newName%22%3A%22%E5%9C%B0%E4%BA%A7%E9%83%A8%E9%97%A8%E9%94%80%E9%87%8F%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%2C%22reportId%22%3A%226aae904df9284bef823921fac05fb247%22%7D 链接: http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/report?info=%7B%22name%22%3A%22%E5%9C%B0%E4%BA%A7%E5%85%AC%E5%8F%B8%E9%94%80%E5%94%AE%E7%9B%91%E6%8E%A7%22%2C%22newName%22%3A%22%E5%9C%B0%E4%BA%A7%E9%83%A8%E9%97%A8%E9%94%80%E9%87%8F%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%2C%22reportId%22%3A%226aae904df9284bef823921fac05fb247%22%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参数
参数名 | 参数值 | 是否必填 | 描述说明 |
---|---|---|---|
from | [{"reportId":"仪表板ID"}] | 是 | 需要另存的仪表板ID |
info | {"name":"仪表板名称","parentId":[文件夹ID]} | 是 | 1)name:另存的仪表板名称 2)parentId:另存到的文件夹ID |
响应实例
请求链接 | http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/saveas?fine_auth_token=xxx 注:使用接口时需要登录,需要传递token参数。 |
请求body | { "from": [{"reportId": "6aae904df9284bef823921fac05fb247"}], "to": {"name":"地产行业数据","parentId":"e2c8d4b282a64aa0943c9c9162bf2732"} } |
响应成功 | callback({ "success": true, "code": "200", "message": "success", "data": { "name": "地产行业数据", "folder": false, "initTime": 1667290819848, "lastUpdateTime": 1667290819848, "id": "190d90e5a1d142e68bf734842229f75e", "createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898", "shared": false, "watermark": true, "hangout": "NORMAL", "publicLink": { "shared": false, "uri": null, "reportId": "190d90e5a1d142e68bf734842229f75e", "linkId": null, "userId": null, "password": null, "passProtected": false }, "mountedDirIds": [], "applyTime": 0, "parents": null, "pId": "e2c8d4b282a64aa0943c9c9162bf2732" }, "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 }) |
截图示意 |