作者:管理员  历史版本:1  最后编辑:龚清  更新时间:2024-05-28 11:17

定时任务创建

简述:

  • 定时任务创建

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
jobName string 任务名称 唯一key
jobClass string 人物类
group string 分组
description string 描述
jobDataMap map 任务数据

请求参数示例:

{
    "jobName": "www",
    "group": "common",
    "jobClass": "com.lc.ibps.cloud.timer.job.PrintJob",
    "description": "",
    "jobDataMap": {}
}

返回示例:

{
  "state": 200, 
  "request": null, 
  "message": "定时任务数据保存成功!", 
  "cause": "", 
  "variables": { }, 
  "data": null
}

返回参数说明:

名称 类型 备注
data String

定时任务执行

简述:

  • 定时任务执行

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
group string 分组名
jobName string 任务名

请求参数示例:

http://192.168.3.230:15100/ibps/platform/v3/job/execute?group=common&jobName=www

返回示例:

{
    "state": 200,
    "request": null,
    "message": "定时任务执行成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明:

名称 类型 备注
data Void

定时任务对象

简述:

  • 定时任务对象

请求URL:

请求方式:

  • GET

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
group string 分组名
jobName string 任务名

请求参数示例:

http://192.168.3.230:15100/ibps/platform/v3/job/get?group=common&jobName=www

返回示例:

{
    "state": 200,
    "request": null,
    "message": "定时任务数据查询成功!",
    "cause": "",
    "variables": {},
    "data": {
        "jobName": "www",
        "description": "",
        "jobClass": "com.lc.ibps.cloud.timer.job.PrintJob",
        "group": "common",
        "jobDataMap": {}
    }
}

返回参数说明:

名称 类型 备注
data Void

定时任务分组列表

简述:

  • 定时任务分组列表

请求URL:

请求方式:

  • GET

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/platform/v3/job/groups

返回示例:

{
    "state": 200,
    "request": null,
    "message": "定时任务分组数据查询成功!",
    "cause": "",
    "variables": {},
    "data": [
        "common",
        "org",
        "bpmn"
    ]
}

返回参数说明:

名称 类型 备注
data <List< String >

定时任务列表

简述:

  • 定时任务列表

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
group string 分组名
jobName string 任务名
  • Body:
名称 类型 是否必须 默认值 备注 其他信息
request APIRequest[1] 动态查询请求对象

请求参数示例:

http://192.168.3.230:15100/ibps/platform/v3/job/query?group=common&jobName=www

body:
{
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    }
}

返回示例:

{
    "state": 200,
    "request": null,
    "message": "定时任务数据查询成功!",
    "cause": "",
    "variables": {},
    "data": {
        "dataResult": [
            {
                "jobName": "www",
                "description": "",
                "jobClass": "com.lc.ibps.cloud.timer.job.PrintJob",
                "group": "common",
                "jobDataMap": {}
            }
        ],
        "pageResult": {
            "limit": 20,
            "page": 1,
            "totalCount": 1,
            "totalPages": 1
        }
    }
}

返回参数说明:

名称 类型 备注
data APIPageList< JobDetailVo > 任务细节对象信息列表

定时任务删除

简述:

  • 定时任务删除

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
group string 分组名
jobName string 任务名
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/platform/v3/job/remove?groups=common&jobNames=www

返回示例:

{
    "state": 200,
    "request": null,
    "message": "定时任务删除成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明:

名称 类型 备注
data Void

定时任务编辑

简述:

  • 定时任务编辑

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
jobName string 任务名称 唯一key
jobClass string 人物类
group string 分组
description string 描述
jobDataMap map 任务数据

请求参数示例:

{
    "jobName": "asdfg",
    "description": "123",
    "jobClass": "com.lc.ibps.cloud.timer.job.PrintJob",
    "group": "common",
    "jobDataMap": {}
}

返回示例:

{
    "state": 200,
    "request": null,
    "message": "定时任务数据保存成功!",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明:

名称 类型 备注
data String

验证类

简述:

  • 验证类

请求URL:

请求方式:

  • GET

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
jobClass String 完整类名
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/platform/v3/job/validClass?jobClass=com.lc.ibps.cloud.timer.job.PrintJob

返回示例:

{
    "state": 200,
    "request": null,
    "message": "验证成功",
    "cause": "",
    "variables": {},
    "data": null
}

返回参数说明:

名称 类型 备注
data Void

备注