管理 API 触发器

创建和管理 API 触发器，用于启动自动化流程以响应 API 调用。

创建 API 触发器

1. 在文件夹中，导航到“自动化” > “触发器” > “API 触发器” 。
2. 选择“添加新触发器” 。系统将显示“新建 API 触发器”窗口。
3. 从“流程名称”下拉菜单中，为触发器选择基础流程。
4. 在“名称”字段中，为触发器添加一个名称，以方便识别。
5. 从“作业优先级” 下拉菜单中，选择作业的优先级。 默认值为Inherited ，这意味着作业优先级与为选定流程定义的优先级相同。
6. From the Runtime type drop-down menu, select the runtime used to execute the jobs that are launched by the trigger.
7. 在“参数”选项卡上，如果您的流程中有输入参数，请提供输入参数的值。有关输入和输出参数的更多详细信息。
8. 从“动词”下拉菜单中，选择描述您希望作业执行的操作的选项： DELETE 、 GET 、 POST和PUT 。
9. 在“缩略名”字段中，输入将附加到基本 URL 的缩略名，从而为将在应用程序中使用的结果端点生成最终 URL。您可以在此字段下预览完整 URL。

默认缩略名为 ${Process_Name}，但您可以自定义缩略名，以确保其在租户级别的唯一性。

请注意，它不支持斜杠。10.在“默认调用模式”下拉菜单中，选择所需的调用模式。可用选项包括：

• 异步轮询（默认设置，但可以更改）
• 异步触发与忽略
• 同步 (长轮询)

有关这些选项的更多信息，请参阅“通过 API 触发器启动作业”。

11. 打开“计划结束作业执行”开关，以选择作业终止策略。

备注：

• 即使作业在排队等待，此处指定的时间仍会按照您的要求计算。例如，如果您将某个作业计划为在下午 1 点运行，并将其设置为在 20 分钟后停止，则即使该作业一直停留在队列中，直到下午 1:15 才开始，也会在下午 1:20 停止。
• 为手动启动的作业保留触发器的“计划结束作业执行”选项。例如，假设您创建了触发器 T1 并激活了以下作业结束计划：
• 计划作业执行结束：10 分钟后停止作业
• 如果作业未停止，则计划自动“终止”：2 分钟后终止作业 在“自动化”>“触发器”页面上，当您单击触发器 T1 的“立即开始作业”时，会打开“开始作业”页面，其中已应用了您在创建触发器时配置的作业结束计划。

此外，如果您计划在 2 小时后停止“待处理”或“正在运行”的作业，并配置为在 3 小时后终止同一作业，则该作业将在 5 小时后终止。发生这种情况是因为，首先，系统会向 Orchestrator 发送信号，表明作业确实在 2 小时后停止。Orchestrator 收到信号后，终止作业操作将在 3 小时内触发，因此总共需要 5 小时。

• 从下拉列表中选择“停止- 在作业一直处于“待处理”或“正在运行”状态后经过已定义的时间间隔后尝试正常结束执行（将时间设置为最短 1 分钟、最长 10 天零 23 小时） 59 分钟）；

示例：Orchestrator 将尝试停止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。

• 从下拉列表中选择“终止” - 从作业一直处于“待处理”或“正在运行”状态以来，经过已定义的时间间隔后尝试强制结束执行（将时间设置为最短 1 分钟，最长 10 天零 23 小时） 59 分钟）；

示例：Orchestrator 将尝试终止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。

• 从下拉列表中选择“停止”，然后启用“如果作业未停止，则终止作业”选项 - 自作业一直处于“待处理”或“正在运行”状态以来，在定义的时间间隔过后尝试正常结束执行，然后尝试强制终止作业在作业一直处于“正在停止”状态以来，已经过定义的时间间隔后结束作业（将时间设置为最短 1 分钟，最长 10 天 23 小时 59 分钟）。

示例：Orchestrator 将尝试停止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。如果无法终止，Orchestrator 将尝试终止处于“正在停止”状态至少 20 分钟的作业。

