自用API-修改计划并创建任务

2022-08-22 481

修改计划并创建任务

简要描述

通过指定要修改的计划id，并重新传入计划参数，提交计划后，由系统按新计划自动生成任务，已经执行过的任务不会重新执行。

请求URL

/rpa/company/plans/replacement

请求方式

POST

支持格式

JSON

请求参数

Headers

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

Body

参数名	参数描述	必选	类型	说明
name	计划名称	是	string(128)	-
platformId	平台id	是	string(1)	-
actionType	执行类型	是	string(30)	立即执行：AT_ONCE 指定时间执行：ASSIGN_TIME 按小时执行：REPEAT_BY_HOUR 按天执行：REPEAT_BY_DAY 按周执行：REPEAT_BY_WEEK 按月执行：REPEAT_BY_MONTH
assignTime	指定运行时间	否	date	actionType为 `ASSIGN_TIME：必填`
repeatFrom	循环开始时间	否	number	actionType为`REPEAT_BY_HOUR：选填` 值为毫秒时间戳不填时默认为从当前时间5分钟后开始循环
repeatRange	按周期范围	否	string(30)	actionType为 `REPEAT_BY_HOUR：必填` `REPEAT_BY_WEEK：必填` `REPEAT_BY_MONTH：必填` 按小时执行：REPEAT_BY_HOUR 如：26 指每间隔26小时目前仅支持间隔26或48小时按月执行：REPEAT_BY_MONTH 如：30 指每月30号取值范围1到31
repeatTimeAt	按周期执行的时间点	否	string(5)	actionType为 `REPEAT_BY_DAY：必填` `REPEAT_BY_WEEK：必填` `REPEAT_BY_MONTH：必填` 格式 HH:mm 如：15:00 指对应日期的15点执行
scriptList	RPA列表	是	object[]	-
scriptId	RPA_ID	否	string(32)	单个RPA的Id
runWith	参数列表	否	object[]	不同RPA可选的参数列表不一样，可通过获取RPA详情接口进行查看,对应接口返回中的runWith结果
name	参数名称	否	string(50)	通过RPA详情查询接口，获取对应RPA的runWith参数，该字段用于指名参数名称，如：datarange，统计汇总类RPA会去各个电商平台自动下载对应报表，该字段指名了要汇总报表的时间范围。（参看第4节RPA参数对照表）
value	参数值	否	string(Max)	通过RPA详情查询接口，获取对应RPA的runWith参数，该字段用于指明参数名称对应的取值，如：lastweekSunday，上周末至今（参看第5节RPA参数对照表）
storeScopeType	店铺范围	是	string(30)	ALL全部、ASSIGNED指定
storeAndMarketPlaceList	店铺和站点	否	object[]	storeScopeType值为ASSIGNED时必须指明要运行的店铺和站点
sellerIds	卖家标识	否	string(Max)	多个id用逗号间隔，指定是电商平台提供的卖家Id
marketPlace	站点	否	string(1024)	多个用逗号间隔，如：US、CA，参考第六节平台站点代码
validFrom	计划有效期从	否	date	时间戳（毫秒），计划有效期对周期性任务有效，如每天一点运行的任务，有效期为2022年1月1号到2022年1月31号
validTo	计划有效期至	否	date	时间戳（毫秒），计划有效期对周期性任务有效，如每天一点运行的任务，有效期为2022年1月1号到2022年1月31号
extInfo	自定义扩展参数	否	object	JSON格式的map对象，该参数回透传给RPA执行器，可用于自行开发RPA或定制化RPA时传递自定义的复杂参数
planId	计划ID	是	string	要修改的计划id

提交数据样例

  {
    "name": "任务名称repeat",
    "platformId": "0",
    "actionType": "REPEAT_BY_WEEK",
    "repeatRange": "2,3",
    "repeatTimeAt":"00:01",
    "validFrom": null,
    "validTo": null,
    "scriptList": [
        {
            "scriptId": "1002",
            "runWith": [
                {
                    "name": "downloadTimeType",
                    "value": "last60"
                }
            ]
        }
    ],
    "storeScopeType": "ASSIGNED",
    "storeAndMarketPlaceList": [
        {
            "sellerIds": "16310663243655",
            "marketPlace": "US,ES"
        }
    ],
    "planId": "123123"
}

返回数据

参数名	参数描述	必选	类型	说明
code	状态码	是	number	-
msg	提示信息	否	string	-
data	业务数据	是	object	-
planId	任务id	是	string	用于唯一标识该任务
companyId	公司ID	是	string	调用公司ID
companyName	公司名称	是	string	调用公司名称
userId	用户ID	否	string	调用方使用的用户ID

返回数据样例

{
    "code": 0,
    "data": {
        "companyId": "0001",
        "companyName": "测试公司",
        "planId": "0001",
        "userId": "0001"
    },
    "msg": "SUCCESS"
}

本文导读