API-Referenzen

Auf die Orchestrator-API-Swagger-Definition kann je nach Bereitstellungstyp wie folgt zugegriffen werden:

• On-Premise – fügen Sie das folgende Suffix hinzu: /swagger/index.html zu Ihrer Orchestrator-URL. Beispiel: https://myOrchestrator.com/swagger/index.html.
• Automation Cloud – Fügen Sie den Konto- und Mandantennamen sowie das Suffix orchestrator_/swagger/index.html zur URL hinzu. Beispiel: https://cloud.uipath.com/{account_logical_name}/{tenant_name}/orchestrator_/swagger/index.html.
  Find your {account_logical_name} and {tenant_name} in the API Access page of your Automation Cloud account.
• Automation Suite – Fügen Sie den Organisationsnamen, den Mandantennamen und das Suffix orchestrator_/swagger/index.html zu Ihrer Automation Suite Orchestrator-URL hinzu, und zwar gemäß der Syntax: https://AutomationSuiteURL/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html. Um beispielsweise auf den Swagger für eine Automation Suite-Bereitstellung von Orchestrator zuzugreifen, könnte ein möglicher Link https://myasuite.westeurope.cloudapp.azure.com/docs/DefaultTenant/swagger/index.htmlsein.
  Hinweis:

  Bitte beachten Sie, dass alle Anforderungen an Orchestrator-Endpunkte /{account_logical_name}/{tenant_name}/enthalten sollten, wenn Sie die Automation Cloud verwenden.

  Wenn Sie die Automation Suite verwenden, sollten alle Anforderungen an Orchestrator-Endpunkte /{organization_name}/{tenant_name}/enthalten.

Die API, die Sie in Swagger sehen, ist direkt von der von Ihnen verwendeten Orchestrator-Instanz abhängig. Um Anfragen direkt in der Swagger-Dokumentation starten zu können, brauchen Sie sich nur auf einer anderen Registerkarte bei Orchestrator anzumelden. Diese Funktion ist ab Version 2017.1 verfügbar.

Die hierin enthaltenen Anweisungen sind so aufgebaut, dass die Swagger-Dokumentation anhand von Beispielen für die komplizierteren Orchestrator-Endpunkte unterstützt wird.

Eine PowerShell-Bibliothek für die Interaktion mit Ihrer Orchestrator-Instanz finden Sie hier. Wenn Sie lieber mit Postman arbeiten möchten, steht unter diesem Link eine kleine Sammlung zur Verfügung, die durch Klicken auf die Schaltfläche In Postman ausführen importiert werden kann.

Hinweis: Ab Version 2018.1.3 können Sie in Swagger Windows-Authentifizierung für Abfragen verwenden. Bisher konnten Sie nur GET-Abfragen erstellen. POST/PUT/DELETE-Operationen wurden nicht unterstützt.