GET Просмотр списка запланированных задач#
Основная информация#
Статус интерфейса: Опубликован
URL интерфейса: GET {{API_PATH_V3}}/schedule?page=1&perPage=2
Content-Type: application/json
Способ аутентификации: Аутентификация не требуется
Передаваемые параметры#
Параметры запроса.
Возвращаемые параметры (json + таблица)#
Success (200)#
json
{
"status": 200,
"data": {
"hasNext": true,
"totalCount": 4,
"items": [
{
"id": "13ecb239-1d53-48fa-ad63-f8e7ae4677be",
"taskName": "task",
"taskDescription": "- -",
"templatePath": "- -",
"repeatTime": 0,
"repeatTimes": 0,
"showType": 0,
"taskType": 0,
"taskCondition": {
"type": 0,
"description": "",
"detail": "Dec-Task_Run_Always"
},
"fileClearCount": 1,
"nextFireTime": null,
"preFireTime": "2023-06-05 15:12:15",
"triggerGroup": {
"triggers": [
{
"triggerType": "1",
"startTime": null,
"endTime": null,
"startType": 1,
"endType": 1
}
]
},
"userGroup": {
"userType": "1",
"departmentAndPost": [],
"customRole": [],
"departmentStr": "",
"customRoleStr": "",
"platformUser": [
"root(root)"
],
"platformUserStr": "root(root)"
},
"creator": "root",
"editable": false,
"backupFilePath": "",
"sendBackupFile": false,
"scheduleOutput": {
"id": "04d19a46-b51c-403c-a26c-985356200932",
"baseName": "",
"formats": [],
"createAttachByUsername": false,
"outputActionList": [],
"baseNameMap": {},
"formatsMap": {}
},
"taskState": {
"value": 2
},
"taskParameter": {
"param": []
},
"outputStr": "",
"conditionParameter": {
"param": []
},
"labels": null,
"originTaskId": "",
"scheduleTaskExtend": null,
"hosts": []
},
{
"id": "2ffd26c7-6ee1-4e07-b940-adf0ca62667f",
"taskName": "test",
"taskDescription": "- -",
"templatePath": "- -",
"repeatTime": 0,
"repeatTimes": 0,
"showType": 0,
"taskType": 0,
"taskCondition": {
"type": 0,
"description": "",
"detail": "Dec-Task_Run_Always"
},
"fileClearCount": 1,
"nextFireTime": null,
"preFireTime": "2023-05-14 21:47:45",
"triggerGroup": {
"triggers": [
{
"triggerType": "1",
"startTime": null,
"endTime": null,
"startType": 1,
"endType": 1
}
]
},
"userGroup": {
"userType": "1",
"departmentAndPost": [],
"customRole": [],
"departmentStr": "",
"customRoleStr": "",
"platformUser": [
"root(root)"
],
"platformUserStr": "root(root)"
},
"creator": "root",
"editable": false,
"backupFilePath": "",
"sendBackupFile": false,
"scheduleOutput": {
"id": "88a16ed8-9fa9-4848-b35f-4d759d82ac9f",
"baseName": "",
"formats": [],
"createAttachByUsername": false,
"outputActionList": [],
"baseNameMap": {},
"formatsMap": {}
},
"taskState": {
"value": 2
},
"taskParameter": {
"param": []
},
"outputStr": "",
"conditionParameter": {
"param": []
},
"labels": null,
"originTaskId": "",
"scheduleTaskExtend": null,
"hosts": []
}
]
}
}
Failed (404)#
DEL Удаление запланированной задачи#
Основная информация#
Статус интерфейса: Опубликован URL интерфейса: DEL {{API_PATH_V3}}/schedule?tasks=["Task(test_api)"] Способ аутентификации: Аутентификация не требуется
Передаваемые параметры#
Параметры запроса
Возвращаемые параметры (json + таблица)#
Success (200)#
json
{
"status": 200,
"data": "success"
}Failed (404)#
json
{
"errorCode" : "500" ,
"errorMsg" : "errorMsg"
}POST Запуск/приостановка запланированной задачи#
Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_V3}}/schedule/state Content-Type: application/json Способ аутентификации: Аутентификация не требуется
Передаваемые параметры#
Параметры body запроса
Возвращаемые параметры (json + таблица)#
Success (200)#
Failed (404)#
POST Однократное выполнение запланированной задачи#
Статус интерфейса: Опубликован URL интерфейса: POST {{API_PATH_V3}}/schedule/execute Content-Type: application/json Способ аутентификации: Аутентификация не требуется
Передаваемые параметры#
Параметры body запроса
Возвращаемые параметры (json + таблица)#
Success (200)#
Failed (404)#