HTTP 请求

UiPath.WebAPI.Activities.HttpClient

描述

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

注意： 如果返回的 HTTP 状态代码 (StatusCode) 为 0，则表示服务器由于某种原因未返回实际响应。 这通常表示您可能遇到了一些连接或网络问题。

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

项目兼容性

Windows - 旧版 | Windows | 跨平台

跨平台配置

• 请求方法- 调用 API 时使用的请求方法。支持以下 HTTP 动词：“GET”、“POST”、“PUT”、“DELETE”、“HEAD”、“OPTIONS”、“PATCH”和“MERGE”。系统会默认选择“GET”方法。
• 请求 URL- 要向其发出请求的 URL。自定义段必须置于大括号“{}”之间，并在参数部分进行定义。例如，此 URL“https://platform.uipath.com/odata/Robots(28)”可写为“https://platform.uipath.com/odata/Robots{id}”，而“id”参数的值可在URL 段窗口中提供。
• “参数 ” - 请求参数。 单击该字段以打开“ 字典” 窗口。
• “标头 ” - 用于在 HTTP 请求中包含自定义标头。 单击该字段以打开“ 字典” 窗口。
• 正文- 请求的正文。
• 身份验证- 指定调用 API 时要使用的身份验证协议。支持的协议如下：
  • 无- 默认选项。如果要向其发送请求的网页服务器不需要身份验证协议，则应使用此选项。
  • 简单 Http- 如果请求的 API 使用简单的 HTTP 身份验证协议，则必须选择此选项。选中后，系统会显示另外两个字段：用户名和密码。这两个字段必须使用指定 API 的有效凭据进行填充。
  • OAuth1 - 如果请求的 API 使用 OAuth1 协议，则必须选择此选项。 如果选中，将显示四个附加字段： 使用者密钥、 使用者密码、 访问令牌、 访问令牌密码。
  • OAuth2- 如果请求的 API 使用 OAuth2 协议，则必须选择此选项。选中后，系统会显示访问令牌字段。在响应指定 API 的另一个 HTTP 请求时，系统通常会生成此访问令牌。
  • 客户端证书 - 如果需要客户端证书来完成 API 调用，则必须选择此选项。如果选中，系统还会显示另外两个字段：
    • 客户端证书 - 客户端证书文件位置的完整路径。支持的证书编码为 X.509，支持的扩展程序为 .pfx 和 .p12。
    • 客户端证书密码 - 导出客户端证书文件期间设置的密码。

高级

选项

• 超时（以毫秒为单位）- 指定最长等待时间（以毫秒为单位），如果超出该时间后活动并未运行，系统便会抛出错误。默认值为 6000 毫秒（6 秒）。
• “出错时继续”- 指定在活动抛出错误时是否应继续自动化操作。该字段仅支持“布尔值”(True 和 False)。默认值为 False。因此，如果未配置该字段且活动引发错误，系统将停止执行项目。如果该值设为“True”，则无论出现何种错误，系统都将继续执行项目。
• SSL 证书验证 - 如果选中，则在发送请求时验证 SSL 证书。 验证失败将导致请求中止。
• “接受格式”- 接收网页服务器响应的格式。 支持以下选项：“ ANY ” - 默认值、“ XML ”、“ JSON ” 和“自定义”。 选择“自定义接受格式”时，如果存在Accept或accept标头参数，则它将作为自定义接受格式发送。 如果未设置标头参数，则accept将获取 RestSharp 默认值：

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

  。
• 文件附件 - 请求的附件列表。
• 响应附件 的文件名 - 请求返回的文件要使用的文件名。
• 正文格式- 正文必须采用的格式。该字段默认用“application/xml”填充。此字段仅支持字符串和字符串变量。
• Cookie - HTTP 请求中的 Cookie。 单击该字段以打开“ 字典” 窗口。
• URL 分段 - 在大括号“{}”之间添加到端点 URL 的自定义分段。 单击该字段以打开“ 字典” 窗口。 例如， https://platform.uipath.com/odata/Robots(28) URL 可以写为 https://platform.uipath.com/odata/Robots{id}，并且可以在“ 字典” 窗口中提供 id 参数的值。 此字段支持字符串和字符串变量。

输出

• 响应内容- 从 HTTP 请求收到的响应，为字符串变量形式。
• 响应状态- 从 HTTP 请求收到的状态码，为整型变量形式。
• 响应标头 - 从 HTTP 请求收到的响应。
• “响应附件 ” - 从响应中保存的附件。

Windows、Windows - 旧版配置

导入向导窗口

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

HTTP 请求向导窗口

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

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

请求生成器选项卡

