> ## Documentation Index > Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt > Use this file to discover all available pages before exploring further. # REST 端口 > 构建动态 REST 请求以使用 RESTful API Web 服务，支持所有 HTTP 方法、OAuth 2.0 以及由 ArcScript 驱动的 URL 和标头。 REST 端口支持构建动态 REST 请求以使用 RESTful API Web 服务。 ## 核心功能 * 完整的 RESTful API 客户端，支持所有 HTTP 方法（GET、POST、PUT、PATCH 和 DELETE） * 支持 Swagger 导入，可自动配置 API 并生成请求 * 支持高级身份验证，包括 OAuth 2.0、Bearer Token、AWS Signature、API Key 以及 Basic/Digest 认证 * 支持在 URL、标头和表单数据中使用 ArcScript 构建动态请求 * 灵活的正文类型，包括 raw、form-data、URL-encoded 和文件上传 ## 概述 REST 端口提供简单接口，用于构建 REST 请求的标头、授权、正文和 HTTP 方法。请求正文可以在端口配置中静态设置，也可以根据端口处理的文件动态生成。 ### 操作 此端口可以执行三种端口操作类型中的任何一种： • *触发* 按计划执行一个 request ，并且可能会生成要沿着工作流发送的文件。此操作充当工作流的起点。 • *转换* 接受来自工作流的消息作为 request 的输入并生成输出。此操作充当工作流的中间部分。 • *终结* 接受来自工作流的消息作为 request 的输入并充当工作流的终点。 ## 端口配置 ### 设置选项卡 *与端口核心配置相关的设置。* #### 配置
设置 描述
**端口 Id** 端口的静态、唯一标识符。
**端口类型** 显示端口类型及其用途的描述。
**端口描述** 一个可选字段，用于提供端口及其在流中的角色的自由格式描述。
#### 高级设置 | 设置 | 说明 | | - | - | | **本地文件方案** | 为端口输出的消息分配文件名的方案。可以在文件名中使用宏，动态包含标识符和时间戳等信息。有关更多信息，请参见[宏](#宏)。 | ### REST 详情选项卡 *与端口请求详细信息相关的设置。* ![](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_details_tab.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=beb92cf15668eab5b6bba0d918d92ef4) | 设置 | 说明 | | - | - | | **REST 详情** | 选择端口应执行的操作。（有关三个选项的详细信息，请参见[操作](#操作)。） | | **从 Swagger 导入** | 单击 ![从 Swagger 导入](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_import_from_swagger.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=df1870dcdee5497d25634d9abf8b0227) 图标可直接从 Swagger URL 导入 API 详细信息。 | | **测试** | 测试当前配置，而不创建发送到工作流下游的消息或交易。单击**测试**会打开一个包含其他选项卡的窗口（更多信息请参见[测试请求配置](#测试请求配置)）。 | | **请求 URL** | REST 请求的 HTTP 方法和目标 HTTP URL。可用方法选项包括：GET、POST、PUT、PATCH 和 DELETE。 | | **允许在 URL 中使用 ArcScript** | 勾选此项可在发出查询前对 URL 中的 ArcScript 表达式求值。选择此项后，会显示 **ArcScript 编辑器**按钮（![ArcScript 编辑器按钮](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_arcscript_editor.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=9113829cbe1ae9572316802c46a91bec)），使你能够使用 ArcScript 构建动态请求 URL。详情请参见[使用 ArcScript 编辑器构建请求 URL 和标头](#使用-arcscript-编辑器构建请求-url-和标头)。 | | **正文类型** | 随 REST 请求提供的正文内容类型。当 HTTP 方法为 GET 时不可见。有关每个选项的说明，请参见[正文](#正文)。 | | **内容类型** | 原始数据传输使用的内容类型。仅当**正文类型**设置为 `raw` 时可见。 | #### 查询参数 使用此选项卡向请求 URL 添加查询参数。以名称-值对形式提供参数，并可选择添加说明。单击**保存**以使用参数更新 URL。 ![](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_query_params.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=797c48b022a57b75bc298f1f6fcdcadf) 上图包含两组查询参数。保存端口后，`api.example.com` 请求 URL 会变为：`https://api.example.com/orders?status=pending&limit=50` 单击右侧的省略号可设置另外两个选项：**批量编辑视图**和**隐藏说明列**。 #### 认证 使用此选项卡配置 API 请求的身份验证凭据。 | 设置 | 说明 | | - | - | | **凭据** | 是否从先前配置的连接提供身份验证凭据、创建新连接，或不带身份验证发送请求。 **来自连接**：选择此项，然后从下拉列表中选择你的**连接**。**注意**：单击**连接**旁边的加号可创建新连接。 **无凭据**：选择此项可发送不带身份验证的请求。此选项适用于公共 API，或通过[查询参数](#查询参数)或[标头](#标头)处理身份验证的情况。 | | **TLS 服务器证书** | 用于验证 TLS 服务器身份的公钥证书。你可以上传证书，留空以允许底层 OS/JVM 执行证书验证，或设置为 `Any Certificate` 以信任目标服务器的身份。请谨慎使用 Any Certificate：证书用于验证你连接的是预期服务器。 | #### 标头 此选项卡使你能够添加要包含在传出 REST 请求中的 HTTP 标头列表。标头也以名称-值对指定。更多信息请参见[静态请求](#静态请求)和[动态请求](#动态请求)。单击右侧的省略号可访问另外三个选项：**批量编辑视图**、**允许在标头中使用 ArcScript** 和**显示自动生成的标头**。有关使用 ArcScript 编辑器的详细信息，请参见[使用 ArcScript 编辑器构建请求 URL 和标头](#使用-arcscript-编辑器构建请求-url-和标头)。 #### 正文 如果**正文类型**设置为 `form-data` 或 `x-www-urlencoded`，请使用**正文**选项卡提供构成请求正文的一组名称-值对（字段）。以下列表更详细地说明了每个选项。 * **none**：REST 请求不提供正文。 * **form-data**：正文以一组名称-值对（字段）提供。使用 **Name** 旁边的下拉列表选择字段类型。 * **Static**：同时提供 **Name** 和 **Value**。 * **XML**：在 UI 中提供 **Name**。**Value** 会从端口处理的输入文件中动态读取。更多信息请参见[动态表单数据](#动态表单数据)。 * **File**：每个端口可以有一个正文字段设置为 File。这会使输入文件作为请求正文发送。由于端口使用输入文件本身作为表单数据，因此 **Value** 字段会变灰。 * **Header**：使用 **Value** 字段指定从输入消息的哪个标头读取正文。 * **ArcScript**：提供的 **Value** 会渲染为 ArcScript，结果值会用于请求正文。 * **x-www-urlencoded**：正文的配置方式与 form-data 相同；但名称-值对会编码为 URL 查询字符串，而不是多部分表单数据。 * **raw**：正文设置为端口处理的输入文件内容。使用下拉列表选择正文的**内容类型**，或在**标头**部分将其指定为自定义标头。 单击右侧的省略号可访问另外两个设置：**批量编辑视图**和**显示内容类型列**。显示内容类型列后，可以按字段为 `form-data` 和 `x-www-form-urlencoded` 正文类型提供内容类型。 #### 选项 *与请求相关的其他设置。* | 设置 | 说明 | | - | - | | **为错误响应创建输出消息** | 默认情况下，当响应以不表示成功的状态码发送时，端口不会向工作流输出消息。启用此设置后，端口会为这些错误响应向工作流输出消息。稍后可以在工作流中使用 HTTP-Status-Code 标头过滤消息。 | | **压缩 HTTP 请求** | 启用此项可在发送请求之前将 PUT 或 POST 请求的正文压缩为 `gzip` 格式。传出请求中还会添加 **Content-Encoding** 标头。 | | **GET 请求正文** | 允许 GET 请求使用输入消息数据作为请求正文。 | | **HTTP 版本** | 连接到 REST 服务时使用 HTTP 1.0、1.1 还是 2.0。 | ### 高级选项卡 #### 认证 *与需要双向 TLS 身份验证时的客户端身份验证相关的设置。*
设置描述
**私有证书** TLS 客户端身份验证期间提供的私有证书。
**证书密码** 访问 TLS 客户端证书所需的密码。
#### 高级设置 \_不属于前述类别的设置。 | 设置 | 说明 | | - | - | | **分块编码** | 发送请求时是否使用 HTTP 分块传输编码。这允许应用程序按顺序发送消息的各部分（块），以避免连接过载。 | | **块大小** | 启用**分块编码**时每个块的大小（字节）。 | | **跟随 Authorization 标头** | 启用时，当重定向到不同协议或主机名时保留 Authorization 标头。 | | **输出行为** | 默认情况下，端口输出包含 `Response` 数据的消息。其他选项允许你输出 `Input Message` 以便进一步处理，或完全不输出消息。更多信息请参见[响应事件](#响应事件)。 | | **超时（秒）** | 抛出超时错误之前等待 REST 服务器响应的时长（秒）。 | | **响应标头** | 设置后，端口会将 REST 消息中的指定标头提升为已下载消息的元数据。可以用逗号分隔列表指定多个标头。 | | **保留 Cookie** | 若要在输出消息上保留 Cookie，请提供要持久化的 Cookie 名称逗号分隔列表。使用 `*` 可保留所有 Cookie。**注意**：仅保留名称-值对，不执行属性检查。用户负责确保 Cookie 不会泄露到非预期目标。 | | **启用的 TLS 协议** | 建立出站连接时支持的 TLS/SSL 协议列表。最佳实践是仅使用 TLS 协议。SSL v2 和 SSL v3 被认为存在漏洞，只有当伙伴不支持更高版本时才应使用。请注意，TLS v1.3 尚未普遍采用，如果目标服务器不支持，可能会被拒绝。 | | **处理延迟** | 放入**交易**选项卡的文件延迟处理的时长（秒）。这是一个旧版设置。最佳实践是[使用 File 端口](https://docs.kasoftware.com/26.4/self-hosted/zh/flows/designing-a-flow.md#与本地文件系统交互)管理本地文件系统，而不是使用此设置。 | #### 代理设置 这是一组用于识别连接所经代理并对其进行身份验证的设置。默认情况下，本节使用 [安全设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/security.md) 页面的 [代理设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/proxy-settings.md) 部分中的全局设置。清除此复选框可为您的端口提供特定的设置。
设置描述
**代理类型** 基于代理的防火墙使用的协议。
**代理主机** 基于代理的防火墙的名称或 IP 地址。
**代理端口** 基于代理的防火墙的 TCP 端口。
**代理用户** 用于通过基于代理的防火墙进行身份验证的用户名。
**代理密码** 用于对基于代理的防火墙进行身份验证的密码。
**身份验证方案** 保留默认值 **None** 或选择以下身份验证方案之一：**Basic**、**Digest**、**Proprietary** 或 **NTLM**。
#### 日志 *用于管理日志创建和存储的设置。*
设置 描述
**日志级别** 指定要记录在端口日志目录中的信息类型：
  • **None** - 不创建任何日志。
  • **Error** - 仅当端口遇到错误时才创建日志。
  • **Warning** - 仅当端口发出警告时才创建日志。
  • **Info** - 记录工作流的一般信息，包括任何错误和警告（如果适用）。
  • **Debug** - 记录成功和失败工作流的详细调试信息。
  • **Trace** - 记录成功和失败工作流的详细跟踪信息。
