接口文档

环境地址

环境	url
测试环境	https://rpaservice-test.chinaums.com/rpa-console
生产环境	https://rpaservice.chinaums.com/rpa-console

鉴权相关接口

accessToken获取接口

接口url：/api/getAccessToken

HTTP Method : POST

请求参数:

参数名称	参数说明	是否必须	数据类型
appId	appId	true	string
appSecret	appSecret	true	string
timestamp	时间戳	true	string
signature	签名，sha256(appId+appSecret+timestamp)	true	string

响应参数:

参数名称	参数说明	类型
code	0-成功，1-失败	int
data	返回数据，data.accessToken字段数据为平台生产的token数据	object
msg	返回消息	string

响应体示例

{
  "data": {
    "accessToken": "520da9c9-694d-4b40-9332-0c179243c88e",
    "expires": 7199
  },
  "code": 0,
  "msg": "success"
}

工作流相关接口

工作流数据修改接口

url：/api/task/update

HTTP Method : POST

请求头:

参数名称	参数说明	是否必须	数据类型
accessToken	鉴权接口获取的accessToken	true	String
Content-Type	application/json	true	string

请求参数:

参数名称	参数说明	是否必须	数据类型
workflowId	workflowId	true	long
cron	定时启动表达式（如果不用修改请带上原来的值）	false	string
qywxRoburl	企业微信群发url（如果不用修改请带上原来的值）	False	string
autoWorkStatistics	是否自动统计工时（0代表否，1代表是）	False	Int
workTime	单笔节省工时	False	double

响应参数:

参数名称	参数说明	类型
code	0-成功，1-失败	int
msg	返回消息	string

响应体示例

{
  "code": 0,
  "msg": "success"
}

查询工作流列表接口

url：/api/task/list

HTTP Method : POST

请求头:

参数名称	参数说明	是否必须	数据类型
accessToken	鉴权接口获取的accessToken	true	String

请求参数:

参数名称	参数说明	是否必须	数据类型
taskName	工作流名称	False	string
machineCode	机器码	False	string
projectName	项目名称	False	string
page	分页之第几页，默认值1	false	Int
pageSize	分页之每页多少条，默认值10	False	int

响应参数:

参数名称	参数说明	类型
code	0-成功	int
msg	返回消息	string
data	返回数据	Object

data数据说明：

参数名称	参数说明	类型
curPage	当前页页码	int
pageSize	分页之每页多少条	int
list	列表数据	List
totalCount	数据总量	int
totalPage	页数总量	int

list数据说明

参数名称	参数说明	类型
taskId	taskId	int
taskName	工作流名称	string
cron	定时启动表达式	string
cronState	定时任务是否启动，0不启动，1启动	string
machineCode	工作流所在机器的机器码	string
qywxRoburl	企业微信群发url	string
autoWorkStatistics	是否自动统计工时（0代表否，1代表是）	Int
workTime	单笔节省工时	double
startParam	任务启动参数	string
workflowId	workflowId	string

响应体示例

{
	"msg": "success",
	"code": 0,
	"data": {
		"totalCount": 1505,
		"pageSize": 10,
		"totalPage": 151,
		"currPage": 1,
		"list": [{
			"taskId": 9334,
			"taskName": "单步调试",
			"machineCode": "E143D6209B53FAED153B6E0AFD30083E",
			"cron": "",
            "cronState": 0,
			"qywxRoburl": null,
			"workTime": null,
			"autoWorkStatistics": 0,
			"workflowId": "xxxxxxxxxxx",
            "startParam": "{\"a\":123}"
		}]
	}
}

启动任务接口

url：/api/taskInstance/start

HTTP Method : POST

请求头:

参数名称	参数说明	是否必须	数据类型
accessToken	鉴权接口获取的accessToken	true	String

请求参数:

参数名称	参数说明	是否必须	数据类型
workflowId	workflowId	true	long
machineCode	机器码	true	string
startParam	任务启动参数	False	object

响应参数:

参数名称	参数说明	类型
code	0-成功，1-失败	int
msg	返回消息	string
data	返回数据，data.taskInstanceId为任务运行id	Object

响应体示例

{
	"code": 0,
	"msg": "success",
	"data": {
    	"taskInstanceId": "fc38fbsa-8333-1111-83f8-3292aaaaaa"
  	}
}

停止任务运行接口

url：/api/taskInstance/stop

HTTP Method : POST

请求头:

参数名称	参数说明	是否必须	数据类型
accessToken	鉴权接口获取的accessToken	true	String

请求参数:

参数名称	参数说明	是否必须	数据类型
taskInstanceId	工作流运行Id	true	String

响应参数:

参数名称	参数说明	类型
code	0-成功	int
msg	返回消息	string

响应体示例

{
	"code": 0,
	"msg": "success"
}

任务运行回调接口

url：接口管理页面设置的回调接口url

HTTP Method : POST

请求头:

参数名称	参数值	数据类型
Content-Type	application/json	String

请求参数:

