白皮书下载
任务管理
一、新增任务
接口说明
该接口是为了给机器人派发任务所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/job
HTTP method: POST
Content-Type: application/json
请求样例
{
"jobName":"测试任务",//任务名称
"processDetailUUID":"UADACDSKKAKSDLLAL",//创建/获取到的流程版本UUID
"processChannel":"1",// 流程包来源 0:流程管理 1:企业市场. 不传默认为0:流程管理
"executeTimes":1,//执行的次数。不能超过30次。
"executeType":2,//执行方式, 2-立即执行 9-定时执行
"cronExpression":"* * * * * ?",//时间表达式，执行方式选择为定时执行时必填，内容为Cron表达式
"inputParam":{ //机器人任务入参，json格式，任务执行时使用。
"param1":"value1",
"param2":"value2"
},
"priority": 1, // 任务优先级1-高，2-中，3-低
"distributionType": 2, // 分配类型：1-自动分配，2-指定bot机器人；分配类型为2（指定bot机器人）时，botList属性不能为空
"botList": [
{
"botUUID": "fVbcpvj1jG0Qoak5nI1CUUBBYabCb5mX", // 机器人botUUID
"priority": 1 // 优先级1-高，2-中，3-低
},
{
"botUUID": "pYRA8fvWWgRmhZcGj4GNuZNj5lWi7c9n", // 机器人botUUID
"priority": 1 // 优先级1-高，2-中，3-低
}
]
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobName |
String |
是 |
任务的名称(最长三十个字符) |
|
processDetailUUID |
String |
是 |
创建/获取到的流程版本UUID |
|
processChannel |
Integer |
否 |
流程包来源 0:流程管理 1:企业市场. 不传默认为0:流程管理 since1.7.3.1 |
|
executeTimes |
Integer |
否 |
执行的次数。不能超过30次。 |
|
executeType |
Integer |
是 |
执行方式, 2-立即执行 9-定时执行 |
|
cronExpression |
String |
否 |
时间表达式，执行方式选择为定时执行时必填，内容为Cron表达式 |
|
inputParam |
Object |
否 |
机器人任务入参，json格式，任务执行时使用。 |
|
priority |
Integer |
否 |
任务优先级1-高，2-中，3-低，默认2-中 |
|
distributionType |
Integer |
否 |
分配类型：1-自动分配，2-指定bot机器人；分配类型为2（指定bot机器人）时，botList属性不能为空，默认1-自动分配 |
|
botList |
List |
否 |
bot机器人列表，当分配类型为2-指定bot机器人时，需要传递此参数 |
响应样例
{
"msg": "success",
"code": 0, //0为成功
"data": {
"jobUUID": "6ecd9c1a615147648bbb91d266ab5233"//任务UUID
}
}
二、任务详情
接口说明
该接口是为了查询任务详细信息所提供的接口
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/job/searchByUUID/{jobUUID}
HTTP method: GET
请求样例
GET http://commander-manager.dev.ii-ai.tech/openAPI/v1/job/searchByUUID/6ecd9c1a61514
响应样例
{
"msg": "success",
"code": 0, //0 为成功
"data": {
"jobUUID": "ea5ada215fbb4db1bdc41987dc8b115c",//jobUUID
"jobName": "演示任务",//任务名称
"processName": "演示流程",//流程名称
"processChannel":"1",// 流程包来源 0:流程管理 1:企业市场 since1.7.3.1
"processVersion": "1.0.1",//流程版本
"executeTimes": 1,//执行次数
"status": 1,//任务状态 1-运行中 2-待运行 3-已完成 4-已停止 5-停止中
"createTime": "2021-03-22 16:10:13",//创建时间
"executeType": 2,//执行方式 1-手动执行 2-立即执行 9-定时执行
"jobDescription": "创建任务后立即执行"
"inputParam": {"input": "12", "radio": "选项1", "table": [{"姓名": "张三", "年龄": "24"}], "select": "选项1", "switch": 1},\\任务入参
"isReference": true,\\是否引用类型，false-否，true-是
"template":[{"number":2,"name":"textarea","label":"文本域","type":"TextArea","value":"12","tips":"请输入文本内容","height":70},{"number":3,"name":"select","options":["选项1","选项2"],"label":"下拉列表","type":"DropdownList","value":"选项1"}],\\任务模版
}
}
三、查询任务
接口说明
该接口是为了查询任务详细信息所提供的接口
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/job/searchByName/{jobName}
HTTP method: GET
请求样例
GET http://commander-manager.dev.ii-ai.tech/openAPI/v1/job/searchByName/演示任务
响应样例
{
"msg": "success",
"code": 0, //0 为成功
"data": {
"jobUUID": "ea5ada215fbb4db1bdc41987dc8b115c",//jobUUID
"jobName": "演示任务",//任务名称
"processName": "演示流程",//流程名称
"processVersion": "1.0.1",//流程版本
"processChannel":"1",// 流程包来源 0:流程管理 1:企业市场 since1.7.3.1
"executeTimes": 1,//执行次数
"status": 1,//任务状态 1-运行中 2-待运行 3-已完成 4-已停止 5-停止中
"createTime": "2021-03-22 16:10:13",//创建时间
"executeType": 2,//执行方式 1-手动执行 2-立即执行 9-定时执行
"jobDescription": "创建任务后立即执行"
"inputParam": {"input": "12", "radio": "选项1", "table": [{"姓名": "张三", "年龄": "24"}], "select": "选项1", "switch": 1},\\任务入参
"isReference": true,\\是否引用类型，false-否，true-是
"template":[{"number":2,"name":"textarea","label":"文本域","type":"TextArea","value":"12","tips":"请输入文本内容","height":70},{"number":3,"name":"select","options":["选项1","选项2"],"label":"下拉列表","type":"DropdownList","value":"选项1"}],\\任务模版
}
}
四、任务处理
接口说明
该接口是为了对已经创建的任务进行操作所提供的接口 操作类型:1-立即/再次执行任务 2-停止任务 3-强制停止任务(bot触发的手动触发类型的任务) 4-删除任务
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/job/{jobUUID}/{operation}
HTTP method: PUT
Content-Type: application/json
请求样例
PUT：http://commander-manager.dev.ii-ai.tech/openAPI/v1/job/ea5adaads4123/1
Body请求样例
{
"inputParam":{ //机器人任务入参，json格式，任务执行时使用。
"param1":"value1",
"param2":"value2"
}
}
Body
|
参数 |
类型 |
必填 |
说明 |
|
inputParam |
Object |
否 |
任务入参，仅在任务立即执行/再次执行时，如果传递该参数，那么会先更新任务入参，再执行任务 |
响应样例
{
"msg": "success",
"code": 0,// 0为成功
"data": true
}
五、更新任务入参
接口说明
该接口是为了提供任务（job）修改任务参数操作所提供的接口
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/job/job-update
HTTP method: POST
Content-Type: application/json
请求样例
{
"jobUUID":"b63efba1bc3b4cb686552829a03c9fbc",//创建任务获取的任务jobUUID
"inputParam":{ //机器人任务入参，json格式。
"param1":"value1",
"param2":"value2"
}
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobUUID |
String |
是 |
任务的UUID(最长三十二个字符) |
|
inputParam |
Object |
是 |
机器人任务入参 |
响应样例
{
"msg": "success",
"code": 0, //0为成功
"data": true //true-更新成功，false-更新失败
}
六、根据名称右模糊查询任务详情列表
接口说明
该接口是为了根据名称右模糊查询任务列表信息所提供的接口
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/job/list/searchByName
HTTP method: POST
请求样例
{
"jobName": "openapi测试服务器003", // 任务名称
"length": 100, // 返回结果长度，不传则默认1000
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobName |
String |
是 |
任务名称 |
|
length |
Integer |
否 |
返回结果长度，不传则默认1000 |
响应样例
{
"msg": "success",
"code": 0, //0 为成功
"data": [
{
"jobUUID": "ea5ada215fbb4db1bdc41987dc8b115c",//jobUUID
"jobName": "演示任务",//任务名称
"processName": "演示流程",//流程名称
"processChannel":"1",// 流程包来源 0:流程管理 1:企业市场 since1.7.3.1
"processVersion": "1.0.1",//流程版本
"executeTimes": 1,//执行次数
"status": 1,//任务状态 1-运行中 2-待运行 3-已完成 4-已停止 5-停止中
"createTime": "2021-03-22 16:10:13",//创建时间
"executeType": 2,//执行方式 1-手动执行 2-立即执行 9-定时执行
"jobDescription": "创建任务后立即执行"
"inputParam": {"input": "12", "radio": "选项1", "table": [{"姓名": "张三", "年龄": "24"}], "select": "选项1", "switch": 1},\\任务入参
"isReference": true,\\是否引用类型，false-否，true-是
"template":[{"number":2,"name":"textarea","label":"文本域","type":"TextArea","value":"12","tips":"请输入文本内容","height":70},{"number":3,"name":"select","options":["选项1","选项2"],"label":"下拉列表","type":"DropdownList","value":"选项1"}],\\任务模版
},
{
"jobUUID": "ea5ada215fbb4db1bdc41987dc8b115c",//jobUUID
"jobName": "演示任务",//任务名称
"processName": "演示流程",//流程名称
"processVersion": "1.0.1",//流程版本
"executeTimes": 1,//执行次数
"status": 1,//任务状态 1-运行中 2-待运行 3-已完成 4-已停止 5-停止中
"createTime": "2021-03-22 16:10:13",//创建时间
"executeType": 2,//执行方式 1-手动执行 2-立即执行 9-定时执行
"jobDescription": "创建任务后立即执行"
"inputParam": {"input": "12", "radio": "选项1", "table": [{"姓名": "张三", "年龄": "24"}], "select": "选项1", "switch": 1},\\任务入参
"isReference": true,\\是否引用类型，false-否，true-是
"template":[{"number":2,"name":"textarea","label":"文本域","type":"TextArea","value":"12","tips":"请输入文本内容","height":70},{"number":3,"name":"select","options":["选项1","选项2"],"label":"下拉列表","type":"DropdownList","value":"选项1"}],\\任务模版
}
]
}
七、查询运行记录
接口说明
该接口是为了租户能够查询租户名下所有任务的运行记录。
URL: https://z-commander-api.ai-indeed.com/openAPI/work-execute/list
HTTP method: POST
Content-Type: application/json
请求样例
{
"startTime": "2021-02-20 22:00:06",
"endTime": "2023-02-23 10:55:13",
"current": 1,
"size": 30
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
startTime |
String |
是 |
查询开始时间 |
|
endTime |
String |
是 |
查询结束时间 |
|
current |
Long |
是 |
当前页数 |
|
size |
Long |
是 |
每页展示数量 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"total": "2",
"pages": "1",
"size": "30",
"current": "1",
"records": [
{
"workUuid": "e09b3f9b07a160ad44c5aae08a5c35dd",--作业ID
"jobName": "新任务",
"botId": "1292",--机器人Id
"accountName": "qihai",
"runTime": "5",--运行时间单位s
"status": 4,--作业状态
"statusDesc": "已停止",
"gmtCreated": "2023-02-22 20:06:13",--作业创建时间
"realName": "qihai",--账户名称
"startTime": "2023-02-22 20:06:10",--作业开始执行时间
"endTime": "2023-02-22 20:06:15",--作业结束运行时间
"deptName": "实在智能"--部门名称
},
{
"workUuid": "688a487f777078f4bca6e4a8a40dfa3e",
"jobName": "跑的时间比较长的exce流程23点开始跑",
"botId": "1292",
"accountName": "qihai",
"runTime": "11",
"status": 3,
"statusDesc": "运行失败",
"gmtCreated": "2023-02-22 20:00:02",
"realName": "qihai",
"startTime": "2023-02-22 20:00:02",
"endTime": "2023-02-22 20:00:13",
"deptName": "实在智能"
}
],
"start": null
}
}
八、任务执行之后返回当次成功的运行记录 id
--since1.8.0
接口说明
该接口是为了对已经创建的任务进行操作所提供的接口操作类型:1-立即/再次执行任务2-停止任务 3-强制停止任务(bot 触发的手动触发类型的任务)4-删除任务
URL:https://z-commander-api.ai-indeed.com/openAPI/v2/job/operation
HTTPmethod:POST
Content-Type:application/json
请求样例
{
"jobUuid":"demoData","operation":1,
"inputParam":{//机器人任务入参，json 格式，任务执行时使用。
"param1":"value1",
"param2":"value2"
}
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobUuid |
String |
是 |
任务 UUID |
|
operation |
int |
是 |
1-立即/再次执行任务 2-停止任务 3-强制停止任务(bot 触发的手动触发类型的任务) 4-删除任务 |
|
inputParam |
Object |
否 |
任务入参，仅在任务立即执行/ |
响应样例
{
"msg":"success",
"code":0,//0 为成功
"data":{
"jobUuid":"demoData",
"operation":1,
"success":true,
"works":[
{
"workUuid":"demoData",//运行记录 ID
"departmentId":1,//部门 ID
"isReference":true,//是否为引用参数类型,
"isGroup":true,//是否为任务组
"gmtCreated":"",
"gmtModified":"",
"workExecutes":[{
"workUuid":"demoData",//运行记录 UUID
"workExecuteUuid":"demoData",//执行记录 UUID
"processOrder":1,//当前流程运行排序
"processChannel":1,//流程包来源 0:流程管理 1:流程市场
"processUuid":"demoData",//流程包 UUID
"processDetailUuid":"demoData",//流程版本 UUID
"processVersion":"demoData",//流程版本
"processName":"demoData",//流程名称
"isReference":true//是否为引用参数类型
}]
}
]
}
}
九、 运行记录详情
接口说明
--since1.8.0
运行记录详情
URL:https://z-commander-api.ai-indeed.com/openAPI/v1/work-list
HTTPmethod:POST
请求样例
{
"workUuids":["b63efba1bc3b4cb686552829a03c9fbc"]//运行记录 UUID
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
workUuid |
String |
是 |
运行记录 UUID |
响应样例
{
"msg":"success",
"code":0,//0 为成功
"data":[
{
"workUuid":"demoData",//运行记录 ID
"departmentId":1,//部门 ID
"departmentName":"",//部门名称
"status":"",//跳转的状态-2-丢失结果，-1-加载中，1-运行中，2-待运行，3-运行失败，4-已停止，5-已完成，6-停止中，8-已终止
"startTime":"开始时间=",
"endTime":"结束时间",
"distributionType":"",//分配类型 1-自动分配 2-指定 bot 机器人
"executeType":"",//执行类型-1-手动执行 0-立即执行 9-定时器执行
"botUuid":"",//执行的机器人 UUID
"botName":"",//机器人名字
"reasonCodeStr":"",//错误原因失败才有,
"failDescription":"",//错误详细描述失败才有
"isReference":true,//是否为引用参数类型,
"isGroup":true,//是否为任务组
"gmtCreated":"",
"gmtModified":"",
"workExecutes":[{
"reasonCodeStr":"",//错误原因失败才有,
"failDescription":"",//错误详细描述失败才有
"departmentName":"",//部门名称
"botUuid":"",//执行的机器人 UUID
"botName":"",//机器人名字
"status":"",//跳转的状态-2-丢失结果，-1-加载中，1-运行中，2-待运行，3-运行失败，4-已停止，5-已完成，6-停止中，8-已终止
"workUuid":"demoData",//运行记录 UUID
"workExecuteUuid":"demoData",//执行记录 UUID
"processOrder":1,//当前流程运行排序
"processChannel":1,//流程包来源 0:流程管理 1:流程市场
"processUuid":"demoData",//流程包 UUID
"processDetailUuid":"demoData",//流程版本 UUID
"processVersion":"demoData",//流程版本
"processName":"demoData",//流程名称
"isReference":true//是否为引用参数类型
}]
}
]
}
