自用API-查询计划列表

2022-08-03 727

查询计划列表

简要描述

查询公司下的计划列表

请求URL

/rpa/company/plan-lists

请求方式

请求参数

Headers

参数名	参数描述	必选	类型	说明
Authorization	身份令牌	是	string	AppToken

Query

参数名	参数描述	必选	类型	说明
planStatus	计划状态	否	string	ENABLED：生效中的 STOP：已停用的
platformId	所属平台	否	string	如 0 为亚马逊平台，参考平台站点对照表
name	计划名称	否	string
id	计划ID	否	string
pageNum	页码	否	number	不传时默认为1
pageSize	每页条数	否	number	不传时默认为100，最大不可超过100

提交数据样例

无

返回数据

参数名	参数描述	必选	类型	说明
code	状态码	是	number	0 表示请求成功
msg	提示信息	否	string(1024)
data	业务数据	是	object
-pageNum	页码	是	string(11)
-pageSize	每页条数	是	number
-totalCount	总数	否	number
-curPage	价格	是	object[]
--planId	运行参数	是	object[]
--name	参数名称	是	string(20)
--platformId	参数类型	是	string(20)	如 0表示该计划为亚马逊平台
--actionType	参数范围	是	string(1024)	立即执行：AT_ONCE 指定时间执行：ASSIGN_TIME 按小时执行：REPEAT_BY_HOUR 按天执行：REPEAT_BY_DAY 按周执行：REPEAT_BY_WEEK 按月执行：REPEAT_BY_MONTH
--assignTime	参数描述	否	string(1024)	毫秒时间戳。 actionType为ASSIGN_TIME 时该字段有值
--repeatRange	参数描述	否	string(1024)	actionType为 REPEAT_BY_HOUR REPEAT_BY_WEEK REPEAT_BY_MONTH 时该字段有值按小时执行：REPEAT_BY_HOUR 如：26 指每间隔26小时目前仅支持间隔26或48小时按周执行：REPEAT_BY_WEEK 如：2 指每周2 取值范围（1到7）按月执行：REPEAT_BY_MONTH 如：30 指每月30号取值范围1到31
--repeatTimeAt	参数描述	否	string(1024)	actionType为 REPEAT_BY_DAY REPEAT_BY_WEEK REPEAT_BY_MONTH 时该字段有值格式 HH:mm 如：15:00 指对应日期的15点执行
--repeatFrom	循环执行开始时间	否	Date	毫秒时间戳. actionType为 REPEAT_BY_HOUR时该字段有值。表示从某时刻起每阁指定小时数执行一次。
--validFrom	计划有效期开始	否	Date
--validTo	计划有效期结束	否	Date
--actionDescription	执行方式描述	否	string

返回数据样例

{
	"msg": "SUCCESS",
	"code": 0,
	"data": {
		"curPage": [
			{
				"actionType": "AT_ONCE",
				"name": "立刻执行的任务",
				"planId": "119994",
				"platformId": "0",
				"validFrom": 1656604800000,
				"actionDescription": "即刻执行",
				"validTo": 1656691199000
			}
			{
				"actionType": "REPEAT_BY_DAY",
				"repeatTimeAt": "01:00",
				"name": "每天执行的任务",
				"planId": "8313",
				"platformId": "0",
				"actionDescription": "每天：01:00执行"
			},
			{
				"actionType": "ASSIGN_TIME",
				"name": "888888",
				"planId": "119592",
				"platformId": "0",
				"actionDescription": "在指定时间执行：2022-06-28 00:00:00",
				"assignTime": 1656345600000
			}
		],
		"pageSize": 100,
		"totalCount": 81988,
		"pageNum": 1
	},
	"requestId": "702681041818779648"
}

本文导读