12. 打开“计划自动禁用触发器”切换开关，然后输入要禁用触发器的日期和时间。所选时区决定了何时禁用时间触发器。

13. 打开“在作业卡住（处于挂起或已恢复状态）时生成警示”开关，并设置完成作业所需的预期时长，以使其保持“挂起”或“已恢复”状态。可配置时长最短为一分钟。可配置时长最长为 11 天。如果作业超过配置的持续时间，则会弹出“错误”严重性警报，并使用以下文本通知您：“#process {process_number} 的 N 个作业已挂起或恢复超过 X 小时 Y 分钟” ",其中：

    • N - 是触发警示的作业编号；
    • {process_number} - 流程标识符；
    • X - 作业处于挂起或已恢复状态时超过的配置小时数；天数将转换为小时。
    • Y - 作业处于挂起或已恢复状态时超过的配置分钟数。

14. 打开“在作业已启动但尚未完成时生成警示”开关，并设置完成作业所需的预期时长。可配置的持续时间最短为一分钟，最长为十一天。如果作业超过配置的持续时间，则会弹出“错误”严重性警报，并使用以下文本通知您：“#process {process_number} 的作业已挂起已运行超过 X 小时 Y 分钟”。 ",其中：

    • {process_number} - 流程标识符；
    • X - 作业尝试完成时超出的配置小时数；天数将转换为小时。
    • Y - 作业尝试完成时超出的配置分钟数。

15. 如果您想控制在作业失败后何时禁用触发器，请打开“设置基于执行的触发器禁用” 开关。此开关会显示两个选项：

    选项	描述
    连续作业执行计数失败时禁用	在达到您为此设置选择的失败执行次数后，将禁用触发器。您可以选择 0 到 100 之间的值。默认值为 0，这意味着触发器永远不会被禁用。停止的作业不计入此值。
    禁用触发器的宽限期 (天)	作业首次失败后禁用触发器之前要等待的天数。您可以选择 0 到 30 之间的值。默认值为 0，这意味着当当天达到上述字段中设置的作业执行次数时，系统将禁用触发器。

备注：

如果为基础流程选择 Cloud - Serverless Runtime，则系统会自动启用“将基于执行的触发器设置为禁用”选项，并具有以下默认值（这些字段为只读）：

• “连续作业执行计数失败时禁用”的设置为 10。
• 禁用触发器的宽限期（天）设置为 0。仅当您参加社区许可计划时，才会适用此期限。

16. 要保持配置用于启动作业（步骤 7）的相同用户-计算机上下文，请选中“在作业恢复时保持用户/计算机分配”复选框。这可优化您的许可证和资源使用情况。

重要提示：

• 租户级执行设置适用于 API 触发器。
• 每个租户最多可以创建 1.000 个 API 触发器。

为智能体创建 API 触发器

备注：

功能可用性取决于您使用的云产品。有关详细信息，请参阅功能可用性页面。

1. 在文件夹中，导航到“自动化” > “触发器” > “API 触发器” 。
2. 选择“添加新触发器” 。系统将显示“新建 API 触发器”窗口。
3. 从“流程名称”下拉菜单中，为触发器选择基础流程。
4. 在“名称”字段中，为触发器添加一个名称，以方便识别。
5. 从“动词”下拉菜单中，选择描述您希望作业执行的操作的选项： DELETE 、 GET 、 POST和PUT 。
6. 在“缩略名”字段中，输入将附加到基本 URL 的缩略名，从而为将在应用程序中使用的结果端点生成最终 URL。您可以在此字段下预览完整 URL。

默认缩略名为 ${Process_Name}，但您可以自定义缩略名，以确保其在租户级别的唯一性。

请注意，缩略名不支持斜杠。

7. 在“默认调用模式”下拉菜单中，选择所需的调用模式。可用选项包括：
   • 异步轮询（默认设置，但可以更改）
   • 异步触发与忽略
   • 同步 (长轮询)

