- 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
- Requêtes relatives aux Webhooks
Guide de l'API Orchestrator
Lisez-moi
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.
Si vous prévoyez d'intégrer nos API à votre client, vous devez être conscient des mises à jour et des modifications possibles qui peuvent survenir à la définition Swagger, aux schémas JSON ou aux points de terminaison d'API.
La liste ci-dessous fournit des informations et des recommandations concernant les modifications avec Swagger. Si vous avez d’autres questions, contactez notre équipe d’assistance.
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.