定時任務相關API介紹

本文介紹 FineDataLink 提供的可被簡道雲、FR、外部系統呼叫的定時任務相關API。

注1：API呼叫說明請參見：呼叫定時任務相關API說明；FR中呼叫API範例請參見：FR範本呼叫定時任務API範例

注2：本文API適用於 4.0.29 及以上版本。

注1：實體ID即為運作記錄ID，運作記錄ID在「任務維運>定時任務>運作記錄」中查看。

注2：所有API呼叫時，都需要進行API認證的，否則會提示鑑權失敗；本文API範例認證使用的是「開放平台認證模式」，API認證方式請參見：API認證模式說明

注3：只有定時任務「發佈模式」下運作的任務支援API運作和終止任務。

2.1 根據任務ID查詢實體列表

基本資訊：

API URL：http://localhost:8080/webroot/decision/sp/client/api/fdl/workId/records

注：http://localhost:8080/webroot/decision需要根據使用者實際情況修改為對應的 FineDataLink 地址。

Content-Type：application/json

請求類型：POST

請求參數：

1）Params 請求參數

2）body 請求參數：

請求類型：raw_json

{
"workId": "e10f1f1a-d567-4058-98bb-b71204154f8b", 
"latest": false, //【非必填】僅查詢最近一次：是、否  /*不填則為否*/
"startTime": "", //【非必填】開始時間  /*不填則為無限*/
"finishTime": "", //【非必填】結束時間  /*不填則為無限*/
"taskStatus": "SUCCESS", //【非必填】運作狀態  /*不填則傳回所有*/ 
"triggerMethod": "MANUAL" //【非必填】觸發方式：手動、定時  
}

回應範例：

成功

{
	"status": 200,
	"data": {
		"executeIds": [
			"7d5a4b14-f0de-47b8-91ad-a8777b76236c",
			"0d20a589-e66f-4b47-8256-e40e0252eea2",
			"24c6d78a-2d4f-40b5-b9fb-08eef1133612",
			"9fa0d375-89f4-425f-8e39-0c6de623637a",
		]
	}
}

2.2 根據任務名查詢實體列表

基本資訊：

API URL：http://localhost:8080/webroot/decision/sp/client/api/fdl/workName/records

注：http://localhost:8080/webroot/decision需要根據使用者實際情況修改為對應的 FineDataLink 地址。

Content-Type：application/json

請求類型：POST

請求參數：

1）Params 請求參數

2）body請求參數：

請求類型：raw_json

{
"workName": "fdlDemo", //【必填】任務名稱
"latest": true, //【非必填】僅查詢最近一次：是、否  /*不填則為否*/
"startTime": "", //【非必填】開始時間  /*不填則為無限*/
"finishTime": "", //【非必填】結束時間  /*不填則為無限*/
"taskStatus": "SUCCESS", //【非必填】運作狀態
"triggerMethod": "FIX_TIME" //【非必填】觸發方式：手動、定時  /*不填則傳回所有*/ 
}

回應範例：

1）成功

注：無查詢結果時傳回空值。

{
	"status": 200,
	"data": {
		"executeIds": [
			"40fc80c6-ac03-4943-b6d7-e79ff5cca581"
		]
	}
}

2）失敗

{
	"status": 200,
	"errorCode": "E8130031",
	"errorMsg": "任務不存在，無法獲取檔案"
}

2.3 根據實體ID查詢實體資訊

基本資訊：

API URL：http://localhost:8080/webroot/decision/sp/client/api/fdl/record/info?recordId=

注：http://localhost:8080/webroot/decision需要根據使用者實際情況修改為對應的 FineDataLink 地址。

請求類型：GET

請求參數：

Query 請求參數：

回應範例：

1）成功：

{
"status": 200, //【非必填】運作狀態 /*不填則傳回所有*/
"data": {
"recordId": "16f7f568-767f-4786-bb2c-5dbc64cfbcad", //實體ID
"taskId": "868478d9-a36d-481f-b42d-6074310c2829", //任務ID
"taskName": "fdlDemo", //任務名稱
"taskPath": "任務列表/一級目錄/fdlDemo", //任務目錄
"status": "INTERRUPT", //實體運作狀態
"startTime": 1690786927020, //實體運作開始時間
"finishTime": 1690786944299, //實體運作結束時間
"triggerMethod": "MANUAL", //實體觸發方式
"triggerBy": "root" //實體觸發人
}
}
顯示程式碼

2）失敗

{
"status": 200,
"errorCode": "E8130012",
"errorMsg": "can not find record by recordId"
}

3）無權限

{
"status": 200,
"errorCode": "E8130011",
"errorMsg": "使用者沒有權限"
}

2.4 基於任務ID運作任務

基本資訊：

API URL：http://localhost:8080/webroot/decision/sp/client/api/fdl/workId/execute

注：http://localhost:8080/webroot/decision需要根據使用者實際情況修改為對應的 FineDataLink 地址。

Content-Type：application/json

請求類型：POST

