自用API-查询RPA详情列表

2022-08-11 1070

查询RPA详情列表

简要描述

通过RPA_ID查询 RPA详情信息，如：名称、简介、参数、参数取值范围、收费标准。

请求URL

/rpa/company/scripts

请求方式

请求参数

Headers

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

Query

参数名	参数描述	必选	类型	说明
ids	要查询的RPA id列表	否	string	不传入id时，获取当前应用有权限的全部RPA，多个id，以逗号间隔，上限20 例如："123,124"
pageNum	分页参数，页码	否	string	默认值为1
pageSize	分页参数，每页数据条数	否	string	默认值为100
name	RPA名称	否	string	按名称检索

提交数据样例

无

返回数据

参数名	参数描述	必选	类型	说明
code	状态码	是	number	-
msg	提示信息	否	string(1024)	-
data	业务数据	是	object	-
-rpaScriptId	RPA唯一标识	是	string(11)
-rpaName	名称	是	string(128)
-description	描述	否	string(2048)
-price	价格	是	number	如：0.02
-priceUnit	收费单位	是	string(20)	如：元/每次
-runWith	运行参数	是	object[]	不同的RPA有不同的参数列表，表示运行该RPA需要输入的参数有哪些
--name	参数名称	是	string(20)	指明该RPA需要的参数名称，对应创建任务接口的，scriptList.runWith.name参数的取值
--type	参数类型	是	string(20)	string：字符串，number：数字 date：日期，timestamp：时间戳（毫秒） datarange：期日范围
--format	参数范围	是	string(1024)	非严格JSON格式，一般格式为 option:[{"name":"运行时刻","value":"now"}]，此处now表示的是，输入一个代表当前时间从参数
--description	参数描述	否	string(1024)

返回数据样例

{
    "requestId": "698768165885304832",
    "code": 0,
    "msg": "SUCCESS",
    "data": [
        {
            "rpaScriptId": "1031",
            "rpaName": "账户余额导出csv文件",
            "platformId": "0",
            "description": "<p>Amzon Total Balance CSV（账户余额CSV）自动抓取余额数据\n店铺站点下的账户余额数据自动抓取下载成csv文件，多店铺可合并成一个文件，一览所有店铺账户余额。</p>",
            "price": 1,
            "priceUnit": "file",
            "runWith": [
                {
                    "name": "daterange",
                    "type": "daterange",
                    "format": "option:[{\"name\":\"运行时刻\",\"value\":\"now\"}] rule:null",
                    "description": "日期范围"
                }
            ],
            "iconUrl": "https://cloud-rpa.s3.cn-north-1.amazonaws.com.cn/img/亚马逊-抓取数据.png"
        }
    ]
}

备注

查看RPA详情与创建计划接口的入参对应关系如下图

本文导读