有关这些选项的更多信息，请参阅“通过 API 触发器启动作业”。

8. 打开“计划结束作业执行”开关，以选择作业终止策略。

备注：

• 即使作业在排队等待，此处指定的时间仍会按照您的要求计算。例如，如果您将某个作业计划为在下午 1 点运行，并将其设置为在 20 分钟后停止，则即使该作业一直停留在队列中，直到下午 1:15 才开始，也会在下午 1:20 停止。
• 为手动启动的作业保留触发器的“计划结束作业执行”选项。例如，假设您创建了触发器 T1 并激活了以下作业结束计划：
• 计划作业执行结束：10 分钟后停止作业
• 如果作业未停止，则计划自动“终止”：2 分钟后终止作业 在“自动化”>“触发器”页面上，当您单击触发器 T1 的“立即开始作业”时，会打开“开始作业”页面，其中已应用了您在创建触发器时配置的作业结束计划。

此外，如果您计划在 2 小时后停止“待处理”或“正在运行”的作业，并配置为在 3 小时后终止同一作业，则该作业将在 5 小时后终止。发生这种情况是因为，首先，系统会向 Orchestrator 发送信号，表明作业确实在 2 小时后停止。Orchestrator 收到信号后，终止作业操作将在 3 小时内触发，因此总共需要 5 小时。

• 从下拉列表中选择“停止- 在作业一直处于“待处理”或“正在运行”状态后经过已定义的时间间隔后尝试正常结束执行（将时间设置为最短 1 分钟、最长 10 天零 23 小时） 59 分钟）；

示例：Orchestrator 将尝试停止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。

• 从下拉列表中选择“终止” - 从作业一直处于“待处理”或“正在运行”状态以来，经过已定义的时间间隔后尝试强制结束执行（将时间设置为最短 1 分钟，最长 10 天零 23 小时） 59 分钟）；

示例：Orchestrator 将尝试终止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。

• 从下拉列表中选择“停止”，并启用“如果作业未停止，则计划自动‘终止’”选项 - 这会在作业一直处于“待处理”或“正在运行“状态以来经过已定义的时间间隔后尝试正常结束执行，然后在作业一直处于“正在停止”状态以来经过已定义的时间间隔后尝试强制结束作业（可设置的最短时间为 1 分钟，最长时间为 10 天 23 小时 59 分钟）。

示例：Orchestrator 将尝试停止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。如果无法终止，Orchestrator 将尝试终止处于“正在停止”状态至少 20 分钟的作业。

9. 打开“在作业已启动但尚未完成时生成警示”开关，并设置完成作业所需的预期时长。可配置的持续时间最短为一分钟，最长为十一天。如果作业超过配置的持续时间，则会弹出“错误”严重性警报，并使用以下文本通知您：“#process {process_number} 的作业已挂起已运行超过 X 小时 Y 分钟”。 ",其中：
   • {process_number} - 流程标识符；
   • X - 作业尝试完成时超出的配置小时数；天数将转换为小时。
   • Y - 作业尝试完成时超出的配置分钟数。
10. 在“执行目标”选项卡中，使用“帐户”下拉列表，选择会动态分配帐户的“任何用户/机器人帐户”，或者从列表中选择一个特定帐户。
11. 如果包具有输入和/或输出参数，这些参数将显示在“输入”和“输出”选项卡下的“runtime 参数”部分。参数值继承自包，但您可以根据需要对其进行编辑。要在参数和基础 JSON 模式视图之间切换，请选择“JSON 模式”。

图 1. JSON 架构

为 Maestro BPMN 流程创建 API 触发器

备注：

功能可用性取决于您使用的云产品。有关详细信息，请参阅功能可用性页面。

