历史版本2 :调用定时任务相关接口说明 返回文檔
編輯時間: 內容長度:图片数:目录数: 修改原因:

目錄:

1. 概述编辑

开放平台-FineDataLink接口插件 文档中，介绍了定时任务的调用接口，本文介绍如何调用这些接口。

2. FineReport 中调用定时任务接口编辑

分类
接口定义FineReport 中 JS API
运行任务基于任务名，运行任务FR.ExecuteWorkByWorkName
基于任务ID，运行任务FR.ExecuteWorkByWorkId
查询实例查询任务名，查询对应的实例列表FR.GetWorkRecordsByWorkName
查询任务ID，查询对应的实例列表FR.GetWorkRecordsByWorkId
基于实例ID，查询实例信息FR.GetRecordInfoByRecordId
终止实例基于任务名，终止运行中的实例FR.TerminateWorkByWorkName
基于任务ID，终止运行中的实例FR.TerminateWorkByWorkId
基于实例ID，终止运行中的实例FR.TerminateWorkByRecordId

2.1 FR与FDL独立部署

FR 与 FDL 独立部署时，调用定时任务接口的 JS 示例说明如下：

注：客户实际使用时，可参考下方JS示例，但需要根据实际情况修改。

2.1.1 根据任务ID查询实例列表

FR.GetWorkRecordsByWorkId(
    {
        workId: "e10f1f1a-d567-4058-98bb-b71204154f8b",
        latest: false,
        startTime: "",
        finishTime: "",
        taskStatus: "SUCCESS",
        triggerMethod: "MANUAL",
    },
    function (error, response) {
        if (error) {
            console.error("请求失败：" + error);
        } else {
            console.log("请求成功，响应数据：" + JSON.stringify(response));
        }
    }
);

2.1.2 根据任务名查询实例列表

FR.GetWorkRecordsByWorkName(
    {
        workName: "01数据同步",
        latest: true,
        startTime: "",
        finishTime: "",
        taskStatus: "SUCCESS",
        triggerMethod: "FIX_TIME",
    },
    function (error, response) {
        if (error) {
            console.error("请求失败：" + error);
        } else {
            console.log("请求成功，响应数据：" + JSON.stringify(response));
        }
    }
);

2.1.3 根据实例ID查询实例信息

FR.GetRecordInfoByRecordId(
    "3c73b3a0-30ba-4044-984e-6b61e5c3b638",
    function (error, response) {
        if (error) {
            console.error("请求失败：" + error);
        } else {
            console.log("请求成功，响应数据：" + JSON.stringify(response));
        }
    }
);

2.1.4 基于任务ID运行任务

FR.ExecuteWorkByWorkId(
    {
        workId: "e10f1f1a-d567-4058-98bb-b71204154f8b",
        params: {
            paramName: "paramValue",
        },
        waitForResponse: "true",
        waitTime: 10000,
    },
    function (error, response) {
        if (error) {
            console.error("请求失败：" + error);
        } else {
            console.log("请求成功，响应数据：" + JSON.stringify(response));
        }
    }
);

2.1.5 基于任务名运行任务

FR.ExecuteWorkByWorkName(
    {
        workName: "01数据同步",
        params: {
            paramName: "paramValue",
        },
        waitForResponse: "true",
        waitTime: 5000,
    },
    function (error, response) {
        if (error) {
            console.error("请求失败：" + error);
        } else {
            console.log("请求成功，响应数据：" + JSON.stringify(response));
        }
    }
);

2.1.6 基于任务ID终止运行中实例

FR.TerminateWorkByWorkId(
    "e10f1f1a-d567-4058-98bb-b71204154f8b",
    function (error, response) {
        if (error) {
            console.error("请求失败：" + error);
        } else {
            console.log("请求成功，响应数据：" + JSON.stringify(response));
        }
    }
);

2.1.7 基于任务名终止运行中实例

FR.TerminateWorkByWorkName("01数据同步", function (error, response) {
    if (error) {
        console.error("请求失败：" + error);
    } else {
        console.log("请求成功，响应数据：" + JSON.stringify(response));
    }
});

2.1.8 基于实例ID终止运行中实例

FR.TerminateWorkByRecordId(
    {
        executeIds: ["3c73b3a0-30ba-4044-984e-6b61e5c3b638"],
    },
    function (error, response) {
        if (error) {
            console.error("请求失败：" + error);
        } else {
            console.log("请求成功，响应数据：" + JSON.stringify(response));
        }
    }
);

2.2 FD 与 FDL 集成部署