历史版本10 :URL参数总结 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1.描述编辑

FineBI的URL很多时候后面可加入参数以实现不同的效果,下面我们就对这些不同的后缀参数实现效果进行总结。

2.总结编辑


注意:因为bi中url上面传的是json对像,有些服务器不支持json 的url,所以需要把json类型的url参数值先进行编码encodeURIComponent()

例如:dir={"name":"新建仪表板12","catalog":[]} 需要

encodeURIComponent(JSON.stringify({"name":"新建仪表板12","catalog":[]}))

变成

dir=%7B%22name%22%3A%22%E6%96%B0%E5%BB%BA%E4%BB%AA%E8%A1%A8%E6%9D%BF12%22%2C%22catalog%22%3A%5B%5D%7D


1.登录API:可使用该接口登录BI系统

/login/cross/domain?fine_username=name&fine_password=password&validity=-1&callback=myfunction

localhost:37799/webroot/decision/login/cross/domain?fine_username=name&fine_password=password&validity=-1&callback=myfunction

注意:需要替换username与password为自己的用户名与密码

2.模板管理节点信息:可获取模板管理节点下所有模板相关信息-json格式

/v5/api/dashboard/search?page=1&count=30

localhost:37799/webroot/decision/v5/api/dashboard/search?page=1&count=30

3.模板管理节点信息:可获取模板管理节点下所有模板相关信息-可视化界面

/dashboard/management

localhost:37799/webroot/decision/dashboard/management

4.新建仪表板:可新建一个仪表板,输入新建模板名字

/v5/api/platform/dashboard/reports?dir=xxx

参数说明:dir(创建到的目录结构),实例:dir={"name":"新建仪表板12","catalog":["新建文件夹"]}

localhost:37799/webroot/decision/v5/api/platform/dashboard/reports?dir=xxx

注意:name为仪表板名字,catlog为文件夹名字,根目录:"catalog":[]

5.分享API:可分享模板给其他用户

/v5/api/dashboard/share/user/result?entityId=&userId=

参数说明:entityId是xx模板对应的reportId,传多个的话,用逗号分隔;userId是想要分享给其他用户的用户ID,传多个的话,用逗号分隔

localhost:37799/webroot/decision/v5/api/dashboard/share/user/result?entityId=&userId=

注意:只能分享给某个用户,不能分享给部门或者角色

6.当前目录下的模板列表以及文件夹列表:当前登陆者仪表板的详细数据信息(包括文件夹和模板)-json

/v5/api/platform/dashboard/list?dir=xxx

参数说明:dir(创建到的目录结构),实例:dir={"catalog":["新建文件夹"]}

localhost:37799/webroot/decision/v5/api/platform/dashboard/list?dir=xxx

注意:catlog为文件夹名字,根目录:"catalog":[]

7.当前目录下的模板列表以及文件夹列表:当前登陆者仪表板的详细数据信息(包括文件夹和模板)-可视化界面

/webroot/decision/dashboard

localhost:37799/webroot/decision/dashboard

8.登陆者用户的详细信息:包括departs、roles、users、reports

/v5/api/dashboard/user/info

localhost:37799/webroot/decision/v5/api/dashboard/user/info

9.模板信息:输入对应创建者的模板 id返回模板相关信息

/v5/api/platform/dashboard/reports/info?info=xxx

参数说明:info(需要查看的模板目录),实例:{"index":[  { "id":"7e6382e9fe5448b38bb0bc3f50913b5d" }] }

localhost:37799/webroot/decision/v5/api/platform/dashboard/reports/info?info=xxx

注意:只需要输入模板id,该模板必须是当前登录用户创建或者有权限查看的模板

10.分享给我的模板信息

/v5/api/dashboard/share

localhost:37799/webroot/decision/v5/api/dashboard/share

11.分享用户信息:获取模板分享给了哪些客户

/v5/api/dashboard/share/user?entityId=

localhost:37799/webroot/decision/v5/api/dashboard/share/user?entityId=

12.全局更新:根据当前业务包的状态选择是全局更新/Check更新/配置更新

/v5/api/conf/update/generate

localhost:37799/webroot/decision/v5/api/conf/update/generate

13.业务包(单表)更新:根据业务包名对业务包中所有的表进行更新,或者根据表转义名进行单表更新。 无论是业务包还是单表的更新,都进行的是业务包表或单表的全量的更新。 在不加表的转义名时候,进行的就是对这个业务包的更新,加了之后,进行的是对这个表的更新

/v5/api/conf/update/pack/table?info=xx

参数说明:info(需要更新的表信息),实例:{"packageName":"业务包","tableName":"表转义名"}

localhost:37799/webroot/decision/v5/api/conf/update/pack/table?info=xx

14.获取(所有或者某个)业务包信息:(1)获取所有的分组的名字,以及对应业务包的名字:返回当前用户有权限的所有的分组的名字,以及对应业务包的名字。(2)获取某个业务包之下所有表的名字(转义之后的名字)以及表id:返回这个业务包之下所有表的名字(转义之后的名字)以及表id

/v5/api/conf/packs/packageId

localhost:37799/webroot/decision/v5/api/conf/packs/packageId

15.数据准备界面

/v5/api/conf/conf/page

localhost:37799/webroot/decision/v5/api/conf/page