- Erste Schritte
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Generische Aufgabenanforderungen
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Anfragen für persönliche Arbeitsbereiche
- Prozessabfragen
- Bearbeitung von Anforderungen an die Datenaufbewahrung
- Anforderungen von Warteschlangenelementen
- Anforderungen an Warteschlangenaufbewahrungsrichtlinien
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Anforderungen für Speicher-Buckets
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen
Anleitung für die Orchestrator-API
Zeitplanabfragen
Mit der folgenden Anforderung können Sie einen Zeitplan mit dem Namen ApiTest für die Zeitzone GMT Standard Time erstellen, der alle 5 Monate sonntags ausgelöst wird.
StartStrategy
können Sie auswählen, wie Sie den Auftrag ausführen möchten.
StartStrategy
Wert |
Name |
Beschreibung |
Ordnerkontext |
---|---|---|---|
–1
|
Alle Roboter |
Führt den Auftrag einmal für jeden Roboter aus, der in der Umgebung des Prozesses vorhanden ist. |
Klassisch |
0
|
Benutzerdefinierte Roboter |
Führt den Auftrag einmal auf jedem der angegebenen Roboter aus. Um die Roboter anzugeben, schließen Sie die Roboter-IDs als Werte in
ExecutorRobots ein. Beispiel: `"ExecutorRobots" : [ {"Id" : 44881
|
Klassisch |
1
|
1 Roboter |
Führt den Auftrag auf einem dynamisch ausgewählten Roboter eines beliebigen Benutzers aus, der Zugriff auf den Ordner hat, in dem sich der Prozess befindet. Sie können den Auftrag auch so festlegen, dass er auf dem Roboter ausgeführt wird, den Sie in
MachineRobots angeben. Ein Beispiel finden Sie im folgenden Beispielanforderungstext.
|
Modern |
jede andere Zahl |
Dynamische Zuteilung |
Erstellt die angegebene Anzahl von Aufträgen und wählt dynamisch die Roboter, auf denen sie ausgeführt werden sollen, aus den verfügbaren Robotern im modernen Ordner des Prozesses oder aus den Robotern in der Umgebung für klassische Ordner aus. Für moderne Ordner können Sie mit dem Listenparameter
MachineRobots auch eine oder mehrere Maschinenvorlagen, Roboter oder sowohl Maschinenvorlagen als auch Roboter angeben. In diesem Fall stellt der Wert StartStrategy dar, wie oft der Auftrag auf jedem angegebenen Roboter oder jeder Roboter-Maschinen-Kombination ausgeführt werden soll.
Dies ist für klassische Ordner nicht möglich, und wenn angegeben, wird der Parameter
ExecutorRobots ignoriert.
|
klassisch oder modern |
Posten
https://govcloud.uipath.us/{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"
}
{
"@odata.context": "https://govcloud.uipath.us/{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://govcloud.uipath.us/{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
können Sie einen aktivierten Zeitplan mit dem Namen „API_schedule_test“ für den Prozess mit der ID 55 erstellen und außerdem benutzerdefinierte Werte für einige der Prozessparameter hinzufügen. Der Zeitplan beginnt auf allen Robotern alle fünf Minuten. Nicht-Arbeitstage bleiben unberücksichtigt.
Posten
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/ProcessSchedules
{
"Enabled": true,
"Name": "API_schedule_test",
"ReleaseId": 55,
"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
"ReleaseName": "input_output_test_DocEnv",
"PackageName": "input_output_test",
"EnvironmentName": "DocEnv",
"EnvironmentId": "7",
"StartProcessCron": "0 0/5 * 1/1 * ? *",
"StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": "Every 5 minutes",
"StartProcessNextOccurrence": null,
"StartStrategy": 0,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "af486c19-c797-48cd-b586-cfb7a12110a2",
"TimeZoneId": "Morocco Standard Time",
"TimeZoneIana": "Africa/Casablanca",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555}",
"Id": 37
}
{
"Enabled": true,
"Name": "API_schedule_test",
"ReleaseId": 55,
"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
"ReleaseName": "input_output_test_DocEnv",
"PackageName": "input_output_test",
"EnvironmentName": "DocEnv",
"EnvironmentId": "7",
"StartProcessCron": "0 0/5 * 1/1 * ? *",
"StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": "Every 5 minutes",
"StartProcessNextOccurrence": null,
"StartStrategy": 0,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "af486c19-c797-48cd-b586-cfb7a12110a2",
"TimeZoneId": "Morocco Standard Time",
"TimeZoneIana": "Africa/Casablanca",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555}",
"Id": 37
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#ProcessSchedules/$entity",
"Enabled": true,
"Name": "API_schedule_test",
"ReleaseId": 55,
"ReleaseKey": "00000000-0000-0000-0000-000000000000",
"ReleaseName": null,
"PackageName": null,
"EnvironmentName": null,
"EnvironmentId": "0",
"StartProcessCron": "0 0/5 * 1/1 * ? *",
"StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": "Every 5 minutes",
"StartProcessNextOccurrence": null,
"StartStrategy": 0,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "7ecbff8d-832d-41e1-a3ed-aee0957caffe",
"TimeZoneId": "Morocco Standard Time",
"TimeZoneIana": "Africa/Casablanca",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555,\"inOutTry\":\"2012-04-23T18:25:43.511Z\"}",
"Id": 37
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#ProcessSchedules/$entity",
"Enabled": true,
"Name": "API_schedule_test",
"ReleaseId": 55,
"ReleaseKey": "00000000-0000-0000-0000-000000000000",
"ReleaseName": null,
"PackageName": null,
"EnvironmentName": null,
"EnvironmentId": "0",
"StartProcessCron": "0 0/5 * 1/1 * ? *",
"StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
"StartProcessCronSummary": "Every 5 minutes",
"StartProcessNextOccurrence": null,
"StartStrategy": 0,
"StopProcessExpression": "",
"StopStrategy": null,
"ExternalJobKey": "7ecbff8d-832d-41e1-a3ed-aee0957caffe",
"TimeZoneId": "Morocco Standard Time",
"TimeZoneIana": "Africa/Casablanca",
"UseCalendar": false,
"StopProcessDate": null,
"InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555,\"inOutTry\":\"2012-04-23T18:25:43.511Z\"}",
"Id": 37
}