- 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
- Webhook-Abfragen
Anleitung für die Orchestrator-API
Hier lesen
We plan to upgrade the Orchestrator Swagger version to Swagger 3.0. Currently, Orchestrator APIs are defined using Swagger 2.0. Do not worry about backwards compatibility with your existing API clients: we will ensure the API remains compatible. We recommend using your previous clients, as JSON changes do not alter them, thanks to our request structure backwards compatibility. After the Swagger 3.0 update, all regenerated API clients based on the new JSON definition will have to be readjusted.
Wenn Sie vorhaben, unsere APIs in Ihren Client zu integrieren, müssen Sie sich der möglichen Aktualisierungen und Änderungen bewusst sein, die an der Swagger-Definition, JSON-Schemas oder API-Endpunkten vorgenommen werden können.
Die folgende Liste enthält Informationen und Empfehlungen zu Swagger-Änderungen. Wenn Sie weitere Fragen haben, wenden Sie sich an unser Support-Team.
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.