- Erste Schritte
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- App-Aufgabenanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Anforderungen für generische Aufgaben
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Anforderungen für persönliche Arbeitsbereiche
- Prozessabfragen
- Bearbeitung von Anforderungen an die Datenaufbewahrung
- Anforderungen von Warteschlangenelementen
- Queue retention policy requests
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Anforderungen für Speicher-Buckets
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Anforderungen für Videoaufzeichnungen
- Webhook-Abfragen
Orchestrator API specification notes, including the OpenAPI 3.0 update and the deprecation timeline for the previous Swagger 2.0 specification.
The Orchestrator default API specification is compliant with OpenAPI 3.0. The previous specification (V20, based on Swagger 2.0) is deprecated and remains available for a limited time for backward compatibility, see Deprecation timeline below for exact dates. After you migrate to the new specification, all regenerated API clients based on the new JSON definition will have to be readjusted.
If you plan on integrating our APIs with your client, you need to be aware of the possible updates and changes that may happen to the API specification, JSON schemas, or API endpoints.
The following list provides information and recommendations regarding API specification changes. If you have further questions, contact our support team.
Zeitachse der Einstellung
| Delivery model | Veraltet | entfernt |
|---|---|---|
| Automation Cloud | August 2026. | September 2026 |
| Automation Suite | 2.2610 release | 2.2610 release |
Informationen und Empfehlungen zu Swagger-Änderungen
- Die im Swagger-JSON-Dokument dargestellte JSON-API-Beschreibung kann sich jederzeit ändern. Es wird jedoch dieselbe zugrunde liegende API beschrieben, um die Abwärtskompatibilität sicherzustellen.
- Die Swagger-Schnittstelle und die entsprechende JSON werden basierend auf den aktuellen Endpunkten generiert, und wir veröffentlichen immer die neueste Version. Um die Abwärtskompatibilität zu gewährleisten, unterstützen wir dieselbe Anforderungsstruktur.
- Als Alternative zu laufzeitgenerierten API-Clients verwenden Sie API-Clients mit fester oder Kompilierzeit. Dadurch wird die Abhängigkeit reduziert und größere Automatisierungsaktualisierungen verhindert, falls sich die API- oder Swagger-Definition ändert.
- Als veraltet markierte Elemente sind für eine begrenzte Zeit verfügbar. Danach werden die Elemente aus der Swagger-Definition und der JSON-API entfernt.
- Immer wenn sich bestimmte APIs intern ändern, wird eine neue Swagger-API-Version veröffentlicht. Die API-Versionsnummer hat keinen Einfluss auf die Verwendung der Client-API. Wir empfehlen, sich nicht auf die API-Versionsverwaltung zu verlassen.
API-Beispiele
Die Beispiele im vorhandenen Orchestrator-Referenzdokument beschreiben komplexe Szenarien und Endpunkte.
Sie können alle verfügbaren APIs in der Swagger-JSON sehen, die die neuesten Updates enthält.