仪表板信息接口- FineBI帮助文档 FineBI帮助文档

文档创建者：Carly

历史版本：6

最近更新：Carly 于 2022-12-01

概述

版本

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

功能简介

本文讲解FineBI5.1中仪表板信息相关接口。

获取用户信息和用户创建的仪表板

接口简介


接口作用	获取用户信息和用户创建的仪表板
接口URL	/v5/api/dashboard/user/info
请求类型	GET

响应实例


请求示例	http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/user/info?fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "userInfo": { "displayName": "艾可(eoco)", "postNames": [ "会计" ], "departmentNames": [ "财务部" ], "customRoleNames": [ "普通角色" ], "departmentPosts": [ { "jobTitle": "会计", "departments": "财务部" } ] }, "dashboards": [ { "id": "ae57a67fb2e3457aa78d92b8faac096a", "name": "测试仪表板", "folder": false, "initTime": 1667302452906, "lastUpdateTime": 1667302452906, "shared": false, "watermark": true, "pId": "5a2e3378-a87d-4916-9fd9-bdc4e1c27b57", "createBy": "5a2e3378-a87d-4916-9fd9-bdc4e1c27b57", "hangout": "NORMAL", "publicLink": { "shared": false, "uri": null, "reportId": "ae57a67fb2e3457aa78d92b8faac096a", "userId": "5a2e3378-a87d-4916-9fd9-bdc4e1c27b57", "password": null, "passProtected": false }, "mountedDirIds": [], "applyTime": 0 } ] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/user/info?fine_auth_token=xxx

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

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"userInfo": {

"displayName": "艾可(eoco)",

"postNames": [

"会计"

"departmentNames": [

"财务部"

"customRoleNames": [

"普通角色"

"departmentPosts": [

{

"jobTitle": "会计",

"departments": "财务部"

}

]

"dashboards": [

{

"id": "ae57a67fb2e3457aa78d92b8faac096a",

"name": "测试仪表板",

"folder": false,

"initTime": 1667302452906,

"lastUpdateTime": 1667302452906,

"shared": false,

"watermark": true,

"pId": "5a2e3378-a87d-4916-9fd9-bdc4e1c27b57",

"createBy": "5a2e3378-a87d-4916-9fd9-bdc4e1c27b57",

"hangout": "NORMAL",

"publicLink": {

"shared": false,

"uri": null,

"reportId": "ae57a67fb2e3457aa78d92b8faac096a",

"userId": "5a2e3378-a87d-4916-9fd9-bdc4e1c27b57",

"password": null,

"passProtected": false

"mountedDirIds": [],

"applyTime": 0

}

]

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

模板管理节点所有仪表板信息

接口简介


接口作用	获取模板管理节点下的仪表板信息
接口URL	/v5/api/dashboard/search
请求类型	GET
注意事项	使用该接口的用户，必须有模板管理节点权限

请求参数-Query参数

参数名	参数值	是否必填
page	模板管理的页面页码	是
count	每页信息数量	是

响应实例


请求示例	http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/search?page=1&count=1&fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "reportIndexList": [ { "userInfo": { "displayName": "1(1)", "postNames": [], "departmentNames": [], "customRoleNames": [ "superusers" ], "departmentPosts": [] }, "reportIndex": { "id": "fdb1c4c1ee2644018d9d9ec645f4541b", "name": "组合图", "folder": false, "initTime": 1531280621843, "lastUpdateTime": 1540792417642, "shared": false, "watermark": true, "pId": "462d6d86188543d3a4989684b11b0f24", "createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898", "hangout": "HANGOUT", "publicLink": { "shared": false, "uri": null, "reportId": "fdb1c4c1ee2644018d9d9ec645f4541b", "userId": "b5f0c2ee-640f-4039-a4d4-918b55354898", "password": null, "passProtected": false }, "mountedDirIds": [ "12d2cd33-a224-473f-bacc-af35389c9fe9" ], "applyTime": 0, "fullNames": [ "功能演示", "图表分析", "基础图表", "组合图" ] } } ], "applyingCount": 0, "totalCount": 126 }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/search?page=1&count=1&fine_auth_token=xxx

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

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"reportIndexList": [

{

"userInfo": {

"displayName": "1(1)",

"postNames": [],

"departmentNames": [],

"customRoleNames": [

"superusers"

"departmentPosts": []

"reportIndex": {

"id": "fdb1c4c1ee2644018d9d9ec645f4541b",

"name": "组合图",

"folder": false,

"initTime": 1531280621843,

"lastUpdateTime": 1540792417642,

"shared": false,

"watermark": true,

"pId": "462d6d86188543d3a4989684b11b0f24",

"createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898",

"hangout": "HANGOUT",

"publicLink": {

"shared": false,

"uri": null,

"reportId": "fdb1c4c1ee2644018d9d9ec645f4541b",

"userId": "b5f0c2ee-640f-4039-a4d4-918b55354898",

"password": null,

"passProtected": false

"mountedDirIds": [

"12d2cd33-a224-473f-bacc-af35389c9fe9"

"applyTime": 0,

"fullNames": [

"功能演示",

"图表分析",

"基础图表",

"组合图"

]

}

"applyingCount": 0,

"totalCount": 126

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

接口简介


接口作用	获取某个目录下的仪表板和目录列表
接口URL	/v5/api/platform/dashboard/list
请求类型	GET

请求参数-Query参数

参数名	参数值	是否必填	描述说明
dir	{"catalog":["新建文件夹"],"reportId":"7e6382e9fe5448b38bb0bc3f50913b5d"}注：参数值格式为JSON，使用时需要进行编码 encodeURIComponent()	是	1）catalog：文件夹名称 2）reportId：文件夹ID 注：若需查看根目录下的文件夹，reportId值为用户ID

参数名

参数值

是否必填

描述说明

dir

{"catalog":["新建文件夹"],"reportId":"7e6382e9fe5448b38bb0bc3f50913b5d"}注：参数值格式为JSON，使用时需要进行编码 encodeURIComponent()

是

1）catalog：文件夹名称

2）reportId：文件夹ID

注：若需查看根目录下的文件夹，reportId值为用户ID

响应实例


请求示例	编码前参数值： {"catalog":["管理驾驶舱"],"reportId":"e2c8d4b282a64aa0943c9c9162bf2732"} 编码后参数值： %7B%22catalog%22%3A%5B%22%E7%AE%A1%E7%90%86%E9%A9%BE%E9%A9%B6%E8%88%B1%22%5D%2C%22reportId%22%3A%22e2c8d4b282a64aa0943c9c9162bf2732%22%7D 链接： http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/list?dir=%7B%22catalog%22%3A%5B%22%E7%AE%A1%E7%90%86%E9%A9%BE%E9%A9%B6%E8%88%B1%22%5D%2C%22reportId%22%3A%22e2c8d4b282a64aa0943c9c9162bf2732%22%7D&fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": [ { "name": "新建文件夹", "folder": true, "initTime": 1667291790745, "lastUpdateTime": 1667291790745, "id": "d85ebb8840f1415c894348e38d433c86", "createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898", "shared": false, "watermark": true, "hangout": "NORMAL", "publicLink": { "shared": false, "uri": null, "reportId": "d85ebb8840f1415c894348e38d433c86", "linkId": null, "userId": "b5f0c2ee-640f-4039-a4d4-918b55354898", "password": null, "passProtected": false }, "mountedDirIds": [], "applyTime": 0, "parents": null, "pId": "e2c8d4b282a64aa0943c9c9162bf2732" }, { "name": "集团CEO看板", "folder": false, "initTime": 1533289033311, "lastUpdateTime": 1667291950197, "id": "e9bf9ea3f0de40d08281ebc9753f4942", "createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898", "shared": false, "watermark": true, "hangout": "HANGOUT", "publicLink": { "shared": false, "uri": null, "reportId": "e9bf9ea3f0de40d08281ebc9753f4942", "linkId": null, "userId": "b5f0c2ee-640f-4039-a4d4-918b55354898", "password": null, "passProtected": false }, "mountedDirIds": [ "8125aead-556f-43f0-bbf2-a64bb68fd4d7" ], "applyTime": 0, "parents": null, "pId": "e2c8d4b282a64aa0943c9c9162bf2732" } ], "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

编码前参数值：

{"catalog":["管理驾驶舱"],"reportId":"e2c8d4b282a64aa0943c9c9162bf2732"}

编码后参数值：

%7B%22catalog%22%3A%5B%22%E7%AE%A1%E7%90%86%E9%A9%BE%E9%A9%B6%E8%88%B1%22%5D%2C%22reportId%22%3A%22e2c8d4b282a64aa0943c9c9162bf2732%22%7D

链接：

http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/list?dir=%7B%22catalog%22%3A%5B%22%E7%AE%A1%E7%90%86%E9%A9%BE%E9%A9%B6%E8%88%B1%22%5D%2C%22reportId%22%3A%22e2c8d4b282a64aa0943c9c9162bf2732%22%7D&fine_auth_token=xxx

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

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": [

{

"name": "新建文件夹",

"folder": true,

"initTime": 1667291790745,

"lastUpdateTime": 1667291790745,

"id": "d85ebb8840f1415c894348e38d433c86",

"createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898",

"shared": false,

"watermark": true,

"hangout": "NORMAL",

"publicLink": {

"shared": false,

"uri": null,

"reportId": "d85ebb8840f1415c894348e38d433c86",

"linkId": null,

"userId": "b5f0c2ee-640f-4039-a4d4-918b55354898",

"password": null,

"passProtected": false

"mountedDirIds": [],

"applyTime": 0,

"parents": null,

"pId": "e2c8d4b282a64aa0943c9c9162bf2732"

{

"name": "集团CEO看板",

"folder": false,

"initTime": 1533289033311,

"lastUpdateTime": 1667291950197,

"id": "e9bf9ea3f0de40d08281ebc9753f4942",

"createBy": "b5f0c2ee-640f-4039-a4d4-918b55354898",

"shared": false,

"watermark": true,

"hangout": "HANGOUT",

"publicLink": {

"shared": false,

"uri": null,

"reportId": "e9bf9ea3f0de40d08281ebc9753f4942",

"linkId": null,

"userId": "b5f0c2ee-640f-4039-a4d4-918b55354898",

"password": null,

"passProtected": false

"mountedDirIds": [

"8125aead-556f-43f0-bbf2-a64bb68fd4d7"

"applyTime": 0,

"parents": null,

"pId": "e2c8d4b282a64aa0943c9c9162bf2732"

}

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

获取仪表板信息

接口简介


接口作用	获取仪表板的信息
接口URL	/v5/api/platform/dashboard/reports/info
请求类型	GET

请求参数-Query参数

参数名	参数值	是否必填	描述说明
info	{"index":[ { "id":"仪表板ID" }] }注：参数值格式为JSON，使用时需要进行编码 encodeURIComponent()	是	id：仪表板ID

响应实例


请求示例	编码前参数值： {"index":[ { "id":"6aae904df9284bef823921fac05fb247" }] } 编码后参数值： %7B%22index%22%3A%5B%7B%22id%22%3A%226aae904df9284bef823921fac05fb247%22%7D%5D%7D 链接： http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/reports/info?info=%7B%22index%22%3A%5B%7B%22id%22%3A%226aae904df9284bef823921fac05fb247%22%7D%5D%7D&fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
响应成功	callback({ "success": true, "code": "200", "message": "success", "data": { "index": [ { "name": "地产公司销售监控", "folder": false, "initTime": 1533632466066, "lastUpdateTime": 1667291364167, "id": "6aae904df9284bef823921fac05fb247", "createBy": "1", "shared": false, "watermark": true, "hangout": null, "publicLink": null, "mountedDirIds": [], "applyTime": 0, "parents": null, "pId": "e2c8d4b282a64aa0943c9c9162bf2732" } ] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null })
截图示意

请求示例

编码前参数值：

{"index":[ { "id":"6aae904df9284bef823921fac05fb247" }] }

编码后参数值：

%7B%22index%22%3A%5B%7B%22id%22%3A%226aae904df9284bef823921fac05fb247%22%7D%5D%7D

链接：

http://172.17.0.20:37799/webroot/decision/v5/api/platform/dashboard/reports/info?info=%7B%22index%22%3A%5B%7B%22id%22%3A%226aae904df9284bef823921fac05fb247%22%7D%5D%7D&fine_auth_token=xxx

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

响应成功

callback({

"success": true,

"code": "200",

"message": "success",

"data": {

"index": [

{

"name": "地产公司销售监控",

"folder": false,

"initTime": 1533632466066,

"lastUpdateTime": 1667291364167,

"id": "6aae904df9284bef823921fac05fb247",

"createBy": "1",

"shared": false,

"watermark": true,

"hangout": null,

"publicLink": null,

"mountedDirIds": [],

"applyTime": 0,

"parents": null,

"pId": "e2c8d4b282a64aa0943c9c9162bf2732"

}

]

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

})

截图示意

仪表板血缘分析

接口简介


接口作用	获取仪表板血缘信息
接口URL	/v5/api/dashboard/report/consanguinity
请求类型	GET

请求参数-Query参数

参数名	参数值	是否必填
reportId	仪表板ID	是

响应实例


请求示例	http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/report/consanguinity?reportId=6aae904df9284bef823921fac05fb247&fine_auth_token=xxx 注：使用接口时需要登录，需要传递token参数。
响应成功	{ "success": true, "code": "200", "message": "success", "data": { "reportId": "6aae904df9284bef823921fac05fb247", "reportName": "地产公司销售监控", "widgets": [ { "widgetId": "0770210f5b8e423e", "widgetName": "<p style=\"text-align: center;\"><span style=\"color: rgb(62, 173, 255);\"><font style=\"font-size: 12px;\">销售面积总数</font></span></p>", "tables": [ { "tableName": "FACT_SALE_CONTRACT", "transferName": "签约事实表", "packageName": "地产行业", "packageId": "7de04fa13a4c4f14af9f51605fb44a88", "fields": [ { "fieldId": "FACT[5f]SALE[5f]CONTRACT_BLDAREA", "fieldName": "BLDAREA", "transferName": "销售面积" } ], "dbTableName": "FACT_SALE_CONTRACT", "connectionName": "BI Demo", "type": 1 } ] }, { "widgetId": "e283dbb10520e213", "widgetName": "文本组件1", "tables": [] } ] }, "errorCode": null, "detailErrorMsg": null, "errorMsg": null }
截图示意

请求示例

http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/report/consanguinity?reportId=6aae904df9284bef823921fac05fb247&fine_auth_token=xxx

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

响应成功

{

"success": true,

"code": "200",

"message": "success",

"data": {

"reportId": "6aae904df9284bef823921fac05fb247",

"reportName": "地产公司销售监控",

"widgets": [

{

"widgetId": "0770210f5b8e423e",

"widgetName": "销售面积总数",

"tables": [

{

"tableName": "FACT_SALE_CONTRACT",

"transferName": "签约事实表",

"packageName": "地产行业",

"packageId": "7de04fa13a4c4f14af9f51605fb44a88",

"fields": [

{

"fieldId": "FACT[5f]SALE[5f]CONTRACT_BLDAREA",

"fieldName": "BLDAREA",

"transferName": "销售面积"

}

"dbTableName": "FACT_SALE_CONTRACT",

"connectionName": "BI Demo",

"type": 1

}

]

{

"widgetId": "e283dbb10520e213",

"widgetName": "文本组件1",

"tables": []

}

]

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

}

截图示意

已经是第一篇

已经是最后一篇

有帮助
没帮助
只是浏览

售前咨询电话

400-811-8890转1

在线技术支持

请前往「服务平台」，选择「在线支持」

热线电话：400-811-8890转2

在线QQ（将在2023.01.03关停）：800049425

总裁办24H投诉

热线电话：173-1278-1526

文档反馈

鼠标选中内容，快速反馈问题

鼠标选中存在疑惑的内容，即可快速反馈问题，我们将会跟进处理。

不再提示

10s后关闭

仪表板信息接口

概述

版本

功能简介

获取用户信息和用户创建的仪表板

模板管理节点所有仪表板信息

获取目录下仪表板和目录列表

获取仪表板信息

仪表板血缘分析

附件列表