历史版本4 :仪表板信息接口 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

概述编辑

版本

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

功能简介

本文讲解FineBI中仪表板信息相关接口。

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

接口简介



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

响应实例



请求示例

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

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "userInfo": {

            "displayName": "丽莎(Lisa)",

            "postNames": [

                "销售主管"

            ],

            "departmentNames": [

                "销售部"

            ],

            "customRoleNames": [

                "普通角色"

            ],

            "departmentPosts": [

                {

                    "jobTitle": "销售主管",

                    "departments": "销售部"

                }

            ]

        },

        "dashboards": [

            {

                "reportId": "8bb79578cfc2418d910e73cfcea8d415",

                "name": "示例仪表板",

                "initTime": 1669171806820,

                "lastUpdateTime": 0,

                "createBy": "9bdd489c-518b-40f8-8566-786f78ffe64a",

                "watermark": true

            }

        ]

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意

发布管理节点所有仪表板信息编辑

接口简介



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

请求参数-Query参数

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

响应实例



请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/dashboard/search?page=2&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": {

                    "reportId": "b86db205e71b40d3b1f08f194f44084f",

                    "name": "新仪表板",

                    "initTime": 1669111495607,

                    "lastUpdateTime": 0,

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

                    "watermark": true

                }

            }

        ],

        "applyingCount": 2,

        "totalCount": 74

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意

获取主题下的仪表板列表编辑

接口简介



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

请求参数-Query参数

参数名
参数值是否必填
subjectId主题ID
是

响应实例



请求示例

http://172.17.0.25:37799/webroot/decision/v5/api/platform/dashboard/list?subjectId=5540f238907b472bbedd7595e0260614&fine_auth_token=xxx

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "name": "地产公司数据监控",

        "editable": true,

        "coopAnalysis": false,

        "creatorAuth": true,

        "tables": {

            "availableTables": []

        },

        "reports": {

            "availableReports": [

                {

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

                    "initTime": 1533632466066,

                    "lastUpdateTime": 0,

                    "id": "6aae904df9284bef823921fac05fb247",

                    "createBy": "1",

                    "shared": false,

                    "publishStatus": 1,

                    "editable": true,

                    "publicLink": {

                        "shared": false,

                        "passProtected": false,

                        "deadline": 0

                    },

                    "parentId": "5540f238907b472bbedd7595e0260614",

                    "position": "我的分析/行业应用/地产建筑/地产公司数据监控",

                    "coopAnalysis": false,

                    "creatorAuth": true

                },

                {

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

                    "initTime": 1533289033311,

                    "lastUpdateTime": 0,

                    "id": "e9bf9ea3f0de40d08281ebc9753f4942",

                    "createBy": "1",

                    "shared": false,

                    "publishStatus": 1,

                    "editable": true,

                    "publicLink": {

                        "shared": false,

                        "passProtected": false,

                        "deadline": 0

                    },

                    "parentId": "5540f238907b472bbedd7595e0260614",

                    "position": "我的分析/行业应用/地产建筑/地产公司数据监控",

                    "coopAnalysis": false,

                    "creatorAuth": true

                }

            ]

        },

        "widgets": {

            "availableWidgets": []

        },

        "customOrder": [

            "6aae904df9284bef823921fac05fb247",

            "e9bf9ea3f0de40d08281ebc9753f4942",

            "88f951b8fba9420987a7a4d1f8b3118e",

            "db95858000e448ea8c376eee7ae9ed64",

            "9de231867ad440768d3416bfe6ead38c"

        ],

        "tableCustomOrder": [],

        "customHide": [],

        "parentId": "bcf238bf6c354346863591f0039d7a88"

    },

    "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.25: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=

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

响应成功

callback({

    "success": true,

    "code": "200",

    "message": "success",

    "data": {

        "index": [

            {

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

                "initTime": 1533632466066,

                "lastUpdateTime": 0,

                "id": "6aae904df9284bef823921fac05fb247",

                "createBy": "1",

                "shared": false,

                "publishStatus": 0,

                "editable": false,

                "publicLink": {

                    "shared": false,

                    "passProtected": false,

                    "deadline": 0

                },

                "coopAnalysis": false,

                "creatorAuth": false

            }

        ]

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

})

截图示意

获取仪表板组件的数据编辑

接口简介



接口作用获取仪表板组件的数据
接口URL/v5/api/dashboard/report/widget/data
请求类型GET

请求参数-Query参数

参数名
参数值是否必填
reportId仪表板ID是
widgetId仪表板中组件ID是

响应实例



请求示例

http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/report/widget/data?reportId=6aae904df9284bef823921fac05fb247&widgetId=b46db5b52d723110&fine_auth_token=xxx

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

响应成功

{

  "success": true,

  "code": "200",

  "message": "success",

  "data": {...13},

  "errorCode": null,

  "detailErrorMsg": null,

  "errorMsg": null

}

截图示意

请求：

响应：

获取仪表板中所有组件信息编辑

接口简介



接口作用获取仪表板中所有组件的信息
接口URL/v5/api/dashboard/report/consanguinity
请求类型GET

请求参数-Query参数

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

响应实例



请求示例

http://172.17.0.25: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": "ffcfdc7d9317448197cfadb1d3d1f227",

                "widgetName": "不同产品销售分布",

                "tables": []

            },

            {

                "widgetId": "cdf2e3759bac4d7f86f935b2f4bc8eef",

                "widgetName": "不同季度销售趋势",

                "tables": []

            },

            {

                "widgetId": "23549d648872405989c88c009ced0d41",

                "widgetName": "未命名组件2",

                "tables": []

            },

            {

                "widgetId": "4c11d91e808d450bb315e4eeea52d761",

                "widgetName": "不同年份房间/合同/标准总价",

                "tables": []

            },

            {

                "widgetId": "121e60da8bd44699b66e0ea7c793c901",

                "widgetName": "项目剩余库存面积",

                "tables": []

            },

            {

                "widgetId": "fac6c24a3ab440f5a40a055eb478efda",

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

                "tables": []

            },

            {

                "widgetId": "9717dba9f23b4bdd839b2522f6209342",

                "widgetName": "销售明细",

                "tables": []

            },

            {

                "widgetId": "d86364e75b6e447c9b7c327407fa6bb2",

                "widgetName": "项目总数",

                "tables": []

            },

            {

                "widgetId": "0e8fe0d307d847129528f708b925f6e2",

                "widgetName": "省份销售分布",

                "tables": []

            },

            {

                "widgetId": "36417a1ac5184b7f94b982ac78aecd11",

                "widgetName": "不同合同类型分布",

                "tables": []

            },

            {

                "widgetId": "fc1221d2d7484b5da4d107b489a84846",

                "widgetName": "项目销售面积分布",

                "tables": []

            },

            {

                "widgetId": "dadd44db04fd4872bdf701a1a8b636ed",

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

                "tables": []

            }

        ]

    },

    "errorCode": null,

    "detailErrorMsg": null,

    "errorMsg": null

}

截图示意