第1页 / 共119页
第2页 / 共119页
第3页 / 共119页
第4页 / 共119页
第5页 / 共119页
第6页 / 共119页
第7页 / 共119页
第8页 / 共119页
永洪BI的webAPI文档.pdf
目录
接口环境配置
API各方法说明
权限验证
退出权限
添加用户
添加组
添加角色
修改用户
修改组
修改角色
删除用户
删除组
删除角色
删除所有用户、组、角色
批量导入用户、组、角色
获取用户、组、角色节点信息
获取仪表盘列表
设置权限（覆盖之前的权限设置）
设置权限（不覆盖之前的权限设置）
获取仪表盘基本信息
导出仪表盘中的组件为图片
获得仪表盘中表格、交叉表、图表、自由式表格组件的数据
获得仪表盘中所有组件名称
添加仪表盘文件夹
添加数据集文件夹
删除仪表盘或仪表盘文件夹
删除数据集和数据源的文件以及文件夹
获取所有仪表盘及仪表盘文件夹列表
获取所有数据集及数据集文件夹列表
添加数据源（覆盖之前添加的数据源）
修改仪表盘或仪表盘文件夹的名字
修改数据集或数据集文件夹的名字
运行调度任务和调度任务文件夹
导出仪表盘为文件流
添加sql数据集
获取一个数据集的数据
获取一个sql数据集的sql语句
设置调度任务中发送邮件任务的收件人和抄送人
修改调度任务中发送邮件任务的收件人和抄送人
批量获得仪表盘中表格、交叉表、图表、文本组件的数据
获取用户/角色/组的权限信息
运行调度任务（过期接口）
给用户添加角色（过期接口）
批量修改用户密码（过期接口）
导出仪表盘到指定文件（过期接口）
判断用户是否存在（过期接口）
判断指定仪表盘是否存在（过期接口）
附录
响应消息level描述
数据集类型列表
图表类型
认证授权资源类型
认证授权操作类型
目录
目录
目录................................................................................................................................................................................ I
1. 接口环境配置..........................................................................................................................................................1
2. API 各方法说明.........................................................................................................................................................4
2.1. 权限验证.......................................................................................................................................................4
2.2. 退出权限.......................................................................................................................................................5
2.3. 添加用户.......................................................................................................................................................6
2.4. 添加组...........................................................................................................................................................9
2.5. 添加角色.....................................................................................................................................................11
2.6. 修改用户.....................................................................................................................................................13
2.7. 修改组.........................................................................................................................................................16
2.8. 修改角色.....................................................................................................................................................18
2.9. 删除用户.....................................................................................................................................................20
2.10. 删除组.......................................................................................................................................................22
2.11. 删除角色...................................................................................................................................................23
2.12. 删除所有用户、组、角色...................................................................................................................... 25
2.13. 批量导入用户、组、角色...................................................................................................................... 27
2.14. 获取用户、组、角色节点信息.............................................................................................................. 31
2.15. 获取仪表盘列表.......................................................................................................................................37
2.16. 设置权限（覆盖之前的权限设置）...................................................................................................... 40
2.17. 设置权限（不覆盖之前的权限设置）.................................................................................................. 43
2.18. 获取仪表盘基本信息...............................................................................................................................47
2.19. 导出仪表盘中的组件为图片.................................................................................................................. 49
2.20. 获得仪表盘中表格、交叉表、图表、自由式表格组件的数据..........................................................51
2.21. 获得仪表盘中所有组件名称.................................................................................................................. 55
2.22. 添加仪表盘文件夹...................................................................................................................................57
2.23. 添加数据集文件夹...................................................................................................................................59
2.24. 删除仪表盘或仪表盘文件夹.................................................................................................................. 61
2.25. 删除数据集和数据源的文件以及文件夹.............................................................................................. 63
2.26. 获取所有仪表盘及仪表盘文件夹列表.................................................................................................. 65
2.27. 获取所有数据集及数据集文件夹列表.................................................................................................. 68
2.28. 添加数据源（覆盖之前添加的数据源）.............................................................................................. 70
2.29. 修改仪表盘或仪表盘文件夹的名字...................................................................................................... 73
2.30. 修改数据集或数据集文件夹的名字...................................................................................................... 77
2.31. 运行调度任务和调度任务文件夹.......................................................................................................... 80
2.32. 导出仪表盘为文件流...............................................................................................................................81
2.33. 添加 sql 数据集........................................................................................................................................ 83
2.34. 获取一个数据集的数据...........................................................................................................................85
北京永洪商智科技有限公司
www.yonghongtech.com
I
目录
2.35. 获取一个 sql 数据集的 sql 语句............................................................................................................. 88
2.36. 设置调度任务中发送邮件任务的收件人和抄送人.............................................................................. 89
2.37. 修改调度任务中发送邮件任务的收件人和抄送人.............................................................................. 91
2.38. 批量获得仪表盘中表格、交叉表、图表、文本组件的数据..............................................................93
2.39. 获取用户/角色/组的权限信息............................................................................................................... 96
2.40. 运行调度任务（过期接口）.................................................................................................................. 99
2.41. 给用户添加角色（过期接口）............................................................................................................ 101
2.42. 批量修改用户密码（过期接口）........................................................................................................ 103
2.43. 导出仪表盘到指定文件（过期接口）................................................................................................ 105
2.44. 判断用户是否存在（过期接口）........................................................................................................ 107
2.45. 判断指定仪表盘是否存在（过期接口）............................................................................................ 109
3. 附录......................................................................................................................................................................112
3.1. 响应消息 level 描述.................................................................................................................................112
3.2. 数据集类型列表.......................................................................................................................................112
3.3. 图表类型...................................................................................................................................................112
3.4. 认证授权资源类型...................................................................................................................................113
3.5. 认证授权操作类型...................................................................................................................................114
北京永洪商智科技有限公司
www.yonghongtech.com
II
WebAPI 是基于 servlet 实现，API 所有的方法的调用需要构建 xml 格式的请求内容，post 到这个 servlet，并且返
回 xml 格式的字符串作为响应。想要基于 API 做集成开发需要构建和解析 xml 格式字符串，并通过 http 协议进行
通讯。
接口环境配置
1. 接口环境配置
1. 在永洪产品的安装目录中找到：Yonghong/tomcat/webapps /bi/WEB-INF/web.xml 中添加以下代码：
YonghongWebApi
g5.sv.httpapi.YonghongWebApi
YonghongWebApi
/api
2. 启动产品，将权限设置为文件权限管理系统。即：点击首页，进入管理系统-认证授权-安全管理，选择文件权限
管理系统并点击应用按钮，如下图所示：
3. 在浏览器 url 中输入链接：http://ip:port/bi/api?action=login&adminv=admin&passv=g5，得到登录的
token 值，如下图所示：
北京永洪商智科技有限公司
www.yonghongtech.com
1
接口环境配置
4. 下载浏览器插件 Postman 并安装，安装成功后，Postman 界面如下图所示：
5. 选择 post，输入 url：http://ip:port/bi/api?action=xxxx&token=xxxx；输入参数：xmlData 以及 xmlData
的值，点击 send，即会在界面上有反馈的结果，如下图所示：
北京永洪商智科技有限公司
www.yonghongtech.com
2
接口环境配置
北京永洪商智科技有限公司
www.yonghongtech.com
3
API 各方法说明
2. API 各方法说明
2.1. 权限验证
http://ip:port/bi/api?action=login&adminv=xxxx&passv=xxxx
注意：
请求地址
1) 权限验证返回的 token 代表一个 http session，所以，返回的 token 在一二十分钟
内应该都可以使用，不需要每次调用 API 时都调用这个接口。
2) 最后一定要调用《2.2 退出权限》接口，否则可能会导致短期内出现用户数过多，无
法权限验证的情况。此接口只是用来进行 api 验证用，不能用来进行单点登录。
请求参数 无 xml 请求参数
参数描述 请求参数只在 url 上添加 adminv 和 passv 即可，分别对应要权限验证的用户名和密码。
请求消息
示例
响应消息 响应结果
function login() {
$.post("http://" + ip + ":" + port + "/" + project + "/api?
action=login&adminv=admin&passv=g5",
{},
function(result) {
writeXml(result);
});
}
1) 权限验证成功
1
北京永洪商智科技有限公司
www.yonghongtech.com
4
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
