Orchestrator API 指南

适用平台：

上次更新日期 2025年4月8日

计划请求

启动具有动态机器人分配功能的计划

以下请求使您能够在 GMT 标准时区创建名为 ApiTest 的计划，该计划每 5 个月在星期日触发。

StartStrategy 参数用于选择作业的运行方式。

StartStrategy 的可能值

值	名称	描述	文件夹上下文
`-1`	所有机器人	为流程环境中存在的每个机器人运行一次作业。	传统
`0`	自定义机器人	在每个指定的机器人上运行一次作业。要指定机器人，请在 `ExecutorRobots`中包含机器人 ID 作为值。例如，“ExecutorRobots”：[ {“Id”：44881	传统
`1`	1 个机器人	在有权访问流程所在文件夹的任何用户的动态选择的机器人上运行作业。您还可以将作业设置为在 `MachineRobots`中指定的机器人上运行。有关示例，请参阅下面的示例请求正文。	现代
任何其他号码	动态分配	创建指定数量的作业，并从流程的新式文件夹中的可用机器人或传统文件夹环境中的机器人中动态选择要在其上运行作业的机器人。对于新式文件夹，您还可以使用列表参数 `MachineRobots`指定一个或多个计算机模板、机器人，或同时指定计算机模板和机器人。在本例中， `StartStrategy` 值表示在每个指定的机器人或机器人-计算机组合上执行作业的次数。这不适用于传统文件夹，如果指定，则忽略 `ExecutorRobots` 参数。	经典或现代

发布

https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/ProcessSchedules

请求标头

密钥	值
授权	承载

请求正文

{
  "Name":"ApiTest",
  "ReleaseId":75,
  "ReleaseName":"BlankProcess_DocEnv",
  "StartProcessCron":"0 0 0 ? 1/5 SUN *",
  "StartProcessCronDetails":"{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
  "StartStrategy":15,
  "ExecutorRobots":[],
  "MachineRobots":[
    {
      "MachineId":null,
      "MachineName":null,
      "RobotId":44880,
      "RobotUserName":"acme\\john.doe"
    }
  ],
  "StopProcessExpression":"",
  "StopStrategy":null,
  "TimeZoneId":"GMT Standard Time"
}{
  "Name":"ApiTest",
  "ReleaseId":75,
  "ReleaseName":"BlankProcess_DocEnv",
  "StartProcessCron":"0 0 0 ? 1/5 SUN *",
  "StartProcessCronDetails":"{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
  "StartStrategy":15,
  "ExecutorRobots":[],
  "MachineRobots":[
    {
      "MachineId":null,
      "MachineName":null,
      "RobotId":44880,
      "RobotUserName":"acme\\john.doe"
    }
  ],
  "StopProcessExpression":"",
  "StopStrategy":null,
  "TimeZoneId":"GMT Standard Time"
}

注意：要确定 TimeZoneId 参数的正确值，请向 /odata/Settings/UiPath.Server.Configuration.OData.GetTimezones 端点提出 GET 请求。在响应中，请找到您所在时区的条目，然后复制 Value 字段中的字符串。然后，在创建计划时，将该字符串作为请求正文中的 TimeZoneId 参数的值。

响应代码

200 OK

响应正文

{
    "@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#ProcessSchedules/$entity",
    "Enabled": true,
    "Name": "ApiTest",
    "ReleaseId": 75,
    "ReleaseKey": "00000000-0000-0000-0000-000000000000",
    "ReleaseName": null,
    "PackageName": null,
    "EnvironmentName": null,
    "EnvironmentId": "0",
    "StartProcessCron": "0 0 0 ? 1/5 SUN *",
    "StartProcessCronDetails": "{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
    "StartProcessCronSummary": null,
    "StartProcessNextOccurrence": null,
    "StartStrategy": 15,
    "StopProcessExpression": "",
    "StopStrategy": null,
    "ExternalJobKey": "8cda4b35-e835-445b-b477-1ea0961d62e5",
    "TimeZoneId": "GMT Standard Time",
    "TimeZoneIana": "Europe/London",
    "UseCalendar": false,
    "StopProcessDate": null,
    "InputArguments": "{}",
    "Id": 43
}{
    "@odata.context": "https://<customURL>.dedicated.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#ProcessSchedules/$entity",
    "Enabled": true,
    "Name": "ApiTest",
    "ReleaseId": 75,
    "ReleaseKey": "00000000-0000-0000-0000-000000000000",
    "ReleaseName": null,
    "PackageName": null,
    "EnvironmentName": null,
    "EnvironmentId": "0",
    "StartProcessCron": "0 0 0 ? 1/5 SUN *",
    "StartProcessCronDetails": "{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
    "StartProcessCronSummary": null,
    "StartProcessNextOccurrence": null,
    "StartStrategy": 15,
    "StopProcessExpression": "",
    "StopStrategy": null,
    "ExternalJobKey": "8cda4b35-e835-445b-b477-1ea0961d62e5",
    "TimeZoneId": "GMT Standard Time",
    "TimeZoneIana": "Europe/London",
    "UseCalendar": false,
    "StopProcessDate": null,
    "InputArguments": "{}",
    "Id": 43
}

使用输入参数值启动计划

通过以下对 /odata/ProcessSchedules 端点的 POST 请求，您可以在 ID 为 55 的流程上创建名称为“API_schedule_test”的已启用计划，同时还可以为某些流程的参数添加自定义值。该计划每五分钟在所有可用的机器人上启动，并且不考虑非工作日。

注意：全部输入参数的 JSON 表示不得超过 10,000 个字符，包括参数名称、所有转义字符、空格、方括号和参数值。

发布