\*\*请注意：\*\***Debug** 和 **Trace** 级别的日志可能会记录敏感信息，包括消息内容和 SSL 证书。尽管连接属性（例如密码）被屏蔽了，但在与您的组织外部共享它们之前，请查看此级别的日志以避免泄漏敏感信息。
**日志文件夹结构** 指示端口根据选定的时间间隔将日志文件夹中的文件分组。例如，**Weekly** 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置告诉端口将所有日志直接保存在日志文件夹中。对于处理许多事务的端口，使用子文件夹有助于保持日志的有序性并提高性能。
**保留消息副本** 指示端口在日志目录中保存最新消息副本的切换。请注意，端口每个子文件夹只保留一个消息，并且端口在再次运行时会覆盖以前保存的消息。
#### 其他设置 *特殊设置适用于特定用例。*
设置 描述
**其他设置** 允许在以分号分隔的列表中配置隐藏的端口设置，例如 `setting1=value1;setting2=value2`。正常的端口用例和功能不需要使用这些设置。
### 自动化选项卡 #### 自动化设置 *与端口自动处理文件相关的设置。* | 设置 | 说明 | | - | - | | **发送** | 指示端口在文件准备就绪时自动发送文件的开关。 | | **重试间隔** | 端口在重试失败发送之前等待的间隔。 | | **最大次数** | 端口尝试发送消息的次数。将此值设置为 *1* 会指示端口仅进行初始发送尝试而不重试。端口会在每次尝试之间等待**重试间隔**指定的时长。 | | **接收** | 指示端口按配置间隔自动发起 REST 请求的开关。 | | **间隔** | 端口发起配置的 REST 请求的间隔。 | | **整点后的分钟数** | 小时计划的分钟偏移量。仅当上述间隔设置为\_每小时\_时适用。例如，如果此值设置为 5，自动化服务会在 1:05、2:05、3:05 等时间发送请求。 | | **时间** | 尝试发生的具体时间。仅当上述间隔设置为\_每天\_、\_每周\_或\_每月\_时适用。 | | **天** | 尝试发生的日期。仅当上述间隔设置为\_每周\_或\_每月\_时适用。 | | **分钟** | 发起请求前等待的分钟数。仅当上述间隔设置为\_分钟\_时适用。 | | **Cron 表达式** | 表示 Cron 表达式的五段字符串，用于确定尝试发生的时间。仅当上述间隔设置为\_高级\_时适用。 | | **开始日期和时间** | 自动化首次运行的日期和时间。之后的每次运行都遵循上方的间隔设置。上次和下次运行时间显示在 [自动化状态](#自动化状态) 部分中。 | #### 自动化状态 *只读摘要，显示自动化是否正在运行、上次运行的结果以及下次运行的时间。* **自动化状态**卡片显示在 **自动化** 选项卡的 **启用** 复选框下方，适用于 **接收**、**下载** 和 **定时发送** 自动化。该卡片回答三个问题：自动化是否已运行、运行是否成功，以及下次运行的时间。 在保存端口之前，当您更改 **启用** 复选框，或者更改 **间隔** 或 **开始日期和时间** 设置时，卡片会随之更新。 ![自动化选项卡上的自动化状态卡片，显示已暂停状态、失败的上次处理结果以及下次运行时间](https://docs.kasoftware.com/26.4/images/automation-status-card.png) 状态 端口自动化的当前状态。
状态 描述
**进行中** 当前有一次运行正在进行，或者其他实例已锁定该计划时段。
**空闲** 自动化正在等待下一次计划运行。
**已暂停** 端口在多次运行失败后处于[退避](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/connector-backoff.md)状态，自动化服务会跳过该端口。
**已禁用** 该端口的自动化已关闭。
上次运行时间 最近一次运行的结果。
字段 描述
**日期** 上次运行的计划时间。
**上次处理开始时间** 端口实际开始处理上次运行的时间。该时间可能略晚于计划时间。
**上次处理结果** 上次运行的结果：
  • **成功**：运行已完成并处理了数据。
  • **无数据**：运行已完成，但没有需要处理的内容，例如查询未返回任何行。
  • **失败**：运行未完成。
