1. 概述编辑
1.1 版本
FineDataLink 版本 | 开放平台-FineDataLink接口插件 | 功能变动 |
---|---|---|
4.0.28 | 1.0.1 |
1.2 应用场景
用户希望能够按需触发\执行定时任务,以提高数据时效性,场景如下所示:
业务人员在 FR 填报页面录入数据后,数据需要经 FDL 的定时任务计算形成结果数据,期望能够及时看到最新的数据。
业务人员期望能够在报表上看到实时的数据,或者有个按钮能够触发数据更新。
企业自建或采购的业务系统,期望能够在某些动作完成后触发定时任务执行,使数据的更新时效性更高。
业务人员在简道云录入数据后,数据需要经 FDL 的定时任务做同步或处理,期望能够及时看到最新的数据。
1.3 功能简介
使用「开放平台-FineDataLink接口」插件,可提供 FineDataLink 相关接口,满足用户按需触发\执行定时任务的需求。
2. 插件介绍编辑
2.1 安装插件
1)用户需要先注册 功能点,才能正常使用该插件。
2)需要先安装「开放平台」插件,再安装「开放平台-FineDataLink接口」插件。
注:FineReport11.0 中已内置「开放平台」插件,只需安装「开放平台-FineDataLink接口」插件即可。
点击下载插件:开放平台插件、
安装插件方法请参见:服务器插件管理
2.2 安装成功后界面介绍
1)插件安装成功后,「数据开发」处展示的定时任务新增「任务ID」信息,且支持复制。如下图所示:
2)「任务运维>定时任务>任务管理」中,
3)
4)「管理系统>开放平台>API管理」处,新增 FDL 接口。如下图所示:
注:API 管理更多介绍请参见文档:开放平台插件
2.3 接口管理/认证/权限
详情请参见:开放平台插件 文档
2.4 接口介绍
2.4.1 运行任务
基于任务名,运行任务 | 基于任务ID,运行任务 | |||||
---|---|---|---|---|---|---|
支持的请求类型 | POST | POST | ||||
接口请求 |
请求参数:
| |||||
接口返回 | 1)请求发送成功时,返回:
2)请求失败时,返回失败码及失败原因 | |||||
接口URL |
2.4.2 查询实例的信息
查询任务对应的实例列表 | 基于实例ID查询实例状态 | |
---|---|---|
支持的请求类型 | GET | GET |
接口请求 |
请求参数:
| 通过实例ID请求查询 请求参数:
|
接口返回 | 1)请求发送成功时,返回:
无查询结果时返回空值 2)请求失败时,返回失败码及失败原因 | 1)请求发送成功时,返回:
返回内容:
2)请求失败时,返回失败码及失败原因 |
接口URL |
2.4.3 终止实例
基于任务名或任务ID终止运行中的实例 | 基于实例ID终止运行中的实例 | |
---|---|---|