Orchestrator
2022.10
False
Image de fond de la bannière
Guide de l'API Orchestrator
Dernière mise à jour 10 nov. 2023

Références d'API

Accès au fichier Swagger

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

  • sur site : ajoutez /swagger/index.html à votre URL Orchestrator sur site. Par exemple, https://myOrchestrator.com/swagger/index.html.
  • Automation Cloud - ajoutez le nom de l'organisation et du locataire, ainsi que orchestrator_/swagger/index.html à l'URL de base du cloud. Par exemple, https://cloud.uipath.com/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html.
    Recherchez vos identifiants {organization_name} et {tenant_name} dans la page Accès à l'API de votre compte Automation Cloud.
  • Automation Suite : ajoutez le nom de l'organisation et du locataire, ainsi que orchestrator_/swagger/index.html à votre URL de base Automation Suite, en suivant la syntaxe : https://AutomationSuiteURL/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html. Par exemple, pour accéder au déploiement Swagger d'Orchestrator dans le cadre d'Automation Suite, un lien possible pourrait être https://myasuite.westeurope.cloudapp.azure.com/docs/DefaultTenant/orchestrator_/swagger/index.html.
    Remarque :
    Notez que si vous utilisez Automation Cloud, toutes les requêtes adressées aux points de terminaison Orchestrator doivent inclure /{organization_name}/{tenant_name}/.
    Si vous utilisez Automation Suite, toutes les requêtes adressées aux points de terminaison Orchestrator doivent inclure /{organization_name}/{tenant_name}/.

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.

Collection Postman de l'API Orchestrator

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.
  • Accès au fichier Swagger
  • Collection Postman de l'API Orchestrator

Cette page vous a-t-elle été utile ?

Obtenez l'aide dont vous avez besoin
Formation RPA - Cours d'automatisation
Forum de la communauté UiPath
Logo Uipath blanc
Confiance et sécurité
© 2005-2024 UiPath. All rights reserved.