請求參數：

1）Params 請求參數

2）body請求參數：

請求類型：raw_json

注：該API不支援同時呼叫多個定時任務的執行。

{
    "workId": "e10f1f1a-d567-4058-98bb-b71204154f8b",
    "params": {
        "paramName": "paramValue"
    },
    "waitForResponse": false,
    "triggerDownstream":true,
    "waitTime": 10000
}

若 Body 內非必填欄位為空，Body 格式為：

{
    "workId": "e10f1f1a-d567-4058-98bb-b71204154f8b",
    "params": {}
}

回應範例：

1）成功

{
"status": 200,
"data": {
"recordId": "70aa0661-c626-4c55-bbba-e392624945fa", //運作實體ID
"status": "SUCCESS" //運作實體狀態
}
}

2）失敗

{
"status": 200,
"errorCode": "E8130051",
"errorMsg": "任務不存在，無法獲取檔案"
}

3）必填為空

{
"status": 200,
"errorCode": "E8130052",
"errorMsg": "workId can not be null!"
}

4）沒有權限操作

{
"status": 200,
"errorCode": "E8130059",
"errorMsg": "使用者沒有權限"
}

2.5 基於任務名運作任務

基本資訊：

API URL：http://localhost:8080/webroot/decision/sp/client/api/fdl/workName/execute

注：http://localhost:8080/webroot/decision需要根據使用者實際情況修改為對應的 FineDataLink 地址。

Content-Type：application/json

請求類型：POST

請求參數：

1）Params 請求參數

2）body請求參數：

請求類型：raw_json

{
"workName": "fdlDemo", //【必填】任務名稱
"params": {
"paramName": "paramValue" //【非必填】執行參數，若無則空即可
}, //【非必填】執行參數
"waitForResponse": "true", //【非必填】等待任務運作完成再傳回內容
"triggerDownstream":true,//【非必填】是否運作下游任務
"waitTime": 10000 
}

若 Body 內非必填欄位為空，Body 格式為：

{
"workName": "列欄轉換",
"params": {
"paramName": ""
}
}

回應範例：

1）成功

{
"status": 200, 
"data": {
"recordId": "e14169b9-328c-4b62-8a75-abc546f61d38", 
"status": "SUCCESS" 
} 
}

2）失敗

{
"status": 200, 
"errorCode": "E8130061", 
"errorMsg": "任務不存在，無法獲取檔案" 
}

3）必填為空

{
"status": 200,
"errorCode": "E8130061",
"errorMsg": "workName can not be null!"
}

4）沒有權限操作

{
	"status": 200,
	"errorCode": "E8130069",
	"errorMsg": "使用者沒有權限"
}

2.6 基於任務ID終止運作中實體

• 不會檢查實體是否處於運作狀態，因此終止實體，會把等待運作的實體也終止掉。

• 請求成功不代表終止成功，終止有一定的延遲。

基本資訊：

API URL：http://localhost:8080/webroot/decision/sp/client/api/fdl/workId/terminate?workId=e10f1f1a-d567-4058-98bb-b71204154f8b

注：http://localhost:8080/webroot/decision需要根據使用者實際情況修改為對應的 FineDataLink 地址。

請求類型：POST

請求參數：

1）Params 請求參數

2）Query 請求參數：

回應範例：

成功

{
"code": "200",
"message": "success"
}

2.7 基於任務名終止運作中實體

• 不會檢查實體是否處於運作狀態，因此終止實體，會把等待運作的實體也終止掉。

• 請求成功不代表終止成功，終止有一定的延遲。

基本資訊：

API URL：http://localhost:8080/webroot/decision/sp/client/api/fdl/workName/terminate?workName=01資料同步

注：http://localhost:8080/webroot/decision需要根據使用者實際情況修改為對應的 FineDataLink 地址。

請求類型：POST

請求參數：

1）Params 請求參數

2）Query 請求參數：

回應範例：

1）成功

{
"code": "200",
"data": "success"
}

2）失敗

{
"status": 200, 
"errorCode": "E8130089", 
"errorMsg": "任務不存在，無法獲取檔案" 
}

2.8 基於實體ID終止運作中實體

• 不會檢查實體是否處於運作狀態，因此終止實體，會把等待運作的實體也終止掉。

• 請求成功不代表終止成功，終止有一定的延遲。

基本資訊：

API URL：http://localhost:8080/webroot/decision/sp/client/api/fdl/records/terminate

注：http://localhost:8080/webroot/decision需要根據使用者實際情況修改為對應的 FineDataLink 地址。

Content-Type：application/json

請求類型：POST

請求參數：

1）Params 請求參數

2）Body 請求參數：

{
"executeIds": [
"16f7f568-767f-4786-bb2c-5dbc64cfbcad222"
] //【必填】運作實體ID
}

回應範例：

1）成功

{
"status": 200,
"data": "success"
}

2）失敗

{
	"status": 200,
	"errorCode": "E8130042",
	"errorMsg": "executeIds can not be null!"
}