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

目录:

概述编辑

版本

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

功能简介

本文讲解FineBI中仪表板编辑相关接口。

分享仪表板给其他用户编辑

接口简介



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

请求参数-Query参数

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

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

全部仪表板,值为空即可

userId用户ID

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

全部用户,值为空即可

响应实例



请求示例

http://172.17.0.25: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.25: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.25:37799/webroot/decision/v5/api/dashboard/share/user?entityId=6aae904df9284bef823921fac05fb247&page=1&count=2&fine_auth_token=xxx

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

响应成功

callback({

    "success"true,

    "code""200",

    "message""success",

    "data": [

        "d0fa9ed7-f37c-474a-a157-c4809f4f0c28",

        "1453b447-5dc8-4d9b-a5ac-20f02db3e9dc"

    ],

    "errorCode"null,

    "detailErrorMsg"null,

    "errorMsg"null

})

截图示意

分享给我的所有仪表板编辑

接口简介



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

响应实例



请求示例

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

            "id""73349c2beb6643238321957e4bf32fbe",

            "reportId""73349c2beb6643238321957e4bf32fbe",

            "text""返货品画像看板「已修改」2.0",

            "originType""isShared"

        },

        {

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

            "folder"false,

            "description"null,

            "pId""-2",

            "id""6aae904df9284bef823921fac05fb247",

            "reportId""6aae904df9284bef823921fac05fb247",

            "text""地产公司销售监控",

            "originType""isShared"

        }

    ],

    "errorCode"null,

    "detailErrorMsg"null,

    "errorMsg"null

})

截图示意