- Démarrage
- Définition Swagger
- API Orchestrator
- Demandes d'alertes
- Demandes de tâches d'application
- Requêtes relatives aux actifs
- Requêtes de calendriers
- Requêtes relatives aux environnements
- Requêtes de dossiers
- Requêtes de tâches globales
- Requêtes relatives aux tâches
- Requêtes relatives aux bibliothèques
- Requêtes relatives aux licences
- Requêtes relatives aux paquets (Packages Requests)
- Requêtes relatives aux autorisations
- Demandes relatives aux espaces de travail personnels
- Requêtes relatives aux processus
- Traiter les requêtes liées à la stratégie de conservation des données
- Demandes d'éléments de la file d'attente
- Queue retention policy requests
- Requêtes relatives aux Robots
- Requêtes relatives aux rôles (Roles Requests)
- Requêtes relatives aux planifications
- Requêtes relatives aux paramètres
- Requêtes de compartiments de stockage
- Requêtes de tâches
- Demandes de catalogues de tâches
- Demandes de formulaires de tâches
- Requêtes relatives aux locataires
- Requêtes relatives aux transactions
- Requêtes relatives aux utilisateurs
- Demandes d’enregistrements vidéo
- Requêtes relatives aux Webhooks
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.
Chronologie de l’abandon
| Delivery model | Obsolète | a supprimé |
|---|---|---|
| Automation Cloud | Août 2026 | September 2026 |
| Automation Suite | 2.2610 release | 2.2610 release |
Informations et recommandations sur les modifications apportées à Swagger
- 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é.
- 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.
- 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.
- 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.
- 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.