REST Web Service package
使用 REST Web Service package 中的 actions 作为向 API 发送请求和从 API 接收响应的方法（例如 DELETE、GET、PATCH、POST 或 PUT）。
使用 REST Web Service actions
提供以下信息以发送 REST 请求并接收响应。并非所有方法都需要所有参数。
- URI：API 资源的唯一地址。
- 身份验证类型：有三种支持的身份验证模式：
- 基本：文本字符串可用于基本身份验证。
- 已登录 AD 用户：授权访问相关 API 的 Active Directory (AD) 用户通过 AD 进行身份验证。请求中不需要凭据。
- Windows NT LAN Manager (NTLM) 验证（AD 用户）：一种质询/响应验证方法，使客户端能够将其用户名和密码作为加密凭据或纯文本提供。我们建议您使用存储在 Automation Anywhere Credential Vault 中的凭据。
- 标题：并非所有方法都需要标题。标题表示与请求关联的元数据。注： 要在请求中使用 API 密钥，请在标题名称字段中输入
api_key，并在值字段中输入密钥值。 - 捕获故障响应：选择该复选框以捕获失败响应（成功/正常响应除外）。在响应正文中捕获失败响应详细信息。
- 使用 https 时允许不安全的连接：选中复选框以在使用 https 时允许不安全的连接。
- 内容类型：当标题包含内容类型时，它定义客户端和服务器之间的内容协商。REST Web Service actions 支持以下内容类型：
- 应用程序/json
- 应用程序/xml
- 文本/纯文本
- 文本/html
- 文本/xml
- 多部件/表单数据
- 等待操作完成：您可以在发送 REST 请求并接收响应时设置超时值。执行 actions（例如 POST、PUT、DELETE、PATCH 和 GET）时，在等待操作完成字段中，您可以指定等待时间（以毫秒为单位）。默认情况下，等待时间为 60000 毫秒。
- 输出变量：响应输出在字典变量中捕获。字典变量是密钥值对。使用响应标题名称作为密钥返回标题值，或将“Body”作为密钥返回响应正文。注： 响应密钥及其值在字典变量中可用，以显示 REST API 的响应状态。要获取 API 资源的标题名称列表，请执行以下步骤：
- 在 REST Web Service action 之后插入 Loop action。
- 选择对于字典中的每个密钥迭代器。
- 在字典变量字段中，选择包含 REST Web Service action 输出的变量。
- 将每个密钥的值分配给
$prompt-assignment$。 - 插入 Log To File action。
- 提供文本文件的文件路径以保存标题名称列表。
- 在将文本输入日志字段中插入
$prompt-assignment$。 - 选择覆盖现有文件选项。
- 单击保存。
运行 bot 时，会将标题名称从 API 资源打印到选定的文件。
安全地传递值
您可以通过在以下支持的 action 字段中指定 locker、凭据和属性，将值从 Credential Vault 安全地传递到 Web 服务：
- URI
- 自定义标头
- 正文：对于
application/x-www-form-urlencoded内容类型，单击添加参数以从 Credential Vault 中选择值。对于所有其他内容类型，请选择选择凭据作为参数选项，然后单击选择。
REST Web Service package 中的 Actions
| Action | 描述 |
|---|---|
| DELETE 方法 | 移除由 URI 标识的资源。 |
| GET 方法 | 检索由 URI 中包含的参数标识的信息。GET 方法没有内容类型，因为所有参数作为 URI 的一部分传递。 GET 方法的局限性和特征包括以下内容：
|
| 补丁方法 | 修改由 URI 标识的资源。 |
| POST 方法 | 在 URI 中创建新资源。
|
| PUT 方法 | 根据 URI 或正文中传递的参数更新或替换资源。 |
代理支持
如果您的设备配置了代理，则来自此 package 的所有出站请求将通过代理服务器路由。请参阅 ../../../control-room/devices/cloud-bot-agent-authenticate-proxy.html。