帆软社区
首页 服务平台 文档 学院 问答 论坛 认证 招聘 任务 市场

反馈已提交

网络繁忙

您正在浏览的是 FineBI7.X 帮助文档，点击跳转至： FineBI6.X帮助文档

仪表板编辑接口

  • 文档创建者：Carly
  • 历史版本：7
  • 最近更新：Carly 于 2026-01-08

    • 概述

    版本

    FineBI服务器版本
    		功能变更
    7.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：仪表板名称

    响应实例



    请求示例

    编码前参数值：

    {"subjectId":"44cec6b1637c4cb79333410507a50bd5","reportName":"示例仪表板"}

    编码后参数值：

    %7B%22subjectId%22:%2244cec6b1637c4cb79333410507a50bd5%22,%22reportName%22:%22%E7%A4%BA%E4%BE%8B%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%7D

    链接：

    http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/reports?data=%7B%22subjectId%22:%2244cec6b1637c4cb79333410507a50bd5%22,%22reportName%22:%22%E7%A4%BA%E4%BE%8B%E4%BB%AA%E8%A1%A8%E6%9D%BF%22%7D

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

    • 正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录

    • 测试阶段可通过「Authorization>Bearer Token」输入 token 值

    响应成功

    callback({

        "success": true,

        "code": "200",

        "message": "success",

        "data": {

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

            "initTime": 0,

            "lastUpdateTime": 0,

            "id": "d46d49e0c80f474d9f744e23b5b5c44b",

            "shared": false,

            "publishStatus": 0,

            "editable": true,

            "publicLink": {

                "type": 0,

                "shared": false,

                "passProtected": false,

                "deadline": 0,

                "exportable": false

            },

            "coopAnalysis": false,

            "creatorAuth": false

        },

        "errorCode": null,

        "detailErrorMsg": null,

        "errorMsg": null

    })

    截图示意
    		2026-01-07_11-48-04.png

    响应参数说明

    参数
    		参数值说明
    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://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/report?reportId=d46d49e0c80f474d9f744e23b5b5c44b

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

    • 正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录

    • 测试阶段可通过「Authorization>Bearer Token」输入 token 值

    响应成功

    callback({

        "success": true,

        "code": "200",

        "message": "success",

        "data": [],

        "errorCode": null,

        "detailErrorMsg": null,

        "errorMsg": null

    })

    截图示意2026-01-07_13-39-46.png

    重命名仪表板

    接口简介



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

    响应实例



    请求示例

    编码前参数值：

    {"reportId":"274aee6161f54f8eaf38ae3414917ab0","nameUpdateBean":{"name": "新手入门示例","mouduleType": "2"}}

    编码后参数值：

    %7B%22reportId%22:%22274aee6161f54f8eaf38ae3414917ab0%22,%22nameUpdateBean%22:%7B%22name%22:%20%22%E6%96%B0%E6%89%8B%E5%85%A5%E9%97%A8%E7%A4%BA%E4%BE%8B%22,%22mouduleType%22:%20%222%22%7D%7D

    链接：

    http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/rename?info=%7B%22reportId%22:%22274aee6161f54f8eaf38ae3414917ab0%22,%22nameUpdateBean%22:%7B%22name%22:%20%22%E6%96%B0%E6%89%8B%E5%85%A5%E9%97%A8%E7%A4%BA%E4%BE%8B%22,%22mouduleType%22:%20%222%22%7D%7D

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

    • 正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录

    • 测试阶段可通过「Authorization>Bearer Token」输入 token 值

    响应成功

    callback({

        "success": true,

        "code": "200",

        "message": "success",

        "data": [],

        "errorCode": null,

        "detailErrorMsg": null,

        "errorMsg": null

    })

    截图示意2026-01-07_13-46-19.png

    仪表板另存为

    接口简介



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

    请求参数-body参数

    参数是否必填描述说明

    {

        "subjectId":"主题ID",

        "originReportId":"仪表板ID",

        "name": "新仪表板名称"

    }

    		是

    1）subjectId：仪表板需要复制到的主题ID

    2）originReportId：待复制的仪表板ID

    3）name：新仪表板的名称

    响应实例



    请求链接

    http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/saveas

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

    • 正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录

    • 测试阶段可通过「Authorization>Bearer Token」输入 token 值

    请求body

    {

        "subjectId":"44cec6b1637c4cb79333410507a50bd5",

        "originReportId":"274aee6161f54f8eaf38ae3414917ab0",

        "name": "新仪表板"

    }

    响应成功

    callback({

        "success": true,

        "code": "200",

        "message": "success",

        "data": {

            "name": "新仪表板",

            "initTime": 0,

            "lastUpdateTime": 0,

            "id": "050cfdce42f2488eaa3f8f2733bbca36",

            "shared": false,

            "publishStatus": 0,

            "editable": true,

            "publicLink": {

                "type": 0,

                "shared": false,

                "passProtected": false,

                "deadline": 0,

                "exportable": false

            },

            "coopAnalysis": false,

            "creatorAuth": false

        },

        "errorCode": null,

        "detailErrorMsg": null,

        "errorMsg": null

    })

    截图示意2026-01-07_13-59-38.png

    创建公共链接

    接口简介



    接口作用创建仪表板的公共链接
    接口URL/v5/api/platform/dashboard/{reportId}/create
    请求类型GET
    注意事项reportID为仪表板ID

    响应实例



    请求示例

    http://192.168.101.92:8883/webroot/decision/v5/api/platform/dashboard/7b489909260045cb8de75f0084156e26/create?userId=b5f0c2ee-640f-4039-a4d4-918b55354898

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

    • 正式工程推荐配置单点登录，否则嵌入式集成后，需要反复登录

    • 测试阶段可通过「Authorization>Bearer Token」输入 token 值

    响应成功

    callback({

        "success": true,

        "code": "200",

        "message": "success",

        "data": {

            "type": 0,

            "shared": true,

            "uri": "eyJhbGciOiJIUzI1NiJ9.eyJyZXBvcnRJZCI6IjdiNDg5OTA5MjYwMDQ1Y2I4ZGU3NWYwMDg0MTU2ZTI2IiwidXNlcklkIjoiNjIxYmViODQtNTliNy00MTJjLWIyZjMtNzhhN2I3YWVhYjFhIiwianRpIjoiand0In0.nScnomL8fK_Pu2ofFTFHzCjFAH_kU7tI6_BFCgVtAqs",

            "resourceId": "7b489909260045cb8de75f0084156e26",

            "linkId": "SC5S",

            "userId": "621beb84-59b7-412c-b2f3-78a7b7aeab1a",

            "passProtected": false,

            "deadline": 0,

            "subResource": [],

            "exportable": false

        },

        "errorCode": null,

        "detailErrorMsg": null,

        "errorMsg": null

    })

    截图示意2026-01-07_14-29-23.png

    附件列表


    主题： 部署集成
    上一篇：数据目录文件夹接口
    下一篇：仪表板查看接口
    • 有帮助
    • 没帮助
    • 只是浏览
    中文（繁體） English 日本語
    中文（简体）

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

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

    不再提示

    10s后关闭

    文
    档
    AI
    助
    手
    联系我们
    在线支持
    获取专业技术支持，快速帮助您解决问题
    工作日9:00-12:00，13:30-17:30在线
    页面反馈
    针对当前网页的建议、问题反馈
    售前咨询
    采购需求/获取报价/预约演示
    或拨打: 400-811-8890 转1
    qr
    热线电话
    咨询/故障救援热线：400-811-8890转2
    总裁办24H投诉：17312781526
    提交页面反馈
    仅适用于当前网页的意见收集，帆软产品问题请在 问答板块提问 或 前往服务平台 获取技术支持