1. 在文件夹中，导航到“自动化” > “触发器” > “API 触发器” 。
2. 选择“添加新触发器” 。系统将显示“新建 API 触发器”窗口。
3. 从“流程名称”下拉菜单中，为触发器选择基础流程。
4. 在“名称”字段中，为触发器添加一个名称，以方便识别。
5. 从“动词”下拉菜单中，选择描述您希望作业执行的操作的选项： DELETE 、 GET 、 POST和PUT 。
6. 在“缩略名”字段中，输入将附加到基本 URL 的缩略名，从而为将在应用程序中使用的结果端点生成最终 URL。您可以在此字段下预览完整 URL。

默认缩略名为 ${Process_Name}，但您可以自定义缩略名，以确保其在租户级别的唯一性。

请注意，缩略名不支持斜杠。

7. 在“默认调用模式”下拉菜单中，选择所需的调用模式。可用选项包括：
   • 异步轮询（默认设置，但可以更改）
   • 异步触发与忽略
   • 同步 (长轮询)

有关这些选项的更多信息，请参阅“通过 API 触发器启动作业”。

8. 打开“计划结束作业执行”开关，以选择作业终止策略。
   备注：

   • 即使作业在排队等待，此处指定的时间仍会按照您的要求计算。例如，如果您将某个作业计划为在下午 1 点运行，并将其设置为在 20 分钟后停止，则即使该作业一直停留在队列中，直到下午 1:15 才开始，也会在下午 1:20 停止。
   • 为手动启动的作业保留触发器的“计划结束作业执行”选项。例如，假设您创建了触发器 T1 并激活了以下作业结束计划：
   • 计划作业执行结束：10 分钟后停止作业
   • 如果作业未停止，则计划自动“终止”：2 分钟后终止作业 在“自动化”>“触发器”页面上，当您单击触发器 T1 的“立即开始作业”时，会打开“开始作业”页面，其中已应用了您在创建触发器时配置的作业结束计划。

此外，如果您计划在 2 小时后停止“待处理”或“正在运行”的作业，并配置为在 3 小时后终止同一作业，则该作业将在 5 小时后终止。发生这种情况是因为，首先，系统会向 Orchestrator 发送信号，表明作业确实在 2 小时后停止。Orchestrator 收到信号后，终止作业操作将在 3 小时内触发，因此总共需要 5 小时。

• 从下拉列表中选择“停止- 在作业一直处于“待处理”或“正在运行”状态后经过已定义的时间间隔后尝试正常结束执行（将时间设置为最短 1 分钟、最长 10 天零 23 小时） 59 分钟）；

示例：Orchestrator 将尝试停止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。

• 从下拉列表中选择“终止” - 从作业一直处于“待处理”或“正在运行”状态以来，经过已定义的时间间隔后尝试强制结束执行（将时间设置为最短 1 分钟，最长 10 天零 23 小时） 59 分钟）；

示例：Orchestrator 将尝试终止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。

• 从下拉列表中选择“停止”，并启用“如果作业未停止，则计划自动‘终止’”选项 - 这会在作业一直处于“待处理”或“正在运行“状态以来经过已定义的时间间隔后尝试正常结束执行，然后在作业一直处于“正在停止”状态以来经过已定义的时间间隔后尝试强制结束作业（可设置的最短时间为 1 分钟，最长时间为 10 天 23 小时 59 分钟）。

示例：Orchestrator 将尝试停止一直处于“待处理”或“正在运行”状态至少 10 分钟的作业。如果无法终止，Orchestrator 将尝试终止处于“正在停止”状态至少 20 分钟的作业。

9. 打开“在作业已启动但尚未完成时生成警示”开关，并设置完成作业所需的预期时长。可配置的持续时间最短为一分钟，最长为十一天。如果作业超过配置的持续时间，则会弹出“错误”严重性警报，并使用以下文本通知您：“#process {process_number} 的作业已挂起已运行超过 X 小时 Y 分钟”。 ",其中：
   • {process_number} - 流程标识符；
   • X - 作业尝试完成时超出的配置小时数；天数将转换为小时。
   • Y - 作业尝试完成时超出的配置分钟数。
