永洪BI WebAPI详尽操作指南:配置与接口管理

需积分: 0 35 下载量 68 浏览量 更新于2024-07-18 1 收藏 1.02MB PDF 举报
永洪BI的Web API文档提供了全面的接口操作指南,帮助用户在企业级数据分析和报表管理中实现自动化和高效管理。该文档详细介绍了如何配置接口环境,以便与其他系统进行集成,包括设置权限验证、用户和组管理、角色分配、数据集操作、仪表盘管理、调度任务执行、以及与邮件系统的交互。 1. 接口环境配置:文档首先介绍了如何配置接口环境,确保正确连接到永洪BI的服务器,可能涉及API密钥、URL、端口等参数设置。 2. 权限管理:关键部分包括权限验证,通过API调用来检查用户身份和授权;退出权限功能则允许管理员撤销用户的访问权限。此外,还有用户、组和角色的创建、修改、删除以及批量导入功能。 3. 数据对象操作:涵盖了添加和管理数据集文件夹,以及获取和导出数据集和仪表盘中的数据,包括不同类型的组件数据获取和导出。 4. 仪表盘管理:从创建、重命名到删除,以及文件夹的增删操作,还有导出为文件流的功能。获取仪表盘的基本信息、导出为图片,以及获取组件的详细名称,都包含在内。 5. 调度任务:支持运行和管理定时任务,包括发送邮件通知,即使在任务完成之后也可以修改收件人和抄送人。 6. 特定功能接口:如获取SQL数据集的SQL语句、设置邮件任务属性,以及获取用户权限信息。然而,部分接口如运行过期任务、修改用户密码等已被标记为过期,可能需要更新到最新版本以保持兼容性。 通过这份文档,开发者可以方便地通过Web API与永洪BI系统交互,提高数据处理的灵活性和效率,同时了解哪些功能可能需要根据系统的最新版本进行调整。在实际应用中,确保遵循文档中的步骤,并关注更新日志,以保持最佳的集成效果。