• 端点- 要向其发出请求的 URL。自定义段必须置于大括号“{}”之间，并在参数部分进行定义。例如，此 URL“https://platform.uipath.com/odata/Robots(28)”可写为“https://platform.uipath.com/odata/Robots({id})”，而“id”参数的值可在URL段窗口中提供。
• 预览 URL- 预览端点字段中提供的 URL，同时会兼顾参数部分提供的信息。
• 启用 SSL 证书验证 - 选中此框可在发送请求时验证 SSL 证书。验证失败将导致请求中止。
• 超时 - 指定等待时间（以毫秒为单位），如果超出该时间活动未运行，就会引发错误。默认值为 6000 毫秒（6 秒）。

• 客户端证书- 客户端证书文件的存储位置。您须提供完整路径。

  注意：不能将路径写入引号之间。
• 客户端证书密码- 与正在使用的客户端证书文件对应的密码。
• 请求方法- 调用 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 - 指示添加的行是片段或“ 端点” 字段中提供的 URL。

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

附件部分

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

响应选项卡

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

此页面包含以下部分：

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

属性面板

客户端证书身份验证

• 客户端证书 - 客户端证书文件位置的完整路径。支持的证书编码为 X.509，支持的扩展程序为 .pfx 和 .p12。
• 客户端证书密码 - 导出客户端证书文件期间设置的密码。
• 启用 SSL 证书验证 - 发送请求时验证 SSL 证书。 验证失败将导致请求中止。 此字段仅支持布尔值（True、False）。
• SecureClientCertificatePassword - 指定客户端证书文件的密码，采用安全字符串的形式。 此字段仅支持安全字符串变量。

常见

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

  注意：如果 Try Catch 异常处理中包含该活动且出错时继续属性的值为 True，则系统在执行项目时不会捕获任何错误。
• “显示名称”- 活动的显示名称。
• 超时（以毫秒为单位）- 指定最长等待时间（以毫秒为单位），如果超出该时间后活动并未运行，系统便会抛出错误。默认值为 6000 毫秒（6 秒）。

输入

• “接受 格式” - 用于接收 Web 服务器响应的格式。 支持以下选项： ANY - 默认值、 XML、 JSON和 CUSTOM。 选择“ 自定义 接受格式”时，如果存在 Accept 或 accept 标头参数，则它将作为自定义接受格式发送。 如果未设置标头参数，则 accept 将获取 RestSharp 默认值： application/json, application/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 或更高版本时，它将返回错误。
• 请求 URL- 要向其发出请求的 URL。自定义段必须置于大括号“{}”之间，并在参数部分进行定义。例如，此 URL“https://platform.uipath.com/odata/Robots(28)”可写为“https://platform.uipath.com/odata/Robots{id}”，而“id”参数的值可在URL 段窗口中提供。

其他

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

OAuth1

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

OAuth2

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

选项

• 附件- 用于将文件附加到请求。单击“省略号”按钮打开“附件”窗口，然后添加所需的全部文件。
• 正文- 请求的正文。
• 正文格式- 正文必须采用的格式。该字段默认用“application/xml”填充。此字段仅支持字符串和字符串变量。
• Cookie- HTTP 请求中的 Cookie。单击省略号按钮打开Cookie窗口。
• 文件附件- 请求的附件列表。
• 响应附件 的文件名 - 请求返回的文件要使用的文件名。
• “标头 ” - 用于在 HTTP 请求中包含自定义标头。 单击“ 省略号 ”按钮以打开“ 标头 ”窗口。
• 参数- 请求参数。单击“省略号”按钮打开参数窗口，该窗口与参数部分相对应。
• URL 段- 添加到端点 URL 中的自定义段，需置于大括号“{}”内。单击省略号按钮打开URL 段窗口。例如，此 URL“https://platform.uipath.com/odata/Robots(28)”可写为“https://platform.uipath.com/odata/Robots{id}”，而“id”参数的值可在URL 段窗口中提供。此字段仅支持字符串和字符串变量。

输出

• 标头- 从 HTTP 请求接收到的响应。
• “响应附件 ” - 从响应中保存的附件。
• 响应内容- 从 HTTP 请求收到的响应，为字符串变量形式。
• 响应状态- 从 HTTP 请求收到的状态码，为整型变量形式。

简单身份验证

• 密码- 指明网页服务使用简单身份验证，并且允许输入密码。您还需添加用户名。该属性支持字符串或字符串变量。
• 安全密码- 指明网页服务使用安全身份验证，并且允许输入安全字符串密码。您还需添加用户名。此属性支持字符串变量。
• 用户名- 指明网页服务使用简单身份验证，并且允许输入用户名。您还需添加密码。该属性支持字符串或字符串变量。