Hier lesen

Hinweise zur Orchestrator-API-Spezifikation, einschließlich der Aktualisierung von OpenAPI 3.0 und der Zeitleiste der veralteten Elemente für die vorherige Swagger-2.0-Spezifikation.

Wichtig:

Die Standard-API-Spezifikation des Orchestrator ist mit OpenAPI 3.0 kompatibel. Die vorherige Spezifikation (V20, basierend auf Swagger 2.0) ist veraltet und bleibt für eine begrenzte Zeit für die Abwärtskompatibilität verfügbar. Genaue Daten finden Sie unten in der Zeitleiste der veralteten Elemente. Nachdem Sie zur neuen Spezifikation migriert sind, müssen alle neu generierten API-Clients, die auf der neuen JSON-Definition basieren, neu angepasst werden.

Wenn Sie unsere APIs in Ihren Client integrieren möchten, müssen Sie sich der möglichen Aktualisierungen und Änderungen bewusst sein, die an der API-Spezifikation, den JSON-Schemas oder den API-Endpunkten auftreten können.

Die folgende Liste enthält Informationen und Empfehlungen zu Änderungen der API-Spezifikation. Wenn Sie weitere Fragen haben, wenden Sie sich an unser Support-Team.

Zeitachse der Einstellung

Bereitstellungsmodell	Veraltet	entfernt
Automation Cloud	August 2026.	September 2026
Automation Suite	2.2610	2.2610

Informationen und Empfehlungen zu Swagger-Änderungen

1. 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.
2. 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.
3. 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.
4. 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.
5. 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.