HTTP 请求（旧版）

UiPath.Web.Activities.HttpClient

重要提示：

此活动在早于 2.0.0 预览版的 WebAPI 包版本中可用。要获得更新的体验，请使用 WebAPI 2.0.0 预览版中包含的改进“HTTP 请求”活动。

描述

用于对指定的网页 API 执行 HTTP 请求。首次将此活动拖动至“设计器”面板时，系统会显示“HTTP 请求向导”窗口，从而提供创建请求及预览服务器响应的便捷方法。

备注：

If the returned HTTP status code (StatusCode) is 0, it means that the server did not return an actual response for some reason. This usually points to some connectivity or network issues you might be having.

重要提示：

WebAPI 包与以下活动不兼容：UiPath.Salesforce.Activities 和 UiPath.Jira.Activities。

项目兼容性

Windows - 旧版 | Windows | 跨平台

Windows、Windows - 旧版配置

导入向导窗口

您可以使用此选项导入 CURL 格式的 HTTP 请求。

HTTP 请求向导窗口

此向导中显示的所有字段也可在“属性”面板中找到。因此，您仍可在关闭向导后编辑首选项。您可以使用硬编码值或变量在向导中配置活动。

备注：

使用变量时，预览功能不可用。

请求生成器选项卡

• End Point - The URL to which you want to make the request. Custom segments have to be placed between braces "{}" and defined in the Parameters section. For example, this URL https://platform.uipath.com/odata/Robots(28) can be written as https://platform.uipath.com/odata/Robots({id}), and the value of the id parameter can be provided in the Parameters section, as a UrlSegment.
• “预览 URL”- 预览“端点”字段中提供的 URL，同时会兼顾“参数”部分提供的信息。
• Enable SSL certificate verification - Check this box to verify SSL certificates when sending a request. Verification failures will result in the request being aborted.
• “超时”- 指定最长等待时间（以毫秒为单位），如果超出该时间后活动并未运行，系统便会抛出错误。默认值为 6000 毫秒（6 秒）。
• 客户端证书- 客户端证书文件的存储位置。您须提供完整路径。支持的证书编码为X.509 ，支持的扩展程序为.pfx和.p12 。它支持双向握手验证。
  备注：

  不能将路径写入引号之间。

• “客户端证书密码”- 与正在使用的客户端证书文件对应的密码。
• “请求方法”- 调用 API 时使用的请求方法。支持以下 HTTP 动词：“GET”、“POST”、“PUT”、“DELETE”、“HEAD”、“OPTIONS”、“PATCH”和“MERGE”。系统会默认选择“GET”方法。
• “身份验证”- 指定调用 API 时要使用的身份验证协议。支持的协议如下：
  • “无”- 默认选项。如果要向其发送请求的网页服务器不需要身份验证协议，则应使用此选项。
  • “简单 Http”- 如果请求的 API 使用简单的 HTTP 身份验证协议，则必须选择此选项。选中后，系统会显示另外两个字段：“用户名”和“密码”。这两个字段必须使用指定 API 的有效凭据进行填充。
  • “OAuth1”- 如果请求的 API 使用 OAuth1 协议，则必须选择此选项。选中后，系统会显示以下四个字段：“使用者密钥”、“使用者密码”、“访问令牌”和“访问令牌密码”。
  • “OAuth2”- 如果请求的 API 使用 OAuth2 协议，则必须选择此选项。选中后，系统会显示“访问令牌”字段。在响应指定 API 的另一个 HTTP 请求时，系统通常会生成此访问令牌。

参数部分

• “添加参数”- 在参数表中添加新行，且类型为“获取或发布”。如果上一行未填充内容，则不能添加新行。
• “添加标头”- 在参数表中添加新行，且类型为“Http 标头”。如果上一行未填充内容，则不能添加新行。
  备注：

  如要为一个标头添加多个值，您须使用逗号（“,”）连接这些值。

• “添加 URL 段”- 在参数表中添加新行，且类型为“URL 段”。如果上一行未填充内容，则不能添加新行。
• “删除”- 删除参数表中的选定行。如未选择行，则系统会禁用此按钮。

参数表

• “名称”- 参数、标头或 URL 段的名称。
• “值”- 参数、标头或 URL 段的值。
• “类型”- 行的类型。可用的选项如下：
  • “获取或发布”- 指明行是可在请求中使用的参数。
  • “Http 标头”- 指明在“参数”表中添加的行是在调用 API 时要发送的请求标头。
  • UrlSegment - Indicates that the line added is a fragment or the URL provided in the End point field.
    备注：

    在某些情况下，系统可能会返回一个错误，表明不能存在重复参数。此类错误可能由需要包含“密码”和“用户名”参数的身份验证请求引发。若情况如此，建议使用“正文”属性进行传递。

附件部分

