1. 概述编辑
1.1 版本
FineDataLink 版本 | 开放平台-FineDataLink接口插件 | 功能变动 |
---|---|---|
4.0.28 | 1.0.1 |
1.2 应用场景
用户希望能够按需触发\执行定时任务,以提高数据时效性,场景如下所示:
业务人员在 FR 填报页面录入数据后,数据需要经 FDL 的定时任务计算形成结果数据,期望能够及时看到最新的数据。
业务人员期望能够在报表上看到实时的数据,或者有个按钮能够触发数据更新。
企业自建或采购的业务系统,期望能够在某些动作完成后触发定时任务执行,使数据的更新时效性更高。
业务人员在简道云录入数据后,数据需要经 FDL 的定时任务做同步或处理,期望能够及时看到最新的数据。
1.3 功能简介
使用「开放平台-FineDataLink接口」插件,可提供 FineDataLink 相关接口,满足用户按需触发\执行定时任务的需求。
2. 插件介绍编辑
注:API 管理更多介绍请参见文档:开放平台插件
2.1 安装插件
1)用户需要先注册 功能点,才能正常使用该插件。
2)需要先安装「开放平台」插件,再安装「开放平台-FineDataLink接口」插件。
注:FineReport11.0 中已内置「开放平台」插件,只需安装「开放平台-FineDataLink接口」插件即可。
点击下载插件:开放平台插件、
安装插件方法请参见:服务器插件管理
2.2 安装成功后界面介绍
1)插件安装成功后,「数据开发」处展示的定时任务新增「任务ID」信息,且支持复制。如下图所示:
2.3 接口认证模式说明
2.3.1 开放平台认证模式
若采用开放平台提供的 cliend_id 和 secret 的方式认证,默认为超管用户。详情请参见:开放平台插件
1)接口认证逻辑由「开放平台>应用」管控,可参见 开放平台插件 认证方式介绍。例如选择 aksk 认证模式,在接口请求时需传递 clientld 和 secret 参数。
2)通过开放平台认证后,接口的操作用户默认为超管用户。
3)当需要修改操作用户时,可在 header 或 query 中添加 decUser 参数,参数值为用户名或用户id。
2.3.2 fine_auth_token 认证模式
若采用和平台一样的 fine_oauth_token 的认证方式,采用的就是生成 token 的用户去操作。详情请参见:开放平台子插件
1)在请求地址中添加上module/路径时(例如,原始为 /sp/client/api/*,添加后变为/sp/client/api/module/*),接口认证逻辑不再由「开放平台>应用」来管控,而是需要携带帆软平台的认证登录标识 fine_oauth_token,未携带或携带无效 token 时接口认证失败。
2)token 携带方式:和产品用户 token 传递方式一致。
3)该认证模式下,接口操作用户为 fine_oauth_token 中映射的用户,无法通过 decUser 参数修改。
3. 接口介绍编辑
3.1 根据任务ID查询实例列表
基本信息:
接口URL:http://localhost:8080/webroot/decision/sp/client/api/fdl/work/{workId}/records
Content-Type:application/json
认证方式:无需认证
请求类型:POST
请求参数:
路径参数及说明:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
workId | 868478d9-a36d-481f-b42d-6074310c2829222 | 是 | String | 【必填】任务ID |
body请求参数:
{
"latest": false,
"startTime": "",
"finishTime": "",
"taskStatus": "SUCCESS",
"triggerMethod": "MANUAL"
}