Lisez-moi

Notes de spécification de l'API Orchestrator, y compris la mise à jour OpenAPI 3.0 et le calendrier d'obsolescence pour la spécification Swagger 2.0 précédente.

Important :

La spécification de l'API par défaut d'Orchestrator est conforme à OpenAPI 3.0. La spécification précédente (V20, basée sur Swagger 2.0) est obsolète et reste disponible pendant une durée limitée à des fins de rétrocompatibilité, voir Calendrier d’obsolescence ci-dessous pour les dates exactes. Après la migration vers la nouvelle spécification, il sera nécessaire de réajuster en fonction de la nouvelle définition JSON l’ensemble des clients API à nouveau générés.

Si vous prévoyez d'intégrer nos API à votre client, vous devez être conscient des éventuelles mises à jour et modifications qui peuvent survenir au niveau des spécifications de l'API, des schémas JSON ou des points de terminaison de l'API.

La liste suivante fournit des informations et des recommandations concernant les modifications apportées aux spécifications des API. Si vous avez d’autres questions, contactez notre équipe d’assistance.

Chronologie de l’abandon

Modèle de livraison	Obsolète	a supprimé
Automation Cloud	Août 2026	Septembre 2026
Automation Suite	Version 2.2610	Version 2.2610

Informations et recommandations sur les modifications apportées à Swagger

1. La description de l'API JSON représentée dans le document Swagger JSON peut changer à tout moment. Cependant, il décrira la même API sous-jacente, pour assurer la rétrocompatibilité.
2. L'interface Swagger et le JSON correspondant sont générés en fonction des points de terminaison actuels, et nous publions toujours la dernière version. Pour garantir la rétrocompatibilité, nous prenons en charge la même structure de requête.
3. Comme alternative aux clients API générés au runtime, utilisez des clients API à temps fixe ou à temps de compilation. Cela réduit la dépendance et empêche les mises à jour d'automatisation majeures en cas de modification de l'API ou de la définition Swagger.
4. Les éléments marqués comme obsolètes sont disponibles pendant une durée limitée, après quoi les éléments sont supprimés de la définition Swagger et de l'API JSON.
5. Chaque fois que certaines API changent en interne, une nouvelle version de l'API Swagger est publiée. Le numéro de version de l'API n'influence pas l'utilisation de l'API cliente. Nous vous déconseillons de vous fier à la gestion des versions de l’API.

Exemples d'API

Les exemples fournis dans le document de référence Orchestrator existant décrivent des scénarios et des points de terminaison complexes.

Vous pouvez voir toutes les API disponibles dans le Swagger JSON, qui contient les dernières mises à jour.