• “添加附件”- 用于通过创建新行，以将文件添加到所执行的 HTTP 请求中。仅在“请求方法”设为“POST”或“PUT”时启用。
• “删除附件”- 用于在“附件”部分中删除之前添加的行。
• “名称”- 要附加的文件的名称。
• “文件路径”- 要附加的文件的完整路径。
• 类型- 指明要发送的信息类型。该字段会自动以附件填充。预览- 用于预览所创建的 HTTP 请求，并打开响应选项卡。

响应选项卡

此选项卡用于预览要纳入工作流的请求。填写所有字段并配置请求后，您可通过选择“HTTP 请求”向导中的“预览”按钮来访问该请求。或者，您也可更改该向导上部的选项卡。

此页面包含以下部分：

• “请求信息”- 此部分会显示与已执行请求相关的详细信息，具体会显示请求 URL、方法以及状态码。
• “预览响应”- 显示网页服务器的响应。
• “原始正文”- 以原始格式显示网页服务器的响应。
• “响应信息”- 显示有关网页服务器响应的详细信息，具体会显示响应状态和代码，以及受支持的内容类型标头。
• “下载资源”- 用于将所请求的资源下载到指定文件。
• “刷新”- 用于再次执行请求。

属性面板

客户端证书身份验证

• 客户端证书- 客户端证书文件的存储位置。您须提供完整路径。支持的证书编码为X.509 ，支持的扩展程序为.pfx和.p12 。它支持双向握手验证。
• 客户端证书密码- 与正在使用的客户端证书文件对应的密码。
• Enable SSL certificate verification - Verify SSL certificates when sending a request. Verification failures will result in the request being aborted. This field only supports Boolean values (True, False).
• 安全客户端证书密码 - 指定客户端证书文件的密码，以安全字符串形式表示。该字段仅支持“安全字符串”变量。

常见

• “出错时继续”- 指定在活动引发错误时是否应继续自动化操作。该字段仅支持“布尔值”（True 和 False）。默认值为 False。因此，如果该字段为空且活动引发错误，系统将停止执行项目。如果该值设为“True”，则无论出现何种错误，系统都将继续执行项目。
  备注：

  如果“Try Catch 异常处理”中包含该活动且“出错时继续”属性的值为“True”，则系统在执行项目时不会捕获任何错误。

• “显示名称”- 活动的显示名称。
• “超时(毫秒)”- 指定最长等待时间（以毫秒为单位），如果超出该时间后活动并未运行，系统便会抛出错误。默认值为 6000 毫秒（6 秒）。

输入

• AcceptFormat - The format in which to receive the web server's response. The following options are supported: ANY - the default value, XML, JSON, and CUSTOM. When choosing the CUSTOM AcceptFormat, if an Accept or accept Header parameter is present, then it will be sent as the custom accept format. If no header parameter is set, accept will get the RestSharp default value: application/json, aboveapplication/xml, text/json, text/x-json, text/javascript, text/xml.
• “请求方法”- 调用 API 时使用的请求方法。支持以下 HTTP 动词：“GET”、“POST”、“PUT”、“DELETE”、“HEAD”、“OPTIONS”、“PATCH”和“MERGE”。系统会默认选择“GET”方法。
  备注：

  HTTP 请求仅适用于 RestSharp 包版本 106.11.2 或更低版本。安装 RestSharp 版本 106.11.4 或更高版本时，它将返回错误。

• Request URL - The URL to which you want to make the request. Custom segments have to be placed between braces "{}" and defined in the Parameters section. For example, this URL https://platform.uipath.com/odata/Robots(28) can be written as https://platform.uipath.com/odata/Robots{id}, and the value of the id parameter can be provided in the URLSegments window.

其他

• “私有”- 选中后将不再以“Verbose”级别记录变量和参数的值。

OAuth1

• “使用者密钥”- 要使用的使用者密钥（如果请求的 API 是基于 OAuth1 身份验证协议）。
• “使用者密码”- 要使用的使用者密码（如果请求的 API 是基于 OAuth1 身份验证协议）。
• “OAuth1 令牌”- 在批准使用者的授权请求后要使用的访问令牌（如果请求的 API 是基于 OAuth1 身份验证协议）。
• “OAuth1 令牌密码”- 在批准使用者的授权请求后要使用的密码（如果请求的 API 是基于 OAuth1 身份验证协议）。

OAuth2

• “OAuth2 令牌”- 要使用的访问令牌（如果请求的 API 是基于 OAuth2 身份验证协议）。在响应指定 API 的另一个 HTTP 请求时，系统通常会生成此访问令牌。

选项

• 附件 - 用于将文件附加到请求。选择省略号按钮，打开“附件”窗口，然后添加所需的全部文件。
• “正文”- 请求的正文。
• “正文格式”- 正文必须采用的格式。该选项默认用“application/xml”填充。该字段支持字符串和字符串变量。
• Cookie- HTTP 请求中的 Cookie。选择省略号按钮，打开“Cookie”窗口。
• File attachments - List of attachments for the request.
• Filename for response attachment - The filename to be used for the file returned by the request.
• 标头- 用于在 HTTP 请求中添加自定义标头。选择省略号按钮，打开“标头”窗口。
• 参数- 请求参数。选择省略号按钮，打开“参数”窗口，该窗口与“参数”部分相对应。
• URL 段- 添加到端点 URL 中的自定义段，需置于大括号“{}”内。选择省略号按钮打开“URL 段”窗口。例如， https://platform.uipath.com/odata/Robots(28) URL 可写为https://platform.uipath.com/odata/Robots{id} ，而id参数的值可在URL 段窗口中提供。此字段仅支持字符串和字符串变量。