参数名称	参数说明	是否必须	数据类型
workflowId	workflowId	true	long
taskName	工作流名称	True	string
taskInstanceId	工作流运行Id	True	string
machineCode	机器码	True	string
status	运行状态（1是运行中，2是成功， 3是失败，4是手动停止）	True	string
startTime	运行开始时间	True	string

响应参数:

参数名称	参数说明	类型
code	0-成功，1-失败	int
msg	返回消息	string

响应体示例

{
	"msg": "success",
	"code": 0
}

查询任务运行结果接口

url：/api/taskInstance/info

HTTP Method : POST

请求头:

参数名称	参数说明	是否必须	数据类型
accessToken	鉴权接口获取的accessToken	true	String

请求参数:

参数名称	参数说明	是否必须	数据类型
taskInstanceId	工作流运行id	true	string

响应参数:

参数名称	参数说明	类型
code	0-成功	int
msg	返回消息	string
data	返回数据	Object

data数据说明

参数名称	参数说明	类型
workflowId	workflowId	string
taskName	工作流名称	string
taskInstanceId	工作流运行id	string
status	运行状态（1是运行中，2是成功，3是失败，4是手动停止）	string
machineCode	工作流所在机器的机器码	string
startTime	运行开始时间	string
endTime	运行结束时间	string

响应体示例

{
	"msg": "success",
	"code": 0,
	"data": {
		"workflowId": "9334",
		"taskName": "单步调试",
		"machineCode": "E143D6209B53FAED153B6E0AFD30083E",
		"status": 2,
		"taskInstanceId": "sdasdadadsasdad",
		"startTime": "2023-08-30 11:00:11"
    }
}

查询任务日志列表接口

url：/api/tasklog/list

HTTP Method : POST

请求头:

参数名称	参数说明	是否必须	数据类型
accessToken	鉴权接口获取的accessToken	true	String

请求参数:

参数名称	参数说明	是否必须	数据类型
taskName	工作流名称	False	string
machineCode	机器码	False	string
status	运行状态	False	int
page	分页之第几页，默认值1	false	Int
pageSize	分页之每页多少条，默认值10	False	int

响应参数:

参数名称	参数说明	类型
code	0-成功	int
msg	返回消息	string
data	返回数据	Object

data数据说明：

参数名称	参数说明	类型
curPage	当前页页码	int
pageSize	分页之每页多少条	int
list	列表数据	List
totalCount	数据总量	int
totalPage	页数总量	int

list数据说明

参数名称	参数说明	类型
workflowId	workflowId	srting
taskName	工作流名称	string
status	运行状态	string
machineCode	工作流所在机器的机器码	string
startTime	运行开始时间	string
endTime	运行结束时间	string

响应体示例

{
	"msg": "success",
	"code": 0,
	"data": {
		"totalCount": 1505,
		"pageSize": 10,
		"totalPage": 151,
		"currPage": 1,
		"list": [{
			"workflowId": "9334",
			"taskName": "单步调试",
			"machineCode": "E143D6209B53FAED153B6E0AFD30083E",
			"status": "1",
			"startTime": null,
			"endTime": null
		}]
	}
}

机器人相关接口

查询机器人列表接口

url：/api/robot/list

HTTP Method : POST

请求头:

参数名称	参数说明	是否必须	数据类型
accessToken	鉴权接口获取的accessToken	true	String

请求参数:

参数名称	参数说明	是否必须	数据类型
machineCode	机器码	False	string
status	机器状态（0：已禁用，1：离线，2：在线）	False	int
page	分页之第几页，默认值1	false	Int
pageSize	分页之每页多少条，默认值10	False	int

响应参数:

参数名称	参数说明	类型
code	0-成功	int
msg	返回消息	string
data	返回数据	Object

data数据说明：

参数名称	参数说明	类型
curPage	当前页页码	int
pageSize	分页之每页多少条	int
list	列表数据	List
totalCount	数据总量	int
totalPage	页数总量	int

list数据说明

参数名称	参数说明	类型
machineCode	机器码	string
alias	机器名	string
status	运行状态（0：已禁用，1：离线，2：在线）	string
ip	ip地址	string
robotVersion	版本号	string
installTime	安装时间	string

响应体示例

{
	"msg": "success",
	"code": 0,
	"data": {
		"totalCount": 250,
		"pageSize": 10,
		"totalPage": 25,
		"currPage": 1,
		"list": [{
			"machineCode": "01221E2CAE5E16B648C381C81CD0429B",
			"alias": "Administrator",
			"terminal": "YJY-WORKER-4",
			"ip": 168506101,
			"robotVersion": "4.0.5",
			"installTime": "2022-10-21 17:05:26",
			"status":  "1"
		}]
	}
}

状态码说明

错误码	说明	排查建议
0	正常	调用正常
300	签名signature错误	排查signature计算是否正确
301	appId/appSecret错误	appId/appSecret错误，请用企业管理员登录后台并进行核对
302	appId/appSecret不可用	请用企业管理员登录后台并进行核对 appId/appSecret是否可用
303	接口参数错误	请安装接口文档检查参数是否设置有误
304	token为空	请在请求头中设置accesstoken参数
305	token已失效	请重新获取accesstoken
500	未知异常	请联系技术支持进行排查