管理 API 触发器

创建 API 触发器

在文件夹中，导航到“自动化”>“触发器”>“API 触发器”。
单击“添加新触发器”。系统将显示“新建 API 触发器”窗口。
从“流程名称”下拉菜单中，为触发器选择基础流程。
“名称”字段将预先填充流程名称，后跟触发器类型，格式为 <ProcessName>_<TriggerType>。但是，如果愿意，可以为触发器名称编辑其他名称。
从“作业优先级”下拉菜单中，选择作业的优先级。默认值为“已继承”，这意味着作业优先级与为所选流程定义的优先级相同。
从“运行时类型”下拉菜单中，选择用于执行触发器启动的作业的运行时。
在“ 参数 ” 选项卡上，如果您的流程中有输入参数，请提供输入参数的值。有关输入和输出参数的更多详细信息。
从“动词”下拉菜单中，选择描述您希望作业执行的操作的选项：DELETE、GET、POST 和 PUT。
在“缩略名”字段中，输入将附加到基本 URL 的缩略名，从而为将在应用程序中使用的结果端点生成最终 URL。您可以在此字段下预览完整 URL。

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

请注意，缩略名不支持斜杠。
在“默认调用模式”下拉菜单中，选择所需的调用模式。可用选项包括：
- 异步轮询（这是默认设置，但可以更改）
- 异步触发与忽略
- 同步 (长轮询)
有关这些选项的更多信息，请参阅通过 API 触发器启动作业。
打开“ 计划结束作业执行” 开关，以选择作业终止策略。
备注：
- 即使作业在排队等待，此处指定的时间仍会按照您的要求计算。例如，如果您将某个作业计划为在下午 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 分钟的作业。
打开“计划自动禁用触发器”切换开关，然后输入要禁用触发器的日期和时间。所选时区决定了何时禁用时间触发器。
打开“在作业卡住（处于挂起或已恢复状态）时生成警示”开关，并设置完成作业所需的预期时长，以使其保持“挂起”或“已恢复”状态。可配置时长最短为一分钟。可配置时长最长为 11 天。如果作业超过配置的持续时间，则会弹出“错误”严重性警报，并使用以下文本通知您：“#process {process_number} 的 N 个作业已挂起或恢复超过 X 小时 Y 分钟”。其中：
- N - 是触发警示的作业编号；
- {process_number} - 流程标识符；
- X - 作业处于挂起或已恢复状态时超过的配置小时数；天数将转换为小时。
- Y - 作业处于挂起或已恢复状态时超过的配置分钟数。
打开“在作业已启动但尚未完成时生成警示”开关，并设置完成作业所需的预期时长。可配置的持续时间最短为一分钟，最长为十一天。如果作业超过配置的持续时间，则会弹出“错误”严重性警报，并使用以下文本通知您：“#process {process_number} 的作业已挂起或已运行超过 X 小时 Y 分钟”。其中：
- {process_number} - 流程标识符；
- X - 作业尝试完成时超出的配置小时数；天数将转换为小时。
- Y - 作业尝试完成时超出的配置分钟数。

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

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

备注：

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

“连续作业执行计数失败时禁用”的设置为 10。
“禁用触发器的宽限期（天）”的设置为 0。

仅当您使用社区版许可计划时，该选项才适用。

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

重要提示：

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

针对 API 触发器的操作

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

复制完整的 Slug 网址

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

对于具有 hw-process 缩略名的 API 触发器，URL 将如下所示：https://cloud.uipath.com/{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 '{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***"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" })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"$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"