输出

• Headers - The response received from the HTTP request.
• Response attachment - The attachment saved from the response.
• Response content - The response received from the HTTP request, as a string variable.
• Response status - The status code received from the HTTP request, as an integer variable.

简单身份验证

• “密码”- 指明网页服务使用简单身份验证，并且允许输入密码。您还需添加用户名。该属性支持字符串和字符串变量。
• SecurePassword - Indicates that the web service uses secure authentication and enables you to input your secure string password. Adding a username is also required. This property supports secure string variables.
• “用户名”- 指明网页服务使用简单身份验证，并且允许输入用户名。您还需添加密码。该属性支持字符串和字符串变量。

跨平台配置

• “请求方法”- 调用 API 时使用的请求方法。支持以下 HTTP 动词：“GET”、“POST”、“PUT”、“DELETE”、“HEAD”、“OPTIONS”、“PATCH”和“MERGE”。系统会默认选择“GET”方法。
• Request URL - The URL to which you want to make the request. Custom segments have to be placed between braces "{}" and defined in the Parameters section. For example, this URL https://platform.uipath.com/odata/Robots(28) can be written as https://platform.uipath.com/odata/Robots{id}, and the value of the id parameter can be provided in the URLSegments window.
• 参数- 请求参数。选择字段以打开“字典”窗口。
• 标头- 用于在 HTTP 请求中添加自定义标头。选择字段以打开“字典”窗口。
• “正文”- 请求的正文。
• “身份验证”- 指定调用 API 时要使用的身份验证协议。支持的协议如下：
  • “无”- 默认选项。如果要向其发送请求的网页服务器不需要身份验证协议，则应使用此选项。
  • “简单 Http”- 如果请求的 API 使用简单的 HTTP 身份验证协议，则必须选择此选项。选中后，系统会显示另外两个字段：“用户名”和“密码”。这两个字段必须使用指定 API 的有效凭据进行填充。
  • OAuth1-如果请求的 API 使用 OAuth1 协议，则必须选择此选项。选中后，系统将显示另外四个字段： “使用者密钥” 、 “使用者密码” 、 “访问令牌” 、 “访问令牌密码” 。
  • “OAuth2”- 如果请求的 API 使用 OAuth2 协议，则必须选择此选项。选中后，系统会显示“访问令牌”字段。在响应指定 API 的另一个 HTTP 请求时，系统通常会生成此访问令牌。
  • 客户端证书 - 如果需要客户端证书来完成 API 调用，则必须选择此选项。如果选中，系统还会显示另外两个字段：
    • 客户端证书- 客户端证书文件的存储位置。您须提供完整路径。支持的证书编码为X.509 ，支持的扩展程序为.pfx和.p12 。它支持双向握手验证。
    • 客户端证书密码- 与正在使用的客户端证书文件对应的密码。

高级

选项

• “超时(毫秒)”- 指定最长等待时间（以毫秒为单位），如果超出该时间后活动并未运行，系统便会抛出错误。默认值为 6000 毫秒（6 秒）。
• Continue On Error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is not configured and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
• SSL certificate verification - If selected, verifies SSL certificates when sending a request. Verification failures will result in the request being aborted.
• 接受格式- 接收网页服务器响应的格式。支持以下选项： “ANY” - 默认值、 “XML” 、 “JSON”和“自定义” 。选择“自定义接受格式” 时，如果存在Accept或accept标头参数，则它将作为自定义接受格式发送。如果未设置标头参数， accept将获取 RestSharp 默认值：

  application/json, application/xml, text/json, text/x-json, text/javascript,
                          text/xml
  

• File Attachments - List of attachments for the request.
• Filename for response attachment - The filename to be used for the file returned by the request.
• “正文格式”- 正文必须采用的格式。该选项默认用“application/xml”填充。该字段支持字符串和字符串变量。
• Cookie- HTTP 请求中的 Cookie。选择字段以打开“字典”窗口。
• URL 段- 添加到端点 URL 中的自定义段，需置于大括号“{} 内”。选择字段以打开“字典”窗口。例如，URL https://platform.uipath.com/odata/Robots(28)可写为https://platform.uipath.com/odata/Robots{id} ，而id参数的值可在“字典”窗口中提供。此字段仅支持字符串和字符串变量。

输出

• Response content - The response received from the HTTP request, as a string variable.
• Response status - The status code received from the HTTP request, as an integer variable.
• Response headers - The response received from the HTTP request.
• Response attachment - The attachment saved from the response.