Structure de l'URL du point de terminaison de l'API

Structure d'URL pour la construction des demandes d'API Test Cloud, y compris les URL de base pour Test Cloud, Test Cloud Secteur Public et Test Cloud dédié.

Dans cette section, vous pourrez apprendre à créer des requêtes API en améliorant vos connaissances sur la structure URL des points de terminaison UiPath®.

URL de base

L'URL de base est le point de départ de toutes les requêtes d'API. Elle sert de base pour créer l'URL du point de terminaison. Selon la plate-forme cloud que vous utilisez, utilisez l' URL de base correspondante :

• Test Cloud : https://cloud.uipath.com
• Test Cloud pour le secteur public : https://govcloud.uipath.us
• Test Cloud dédié : https://<customURL>.dedicated.uipath.com

Entry point

api : indique le point d'entrée vers les ressources API de gestion de plate-forme, par exemple ​/api​/Group​/

Chemin de la ressource

Le chemin de la ressource spécifie la ressource ou l'opération exacte que vous souhaitez effectuer. Ce chemin peut inclure des mots-clés tels que Group, RobotAccount ou Setting, en fonction de l'objet de la requête.

Paramètres de chemin d'accès

Les paramètres de chemin d'accès sont utilisés pour transmettre des valeurs dynamiques à un point de terminaison de l'API. Ces valeurs permettent d'identifier des ressources spécifiques relatives à la requête d'API. Par exemple : ​/Group​/{partitionGlobalId}​/{groupId}

partitionGlobalId : l'ID de l'organisation.

groupId : l'ID du groupe.

Paramètres de requête

Les paramètres de requête sont des paramètres supplémentaires rattachés à l'URL afin de fournir davantage de contexte ou de filtres pour les données demandées. Ils sont souvent précédés d'un symbole ? et séparés par le symbole & . Vous pouvez par exemple utiliser des paramètres de requête afin de préciser les critères de filtrage ou les instructions de pagination.

Exemple

Si l'on assemble tous les éléments qui la composent, l'URL d'une ressource spécifique à une organisation pourra ressembler à ceci : https://cloud.uipath.com/{organizationName}/identity_/api/group/{partitionGlobalId}​/{groupId}.

L'URL d'une ressource spécifique à un locataire pourra ressembler à ceci : https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Assets.