简要描述

• 通过输入计划参数，指定要运行的RPA、店铺、站点、任务运行周期等，创建对应的任务计划，计划提交后由系统自动创建对应的任务并执行。

请求URL

• /rpa/company/plans

请求方式

• POST

支持格式

• JSON

请求参数

Headers

Body

提交数据样例

  {
    "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"
        }
    ]
}

返回数据

返回数据样例

  {
	"code": 0,
	"msg": "SUCCESS",
	"data": {	
		"planId":"0001"
	}
}

回调消息

任务运行时，以店铺站点为最小单位，每运行完一个店铺下的一个站点，就会发送回调数据，单条回调数据中，如果输出多个文件，则results参数为多个结果，每个结果中包含一个可下载的文件。
需要注意的是，同一个店铺站点的数据，如果首次运行失败了，会将失败的数据同过回调发送，发送系统有可能会自动重试该运行结果，重试的结果也会通过回调发送，所以同一个店铺站点的数据，需要以店铺+站点+RPA作为唯一标识，以最后一次运行结果为最终结果，需要通过API，主动触发结果重试时，建议等到整个任务运行结束后，再发起重试。

1. 通过生态中心转发返回数据格式：

返回数据样例

{
        "appKey": "100",
	"messageType": "0001",
	"companyId":"0001",
	"extra":"ABCD",
}

2. 业务数据格式：回调分两种模式，批量回调和非批量回调

非批量回调返回数据样例

{
    "code": 0,
    "data": {
        "planId": "100",
        "results": [
            {
                "downloadUrl": "",
                "errorCode": "10002",
                "errorMsg": "错误信息",
                "planId": "100",
                "platform": "0",
                "rpaId": "0001",
                "sellerId": "ABCD",
                "siteCode": "US",
                "siteName": "美国",
                "storeName": "测试店铺",
                "taskEndTime": "1641295485000",
                "taskId": "0001",
                "taskRecordId": "0001",
                "taskRecordType": "SUCCESS",
                "taskStartTime": "1641295485000",
                "url": ""
            }
        ]
    },
    "msg": "RPA报表上报",
    "type": "3001"
}

批量回调返回数据样例

[
    {
        "code": 0,
        "data": {
            "planId": "100",
            "results": [
                {
                    "downloadUrl": "",
                    "errorCode": "10002",
                    "errorMsg": "错误信息",
                    "planId": "100",
                    "platform": "0",
                    "rpaId": "0001",
                    "sellerId": "ABCD",
                    "siteCode": "US",
                    "siteName": "美国",
                    "storeName": "测试店铺",
                    "taskEndTime": "1641295485000",
                    "taskId": "0001",
                    "taskRecordId": "0001",
                    "taskResultType": "SUCCESS",
                    "taskStartTime": "1641295485000",
                    "url": ""
                }
            ]
        },
        "msg": "RPA报表上报",
        "type": "3001"
    }
]

请求参数scriptList的特殊说明

（1）创建计划时，如何获取scriptId参数
打开RPA市场，找到要运行的RPA，点击该RPA打开详情页面，可以看到
RPA_ID字段，该字段的值对应scriptId的值，如下图：

（2）创建计划时，如何填写runWith参数
可以在获取RPA参数后，调用详情查看接口来获取RPA执行所需要的参数，该参数根据RPA不同，需要的参数也不同。对应规则如下图：