本篇文章是UiPath API系列的第一篇,介绍怎么通过API JSON传递参数到Orchestrator后台创建Text Assets。方法较为简单,主要也是熟悉一下UiPath API的工作流程。
一、概述
需要Uipath process Activities:Orchestrator HTTP Request。
Orchestrator Folder Path:目标文件夹,Orchestrator后台可以创建或查看文件夹。
Method:Request方法,常用的就是get和post两种。
Relative Endpoint:我们需要发送去到的API URL。
JSON Payload:向上面Endpoint中发送的数据。
二、步骤
1. 获取Relative Endpoint
打开UiPath Orchestrator主页,复制下图链接,注意复制到orchestrator_ 并在其后面添加swagger/index.html
添加前:
https://cloud.uipath.com/wtprober/DefaultTenant/orchestrator_
添加后:
https://cloud.uipath.com/wtprober/DefaultTenant/orchestrator_/swagger/index.html
Swagger UI可以提供API URL,查询API文档。里面解析了很多很多的API接口可供使用,在此不过多赘述。
本篇文章目的是创建Text Asset,所以下滑找到Assets
我们需要创建assets,所以使用POST方法,相应的Endpoint就是 /odata/Assets。
这里我们不需要把完整的URL全部填进去,只需要填 /odata/Assets 即可,因为在UiPath Studio已经指定好了用户和文件夹(界面右上角和右下角)。
此处还有第二种方法:查询UiPath API官方文档
链接:UiPath Add-ins Guide
单击Assets即可查看API的使用方法。
2. 准备JSON Payload
接下来我们需要设置发送到API URL的Payload。
官方文档中提供了body的书写方法
如果想知道各个参数代表的意思,可以返回Swagger UI中查看详细信息。
将基础的信息(可以在此基础上添加其他参数,比如 Description)复制在此处,并且进行相应的修改:
修改前:
{
"Name": "Caesar2",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "Et tu Asset 2"
}
为了符合UiPath的代码规则,我们还需修改一下内容格式
1.将参数名的双引号去掉
2.将内容的双引号修改为单引号
2.将内容缩小到一行
3.修改内容
修改后:
{Name: 'test1',ValueScope: 'Global',ValueType: 'Text',StringValue: '123456',Description:'Just for my CSDN test'}
至此,我们需要的全部内容均已准备完毕。
三、结果
将上面的内容填入activities中
这里我设置了变量Status_Code并输出到结果,可以方便查看Request的执行结果。
执行后可以在Orchestrator后台看到添加的Assets:
并且输出了Status_Code=201,表示请求成功并且服务器创建了新的资源。
如有错误,欢迎指正交流!