反馈已提交

网络繁忙

您好,只有最新版本的6.X支持在线编辑修改,如果想创建/编辑文档,请移步到 *最新版本*

仪表板分享接口

  • 文档创建者:Carly
  • 历史版本:1
  • 概述

    版本

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

    功能简介

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

    分享仪表板给其他用户

    接口简介



    接口作用通过调用该接口,用户可以将仪表板分享给指定用户
    接口URL/v5/api/dashboard/share/user/result
    请求类型GET

    请求参数-Query参数

    参数名
    参数值是否必填描述说明
    entityId仪表板ID

    多个仪表板,可用「,」隔开

    全部仪表板,值为空即可

    userId用户ID

    多个用户,可用「,」隔开

    全部用户,值为空即可

    响应实例



    请求示例

    http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/share/user/result?entityId=d76fdf3cfb1446aaa450d4668eb18196,b9947708a22e4c58a175019f07e443af&userId=b2e6d799-6a91-4779-aa08-a6d033cefeb5,9ffcfece-80d7-49b2-ac3e-d1f1224bb808&fine_auth_token=xxx

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

    响应成功callback({"data":"success"})
    截图示意

    取消分享仪表板

    接口简介



    接口作用通过调用该接口,用户可以将对某个用户的仪表板分享设置取消掉
    接口URL/v5/api/dashboard/share/user/rejection/result
    请求类型GET

    请求参数-Query参数

    参数名
    参数值是否必填描述说明
    entityId仪表板ID

    多个仪表板,可用「,」隔开

    全部仪表板,值为空即可

    userId用户ID

    多个用户,可用「,」隔开

    全部用户,值为空即可

    响应实例



    请求示例

    http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/share/user/rejection/result?entityId=d76fdf3cfb1446aaa450d4668eb18196,b9947708a22e4c58a175019f07e443af&userId=b2e6d799-6a91-4779-aa08-a6d033cefeb5,9ffcfece-80d7-49b2-ac3e-d1f1224bb808&fine_auth_token=xxx

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

    响应成功

    callback({"data":"success"})

    截图示意

    仪表板分享给哪些用户

    接口简介



    接口作用获取该仪表板分享给了哪些用户
    接口URL/v5/api/dashboard/share/user
    请求类型GET

    请求参数-Query参数

    参数名
    参数值是否必填
    entityId仪表板ID
    page页码
    count每页数量
    keyword关键字
    响应实例


    请求示例

    http://172.17.0.20:37799/webroot/decision/v5/api/dashboard/share/user?entityId=4fc4bc9c2a4a4083b5f4a5d8d632ccae&page=1&count=2&fine_auth_token=xxx

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

    响应成功

    callback({

        "success"true,

        "code""200",

        "message""success",

        "data": [

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

            "52f7f5d9-d3dd-4720-88a5-fafc17a9c650"

        ],

        "errorCode"null,

        "detailErrorMsg"null,

        "errorMsg"null

    })

    截图示意

    分享给我的所有仪表板

    接口简介



    接口作用获取分享给我(当前登录用户)的所有仪表板信息
    接口URL/v5/api/dashboard/share
    请求类型GET

    响应实例



    请求示例

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

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

    响应成功callback({

        "success"true,

        "code""200",

        "message""success",

        "data": [

            {

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

                "folder"false,

                "description"null,

                "pId""e2c8d4b282a64aa0943c9c9162bf2732",

                "id""4fc4bc9c2a4a4083b5f4a5d8d632ccae",

                "reportId""4fc4bc9c2a4a4083b5f4a5d8d632ccae",

                "text""公司综合运营驾驶舱",

                "originType""isShared"

            },

            {

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

                "folder"true,

                "description"null,

                "pId""-2",

                "id""e2c8d4b282a64aa0943c9c9162bf2732",

                "reportId""e2c8d4b282a64aa0943c9c9162bf2732",

                "text""管理驾驶舱",

                "originType""isShared"

            }

        ],

        "errorCode"null,

        "detailErrorMsg"null,

        "errorMsg"null

    })

    截图示意


    附件列表


    主题: 部署集成
    已经是第一篇
    已经是最后一篇
    • 有帮助
    • 没帮助
    • 只是浏览

    售前咨询电话

    400-811-8890转1

    在线技术支持

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

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

    在线QQ(将在2023.01.03关停):800049425

    总裁办24H投诉

    热线电话:173-1278-1526

    文 档反 馈

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

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

    不再提示

    10s后关闭