如何开始作业

作业 是指使用一个或多个机器人执行流程。 实施“开始作业” 流程可以创建新作业，以响应平台内（UiPath 平台外）发生的事件。

端点和输入

启动作业需要同时使用对多个 Orchestrator API 端点的 GET 和 POST 请求。 GET 请求用于检索对 StartJobs 端点的 POST 请求所需的输入参数值。

什么是开始作业输入参数？

要成功向“开始作业”端点发送 POST 请求，您必须至少提供“发布密钥” （流程标识符）和 “策略” （如何运行流程）作为输入参数。 根据 策略的不同，可能还有其他输入参数，包括 JobsCount 或 RobotIds 。

如何获取“开始作业”输入参数值？

要检索上述所需的输入参数（即ReleaseKey 和 Strategy ），您需要收集以下信息：

流程名称

将在成功的 “开始作业” 请求后运行的流程的名称（有关流程的更多信息，请参见 Orchestrator 指南中的 关于流程 ）。

流程名称用于检索 ReleaseKey 值。

同一流程可能有多个实例，而这些实例的发布环境会有所不同。 因此，单个 流程名称 可能会产生多个 ReleaseKey 。 如果有多个 发布键 与一个流程相关联，则 环境 名称可用于标识用户要 运行 的流程的发布键（ 环境 名称也可用于标识可用的机器人，详情请参阅下一个项目符号） 。

要同时检索给定流程的“ 版本密钥” 和“ 环境 名称”，请使用“流程名称 ”作为输入参数（例如{{base url}}/odata/Releases?$filter=ProcessKey eq {{ProcessName}} ），向“ 版本 ”端点发送 GET 请求。

• API
• 大摇大摆

• Postman

注意： 发布 GET 请求的响应还包含特定流程的输入参数要求。 有关更多信息，请参阅下面的“输入参数”。

策略

指定作业运行流程的方式；有以下三个选项：

1. 具体

流程在特定机器人上运行。

选择“特定”时， 开始作业 端点需要您要用于运行流程的机器人的机器人 ID 。

要检索 机器人 ID ，请使用 环境 名称作为输入参数（例如{{base url}}/odata/Environments?$expand=Robots&$filter=Name eq {{_EnvironmentName_}} ）向 GetEnvironments 端点发送 GET 请求。

• API
• 大摇大摆
• Postman

“获取环境”响应中可能包含 多个 机器人 ID 。要识别正确的机器人 ID ，您可以使用 机器人名称。 因此，建议您在选择 特定 时收集此信息。

2. 作业计数

该流程使用下一个可用的机器人运行指定次数。

选择 JobsCount 时，“开始作业” 端点要求 JobsCount 输入参数包含值。 因此，建议您提供一种让用户输入数字的方法。

3. 全部

该流程将在所有机器人上运行一次。

输入参数（可选）

“流程名称” 指定的流程可能需要输入参数。 这些输入参数通常映射到与应用程序对象关联的数据字段。

例如，问题管理系统可能有一个 事件 对象。 此 事件 对象包含多个数据字段，其中包含与流程相关的信息（例如， IncidentId 、 DateCreated 、 Owner等）。

如上所述，您可以通过解析 GET 版本 响应中的 Arguments 块来确定流程是否需要输入参数（请参阅下面的示例响应）。

要将这些数据字段值包含在“开始作业” POST 请求中，建议您提供选择流程所需的应用程序对象及其相关数据字段的方法。 调用作业时，连接器将检索数据字段值，并将其作为 InputArgument 参数值添加到 POST 请求中。

备注：

您还可以向 Processes_GetArgumentsByKey 端点发送 GET 请求，以确定流程是否具有必需的参数。 此端点的好处是响应仅包含参数详细信息（即输入 和 输出）。

此端点的缺点是，以及为什么不在我们的示例中使用它，它需要连接器发出额外的 GET 请求，以检索上一个 GET 版本 响应中已提供的信息（获取 ReleaseKey 值所必需的） 。

{
  "@odata.context": "https://platform.uipath.com/twTenantTest/twTenantTest/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "99587436-4ce5-480d-988c-6d7f43787a2c",
      "ProcessKey": "SupportTriage",
      "ProcessVersion": "1.0.1",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": "",
      "Name": "SupportTriage_QuickstartDemo",
      "EnvironmentId": 128912,
      "EnvironmentName": "QuickstartDemo",
      "InputArguments": null,
      "ProcessType": "Process",
      "SupportsMultipleEntryPoints": false,
      "RequiresUserInteraction": true,
      "AutoUpdate": false,
      "JobPriority": "Normal",
      "Id": 312722,
      "Arguments": {
        "Input": "[{\)\)"name\)\)":\)\)"IncidentId\)\)",\)\)"type\)\)":\)\)"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\)\)",\)\)"required\)\)":true,\)\)"hasDefault\)\)":false}]",
        "Output": null
      },
      "ProcessSettings": null
    }

示例

本节提供指向示例连接器用户界面的链接，以及每个输入字段的相应 Orchestrator API 请求。

在这些示例中，我们引入了 模板的概念。 模板表示应用程序对象和/或事件与 UiPath 流程或队列的关联。 从概念上讲，当应用程序中发生不同的事件（例如，已创建新对象、对象状态更改）时，模板使您能够调用不同的 Orchestrator 资源（例如，启动作业、添加队列项目），同时维护单个经过身份验证的连接。

• 开始作业 - 特定
• 开始作业 - JobsCount
• 开始作业 - 全部