**上次成功时间** 最近一次成功运行的日期和时间。当上次运行失败或未返回数据时，会显示此字段，以便您了解端口已有多长时间未成功运行。
下次运行时间 **日期** 字段显示自动化下一次计划运行的时间。自动化禁用时，该字段为空。 查看详情 **已暂停** 状态、**失败** 结果和 **无数据** 结果都包含一个 **查看详情** 链接，单击后会打开一个显示完整消息的对话框： 未运行与无数据 该卡片会区分尚未运行的端口与已运行但未找到任何内容的端口。如果 **上次处理结果** 为空，说明自动化尚未运行，请检查 **下次运行时间** 和计划设置。如果结果为 **无数据**，说明自动化已按计划运行，但数据源未返回任何内容，请检查数据源中是否有新数据。 已禁用的端口 已禁用的端口会保留其上次运行信息，因此您仍可以查看其上次运行的时间及结果。只有 **下次运行时间** 会被清除。 #### 性能 *与端口资源分配相关的设置。*
设置 描述
**最大工作线程数** 此端口上处理文件时从线程池中消耗的最大工作线程数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。
**最大文件数** 分配给端口的每个线程发送的最大文件数。如果设置，则会覆盖 [高级设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/advanced-settings.md) 页面的 [性能设置](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/performance-settings.md) 部分的默认设置。
### 告警选项卡 *与配置通知相关的设置。* 在执行服务级别协议 (SLA) 之前，需要设置电子邮件通知以接收通知。默认情况下，知行之桥 使用 [通知](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/alerts.md) 选项卡上的全局设置。要为此端口使用其他设置，请启用 **覆盖全局设置**。 默认情况下，错误通知处于启用状态，这意味着每当出现错误时都会发送电子邮件。要关闭错误通知，请取消选中 **启用** 复选框。 输入 **主题**（必填）。勾选**允许在主题中使用 ArcScript**，即可在**主题**字段中使用 ArcScript。选中后会显示 **ArcScript 编辑器**按钮（![ArcScript 编辑器按钮](https://docs.kasoftware.com/26.4/images/rest_arcscript_editor.png)）。 （可选）输入以逗号分隔的**收件人**电子邮件地址列表。 ### SLA 选项卡 *与配置服务级别协议 (SLA) 相关的设置。* SLA 允许配置预期流程中端口发送或接收的数据量，并设置预期达到该数据量的时间范围。当 SLA 未达到时，知行之桥 会发送电子邮件警告用户，并将 SLA 标记为 *存在风险*，这意味着如果 SLA 未能尽快达到，则会被标记为 *已违反*。这让用户有机会介入并确定 SLA 未达到的原因，并采取适当的措施。如果在风险时间段结束时仍未达到 SLA，则会将 SLA 标记为已违反，并再次通知用户。 SLA 转换为 *存在风险* 或 *已违反* 状态时，也会写入[应用程序日志](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/activity.md#应用程序日志)，这意味着应用性能监控 (APM) 和日志采集工具也可以针对这些状态发出警报。 要定义 SLA，请启用 **预期数据量**，然后点击 **设置** 选项卡。 ![SLA Empty](https://docs.kasoftware.com/26.4/images/sla_empty.png) 以下示例显示了为端口配置的 SLA，该端口预计在周一至周五每天接收 1000 个文件。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。 ![SLA Configuration Example](https://docs.kasoftware.com/26.4/images/sla_defined.png) > [!NOTE] > > 如果有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。点击导航栏上的 **设置**，然后跳转到 **通知 > 通用通知**。点击平板和铅笔图标进行编辑，并取消勾选 **SLA 通知** 设置。 ### 交易选项卡 此选项卡列出与端口关联的所有消息。使用搜索栏查找特定消息，或单击漏斗图标应用筛选器。可以按时间、消息方向和/或状态进行筛选。 此选项卡上的选项因端口的[操作类型](#操作)而异： * 如果端口是 **Trigger**，请使用**接收文件**按钮启动工作流。 * 如果端口是 **Transform** 或 **Terminal**，请使用**上传文件**按钮将文件上传到工作流。 ## 建立连接 与任何 REST 服务建立连接都需要有效的目标 URL。服务 URL 可以支持各种 HTTP 方法，你应根据特定 Web 服务操作或要检索的数据集配置该方法。某些服务可能还需要身份验证或一组自定义标头才能使用该服务。 [认证](#认证)选项卡的**凭据**部分使你能够指定连接凭据。可从以下选项中选择： * **来自连接**：选择先前配置的 知行之桥 共享连接，或单击**连接**字段旁边的加号以[创建连接](#创建连接)。 * **无凭据**适用于公共 API，或通过[查询参数](#查询参数)或[标头](#标头)处理身份验证的情况。如果目标 URL 是 HTTPS URL，请将 **TLS 服务器证书**设置为标识服务器的公钥证书。若要隐式信任目标端点，请将该字段设置为 `Any Certificate`。 ### 创建连接 若要创建新连接，请选择**来自连接**，然后单击**连接**字段旁边的加号。 * 输入唯一的**连接名称**。 * **类型**始终设置为 REST。 * 选择你的**身份验证方案**。详情请参见[认证方式](#认证方式)。 ### 认证方式 REST 端口支持多种身份验证类型，每种类型都有自己的要求： * Basic（纯文本）、Digest（加密）和 NTLM 需要用户名-密码身份验证。这些凭据会作为请求中的标头提供给 REST 服务。 * OAuth 身份验证需要在 REST 服务的 Web 门户或开发控制台中注册应用。应用注册中要包含的 **Callback URL** 会显示在 知行之桥 UI 中。选择适用于 REST 服务的 **Grant Type**，并根据 REST 服务 Web 门户或开发控制台中显示的详细信息指定其余设置。然后单击**获取新的访问令牌**以获取与服务交互所需的令牌。检索到初始令牌后，应用程序会在令牌即将过期时刷新它们。 * Bearer Token 身份验证需要来自服务 Web 门户或开发控制台的令牌。 * AWS Signature 身份验证用于对 Amazon 进行身份验证，需要配置 Amazon 提供的凭据：**Access Key**、**Secret Key** 等。 * API Key 身份验证需要一个键值对，然后必须指定该键应作为[标头](#标头)还是作为[查询参数](#查询参数)添加。 ## 测试请求配置 你可以随时测试当前配置，而不创建发送到工作流下游的消息或交易。单击 **REST 详情**选项卡上的**测试**。下图显示了成功测试 Trigger 端口后的**响应正文**结果。 ![](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_test_tab.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=44d9ae166da38b3ebaf8b61446bf2f45) * **响应正文**：以服务器返回的格式显示 REST 请求的输出。 * **响应标头**：显示服务器返回响应中包含的响应标头。 * **消息标头**：显示测试输出中包含的消息标头。 * **日志**：显示测试日志。 Transform 和 Terminal 端口有一个**输入**窗格，其中包含 **XML**、**标头**和**日志**选项卡。 * 只有在请求正文中定义了 XML 字段时，**XML** 选项卡才会填充，如下图所示。 * 如果勾选了**允许在 URL 中使用 ArcScript** 或**允许在标头中使用 ArcScript**，请使用**标头**选项卡提供可能在脚本上下文中使用的消息标头（有关这些选项的详情，请参见[使用 ArcScript 编辑器构建请求 URL 和标头](#使用-arcscript-编辑器构建请求-url-和标头)）。如果你的请求配置了作为 `form-data` 或 `x-www-form-urlencoded` 正文元素的[标头](#标头)，标头名称会显示在此处，你可以提供用于测试的值。 * **日志**选项卡包含上次测试的结果。 ![](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_test_tab_transform.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=a3d35d4ec2514b9f4c7c3ced895b6d41) ## 静态请求 内容完全静态的 REST 请求（例如使用 HTTP GET 方法的请求）不需要输入文件，因为请求内容完全在端口 UI 中配置。只需在**标头**部分添加任何必要的名称-值对作为自定义标头，或在**正文**部分添加表单数据。 如果启用**接收自动化**，可以按计划自动发送静态请求。每个请求的响应会存储在输出文件夹中，或传递给工作流中的下一个端口。 如果启用**发送自动化**，到达端口**交易**文件夹的文件也会触发静态请求。输入文件的内容会被忽略，请求会根据 UI 中的配置发送。 ## 动态请求 REST 请求可以使用到达端口**交易**文件夹的文件中的数据动态填充。 ### 原始输入数据 如果将请求的**正文类型**设置为 `raw`，输入文件的内容会作为 REST 请求正文发送。 使用**内容类型**下拉列表设置数据的特定内容类型。如果所需内容类型未列出，可以在**标头**部分添加 *Content-Type* 标头。 ### 动态表单数据 如果将请求的**正文类型**设置为 `form-data` 或 `x-www-urlencoded`，端口会从输入文件中查找特定值来填充请求。对于设置为 `XML` 的每个名称-值对，端口会扫描输入文件，查找与字段名称相同且使用特定 XML 结构的 XML 元素，如下所示： ```xml theme={null} ``` 为适配此结构，知行软件强烈建议在工作流中的 REST 端口前使用 XML Map 端口，如[下文](#使用-xml-map-构建动态模板)所述。 当端口找到与字段名称和所需 XML 结构匹配的元素时，该元素中的值会用作名称-值对中的值。例如，如果正文中有名为 `CustomerID` 的动态字段，并且输入文件包含如下所示的 XML，则 REST 端口会将 `CustomerID` 字段的值设置为 12354。 ```xml theme={null} 12354 ``` #### 使用 XML Map 构建动态模板 将 [XML Map](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md) 端口与 REST 端口结合使用，可以轻松从其他 XML 数据结构构建动态请求。XML Map 端口会将自定义 XML 结构转换为 REST 端口期望的 XML 结构。 首先，为 REST 端口配置请求中应存在的一组动态（和静态）**正文**字段。接下来，在 知行之桥 工作流中将 XML Map 端口连接到 REST 端口，并保存工作流更改。这使 XML Map 端口能够检测 REST 端口期望在传入输入文件中出现哪些字段。 然后，在 XML Map 端口中，**目标文件**下拉列表会包含 REST 请求架构。选择它作为目标，并将**源文件**设置为自定义 XML 结构。这会填充 XML Map 映射编辑器，你可以将需要包含在 REST 请求中的数据从源结构拖放到目标结构。映射完成后，XML Map 端口会自动将与源文件匹配的文件转换为有效的 REST 请求结构。 有关使用 XML Map 端口的更多信息，请参见 [XML Map 端口文档](https://docs.kasoftware.com/26.4/self-hosted/zh/connectors/xml-map/xml-map.md)。 #### 动态标头 还可以对 ArcScript 中的表达式求值，以生成动态字符串作为标头值。有关详情和示例，请参见[标头](#标头)。 ## 使用 ArcScript 编辑器构建请求 URL 和标头 可以使用如下所示的 ArcScript 编辑器构建请求 URL 和标头。下图显示的是请求 URL 编辑器，但标头值编辑器的工作方式相同。 ![](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_arcscript_editor_pane.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=6d5ccb3d147d797a728f6fcac6535c04) 在端口配置窗格的 [REST 详情选项卡](#rest-详情选项卡)上选择**允许在 URL 中使用 ArcScript**，以允许对 ArcScript 中的表达式求值并生成动态字符串作为 URL。例如，以下 URL 包含日期和时间： `http://myendpoint.com/api?day=[_ | now('yyyyMMdd HH:mm:ss')]` 此 URL 包含用于通过发送自动化触发的查询的传入消息标头： `http://myendpoint.com/api?customer=[_message.header:customerid]` 最后，此 URL 使用从上次查询时间到当前时间戳的动态日期范围，并为第一次查询使用默认时间戳： `http://myendpoint.com/api?DateFrom=[_connector.lastruntimestamp | def('2025-01-01T00:00:00-04:00')]&DateTo=[_connector.currenttimestamp]` 可以将表达式直接添加到 URL，也可以使用编辑器编写它们。 选择**允许在标头中使用 ArcScript**，以便在发出查询前对[标头](#标头)中的 ArcScript 表达式求值。例如，以下标头包含日期和时间： `Timestamp [_ | now('yyyyMMdd')]` 此标头包含用于通过发送自动化触发的查询的客户 ID： `Customer [_message.header:customerid]` ### 消息标头 消息标头帮助 知行之桥 跟踪数据在工作流中的进度。所有已跟踪标头都会显示在编辑器的**消息标头**选项卡上，你可以在表达式中引用它们。 还可以使用编辑器中的**添加消息标头**字段并提供现有标头的名称，在表达式中包含其他消息标头。这些标头不必是已跟踪标头。 ### 保管库 使用 **Vault** 选项卡可将[全局设置保管库](https://docs.kasoftware.com/26.4/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md)中的项目添加到表达式。如果你在整个工作流的不同位置重复使用某些值，这会很有用。你可以在保管库中定义这些值，然后在表达式开头引用它们。请注意，如果希望映射使用保管库中项目的\_值\_，需要在方括号内引用它；否则编辑器会将项目\_名称\_解释为字面量。 ### 格式化器 格式化器支持操作不同 xpath 返回的值。在表达式中，格式化器用管道字符 (|) 分隔，并从左到右求值。例如： `[xpath('City') | toupper | substring(0,3)]` 在此示例中，返回 `City` xpath 的值之前，所有字符串字符都会转换为大写字符，并在结果中返回前三个字符的子字符串。例如，如果源文档有以下值： `Durham` 结果表达式返回以下内容： `DUR` 格式化器列在**格式化器**选项卡上。单击列表中的格式化器可将其添加到表达式。 ## 响应事件 可以使用响应事件与从服务器接收的响应（包括正文、标头、Cookie 等）交互，并丰富端口生成的输出消息。可以在 `Response` 事件中使用以下特殊项目。 * [\_cookies](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/introduction-to-arcscript.md#http-cookie（_cookies）) * [\_message](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/introduction-to-arcscript.md#知行之桥消息（_message）) * [\_request](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/introduction-to-arcscript.md#http-请求（_request）) * [\_response](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/introduction-to-arcscript.md#http-响应（_response）) ### 响应事件 Example 此脚本读取从服务器接收的 JSON 响应，解析出 JSON 中包含的访问令牌，并将其作为标头添加到端口创建的输出消息上： ```xml theme={null} ``` 以下步骤详细说明了发生的情况： 1. 通过 `_response.body` 访问服务器发送回端口的响应正文，并将其设置为 jsonDOMGet 操作的 text 属性。jsonDOMGet 的其他属性也会被填充，例如 `map` 属性，其中包含响应正文中所需令牌的 jsonpath。 2. 调用 jsonDOMGet 操作。如果在响应 JSON 正文中找到令牌，则会通过 `_message.header:access_token` 语法将其作为消息标头添加到端口的输出消息。如果未找到令牌，则 `access_token` 标头的值会设置为静态字符串：*Token not found!*。 在 知行之桥 中查看来自端口的消息的输出消息详细信息时，结果如下所示： ![](https://mintcdn.com/qiao/HyyOl9gYIsxaiGgh/26.4/images/rest_response_event.png?fit=max\&auto=format\&n=HyyOl9gYIsxaiGgh\&q=85\&s=1845a3cd0d81d58982016f40d5add92f) 当你需要从发送请求后服务器返回的原始 JSON 响应正文中解析数据时，这类脚本很有用。随后可以在工作流的后续端口中读取和使用该标头。 > [!TIP] > > 如果服务器使用 XML 响应，可以使用 xmlDOMGet 实现相同结果。 ## 宏 在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态地包含相关信息，例如标识符、时间戳和消息头信息，从而为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。 知行之桥 支持这些宏，它们都使用以下语法：`%Macro%`。
宏描述
ConnectorID替换为端口的 ConnectorID。
ConnectorName替换为端口名称。可用于在文件名或路径中包含连接名称，例如按生成备份文件的数据库连接标记文件。
Ext替换为端口当前正在处理的文件的文件扩展名。
Filename替换为端口当前正在处理的文件的文件名（包括扩展名）。
FilenameNoExt替换为端口当前正在处理的文件的文件名（不带扩展名）。
MessageId计算端口输出的消息的 MessageId。
RegexFilename:*pattern*将正则表达式模式应用于端口当前正在处理的文件的文件名。
Header:*headername*替换为端口正在处理的当前消息的目标消息头（`headername`）的值。
LongDate以常规格式计算系统的当前日期时间（例如，2024 年 1 月 24 日星期三）。
ShortDate以 yyyy-MM-dd 格式计算系统的当前日期时间（例如 2024-01-24）。
DateFormat:*format*以指定格式（`format`）计算系统的当前日期时间。有关可用的日期时间格式，请参阅 [示例日期格式](https://docs.kasoftware.com/26.4/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。
Vault:*vaultitem*计算指定保管库项目的值。
### 示例 某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏则需要。所有带有参数的宏都使用以下语法：`%Macro:argument%` 以下是带有参数的宏的一些示例： 还可以创建更复杂的宏，如以下示例所示： This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.