Références d'API

La définition Swagger de l'API Orchestrator est accessible comme suit, selon votre type de déploiement :

• sur site : ajoutez le suffixe suivant : /swagger/index.html à votre URL Orchestrator. Par exemple, https://myOrchestrator.com/swagger/index.html.
• Automation Cloud - ajoutez le nom du compte et du locataire, ainsi que le suffixe /swagger/index.html à l'URL. Par exemple, https://cloud.uipath.com/[AccountLogicalName]/[TenantName]/swagger/index.html.
  Recherchez vos identifiants Account Logical Name et Tenant Name dans la page Accès à l'API de votre compte Automation Cloud.
  Remarque : Veuillez noter que, si vous utilisez Automation Cloud, toutes les requêtes adressées aux points de terminaison Orchestrator doivent inclure /[AccountLogicalName]/[TenantName]/.

L'API visible dans Swagger dépend directement de l'instance d'Orchestrator que vous utilisez. Pour effectuer facilement des requêtes directement dans la documentation de Swagger, il suffit de vous connecter à Orchestrator dans un autre onglet. Cette fonctionnalité est disponible à partir de la version 2017.1.

Le présent guide est créé en support de la documentation de Swagger, en fournissant des exemples de points de terminaison Orchestrator les plus complexes.

Une bibliothèque PowerShell pour interagir avec votre instance d’Orchestrator est disponible ici. Si vous préférez travailler avec Postman, une petite collection est disponible à ce lien et peut être importée en cliquant sur le bouton Exécuter dans Postman (Run in Postman).

Remarque : À partir de la version v2018.1.3, dans Swagger, vous pouvez utiliser l'authentification Windows pour effectuer des demandes. Auparavant, vous ne pouviez faire que des requêtes GET. Les opérations POST/PUT/DELETE n’étaient pas prises en charge.