10. 在“执行目标”选项卡中，使用“帐户”下拉列表，选择会动态分配帐户的“任何用户/机器人帐户”，或者从列表中选择一个特定帐户。
11. 如果包具有输入和/或输出参数，这些参数将显示在“输入”和“输出”选项卡下的“runtime 参数”部分。参数值继承自包，但您可以根据需要对其进行编辑。要在参数和基础 JSON 模式视图之间切换，请选择“JSON 模式”。

图 2. JSON 架构

针对 API 触发器的操作

API 触发器页面允许您执行每个触发器的上下文菜单中的多个操作：

备注：

在本节提供的示例中， 6ea73196-ca89-446c-81e1-5279bdd36dc2字母数字标识符是 API 触发器所在文件夹的文件夹密钥。Orchestrator API 使用标识符作为/Folders端点中Key参数的值。

复制完整的 Slug 网址

复制要在第三方应用程序中使用的 URL。

对于具有 hw-process 缩略名的 API 触发器，URL 将如下所示：{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process

编辑

更改所选 API 触发器的属性。

复制 Slug

以合适的格式复制缩略名，以便在命令行或现有代码中使用。可用选项包括：

复制为 curl (bash) - 对于具有hw-process缩略名的 API 触发器，该触发器将如下所示：

curl '{baseURL_orchestrator}/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process'  -X 'POST'  -H 'Content-Type: application/json'  -H 'Authorization: Bearer ***INSERT_YOUR_TOKEN***'

复制为 curl (cmd) - 对于具有hw-process缩略名的 API 触发器，该触发器将如下所示：

curl "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ^ -X "POST" ^ -H "Content-Type: application/json" ^ -H "Authorization: Bearer ***INSERT_YOUR_TOKEN***"

复制为 fetch - 对于具有hw-process缩略名的 API 触发器，该触发器将如下所示：

fetch("https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process", { headers: { Authorization: "Bearer ***INSERT_YOUR_TOKEN***", "Content-Type": "application/json" }, "method": "POST" })

复制为 PowerShell - 对于具有hw-process缩略名的 API 触发器，该触发器将如下所示：

$headers = @{ "method"="POST" "Authorization" = "Bearer ***INSERT_YOUR_TOKEN***" } Invoke-WebRequest -UseBasicParsing -Uri "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ` -Headers $headers ` -ContentType "application/json"

启用

启用以前禁用的 API 触发器。

禁用

禁用已启用的 API 触发器。

删除

删除选定的 API 触发器。删除 API 触发器等同于删除生成的端点。根据特定场景，您可采取以下行为：

已开始的作业

如果在删除基于与已删除 API 触发器关联的流程的作业时，该作业已经开始，则该作业将一直执行直至完成。

开始新的作业

由于 URL 不再可用，因此尝试根据与已删除 API 触发器关联的流程启动作业会导致 404 错误。

编辑流程

如果您编辑至少由一个 API 触发器使用的流程，则会刷新触发器并应用一组新的流程属性。

跨域资源共享

您可以使用租户设置的“常规”选项卡上的“API 触发器的 CORS 允许列表”选项，将域添加到传入流量的允许列表。

对于从浏览器（即不是从服务器）向 Orchestrator 发出 HTTP 请求的浏览器应用程序来说，这是必要项。未能将域列入白名单可能会导致 CORS 策略错误，您可以在开发者控制台中看到该错误。

如果要将更多域列入允许列表，请使用逗号或按 Enter 键将它们分开。

API 定义

此页面显示您已创建的 API 触发器的 Swagger 定义（按文件夹分组）及其输出。除此之外，它还允许您执行与这些触发器相关的作业。

单击“API 触发器”页面上的“API 定义”按钮或访问 {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/t/swagger/index.html。

图 3. “API 触发器”页面

在个人工作区和共享文件夹中，带有 API 触发器的租户的 API 定义如下所示：

图 4. 租户的 API 定义