历史版本3 :定时任务相关接口介绍 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 版本

FineDataLink 版本开放平台-FineDataLink接口插件功能变动
4.0.281.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.png

2)「任务运维>定时任务>任务管理」中,

3)

4)「管理系统>开放平台>API管理」处,新增 FDL 接口。如下图所示:

注:API 管理更多介绍请参见文档:开放平台插件

3.png



2.3 接口管理/认证/权限

详情请参见:开放平台插件 文档

2.4 接口介绍

2.4.1 运行任务


基于任务名,运行任务基于任务ID,运行任务
支持的请求类型POSTPOST
接口请求
  • 通过任务名称或任务ID请求查询

  • 通过接口可传递任务参数(匹配到任务内定义好的参数方可生效)

  • 可选择是否「等待任务运行完成再返回内容」(适用于运行耗时为秒级的任务)

请求参数:

  • 必填】任务名称或任务ID

  • 非必填】任务参数名、参数值 。不填或匹配不上则使用任务内参数值

  • 非必填】等待任务运行完成再返回内容:是、否。 不填则为否,为否时直接返回实例ID或请求的结果,不返回运行结果

接口返回

1)请求发送成功时,返回:

  • 成功状态码

  • 实例ID+实例运行结果(基于请求参数)

实例ID实例运行结果

任务此次运行产生的实例ID

1)成功、失败、中断

2)仅当请求参数等待任务运行完成再返回内容时返回此内容

2)请求失败时,返回失败码及失败原因

接口URL

2.4.2 查询实例的信息


查询任务对应的实例列表基于实例ID查询实例状态
支持的请求类型GETGET
接口请求
  • 通过任务名称或任务ID查询对应的实例

  • 通过设置条件参数的值,筛选出对应的实例

请求参数:

  • 【必填】任务名称或任务ID

  • 【非必填】仅查询最近一次:是、否 ,不填则为否

  • 【非必填】开始时间,不填则为无限

  • 【非必填】结束时间,不填则为无限

  • 【非必填】运行状态:成功、失败、中断、运行中,不填则返回所有

  • 【非必填】触发方式:手动、定时,不填则返回所有

通过实例ID请求查询

请求参数:

  • 【必填】实例ID


接口返回

1)请求发送成功时,返回:

  • 成功状态码

  • 实例ID列表

无查询结果时返回空值

2)请求失败时,返回失败码及失败原因

1)请求发送成功时,返回:

  • 成功状态码

  • 实例信息

返回内容:

  • 实例对应的任务名

  • 实例对应的任务ID

  • 实例对应的任务目录

  • 实例运行状态:成功、失败、中断、运行中

  • 实例运行开始时间

  • 实例运行结束时间

  • 实例运行的耗时

  • 实例的触发方式

  • 实例的触发人

2)请求失败时,返回失败码及失败原因

接口URL

2.4.3 终止实例


基于任务名或任务ID终止运行中的实例基于实例ID终止运行中的实例
支持的请求类型

POST


接口请求通过通过任务名称或任务ID发起请求

请求参数:

【必填】任务名称或任务ID

通过实例ID发起请求(支持操作多个实例)

请求参数:

【必填】实例ID(单值或多值)

接口返回
  • 请求成功时,返回接口请求的状态,不返回内容

  • 请求失败时,返回失败状态码及失败原因

  • 请求成功时,返回成功状态码,不返回其他内容

  • 请求失败时,返回失败状态码及失败原因

接口URL