Requête HTTP Orchestrator

UiPath.Core.Activities.OrchestratorHttpRequest

Description

Envoie des requêtes HTTP à l'API Orchestrator en s'authentifiant avec le robot sur lequel il est exécuté. Vous pouvez utiliser les verbes GET, POST, PUT, PATCH et DELETE pour extraire des données ou les manipuler, et envoyer des informations spécifiques via JSON. Notez que pour chaque requête, vous aurez peut-être besoin de droits différents sur le rôle Robot Orchestrator, selon les requêtes que vous effectuez, et que le Robot doit être connecté à Orchestrator. Par exemple, pour exécuter PUT requêtes sur des unités d'organisation, vous avez besoin des autorisations Consultation (View), Création (Create) et Modification (Edit). L'activité s'exécute avec le robot qui l'exécute.

Compatibilité du projet

Windows - Héritage | Windows | Multiplate-forme

Windows, configuration multiplate-forme

• Dossier Orchestrator (Orchestrator Folder) : le chemin du dossier Orchestrator à utiliser dans l'activité.
• Méthode : la méthode de requête à utiliser lors de l'appel de l'API Orchestrator. Les verbes HTTP suivants sont pris en charge : GET, POST, PUT, PATCH et DELETE. Par défaut, le verbe GET est sélectionné.
• Noeud final relatif (RelativeEndpoint) - Point de terminaison au niveau duquel doivent être effectuées les requêtes, par rapport à l'URL de votre Orchestrator de base.
• Charge JSON (JSONPayload) - Information que vous souhaitez envoyer au point de terminaison Orchestrator indiqué, au format JSON. Le JSON ne doit pas être indenté. Ce champ prend en charge les chaînes, les variables de chaîne ou les expressions de chaîne uniquement.

Options supplémentaires

Options

• Timeout (millisecondes) : spécifie le délai d'attente (en millisecondes) pour l'exécution de l'activité avant qu'une erreur soit générée. La valeur par défaut est de 30 000 millisecondes (30 secondes).
• Continuer en cas d'erreur (Continue on error) - précise si l’automatisation doit se poursuivre même si l’activité génère une erreur. Ce champ prend uniquement en charge les valeurs booléennes (Vrai (True), Faux (False)). La valeur par défaut est false. Par conséquent, si le champ n'est pas configuré et qu’une erreur est générée, l’exécution du projet s’arrête. Si le champ indique au contraire true, l'exécution du projet se poursuit même en cas d'erreur.

Sortie

• En-têtes (Headers) : référence aux en-têtes renvoyés par la demande.
• Réponse JSON (JSONResponse) - JSON renvoyé par la requête HTTP, sous la forme d'une variable de chaîne.
• Code d'état (StatusCode) - Code d'état renvoyé par la requête HTTP en tant que variable de type integer.

Configuration Windows - Héritage

Panneau propriétés

Commun

• Poursuite sur erreur (ContinueOnError) - Spécifie si l'automatisation doit continuer même si l'activité génère un message d'erreur. Ce champ prend uniquement en charge les valeurs booléennes (true, false). La valeur par défaut est false. Par conséquent, si le champ est vide et qu'une erreur est renvoyée, l'exécution du projet s'interrompt. Si la valeur est définie sur true, l'exécution du projet continue indépendamment de tout message d'erreur affiché.
• NomAffichage (DisplayName) - Nom affiché de l'activité.
• Timeout (millisecondes) : spécifie le délai d'attente (en millisecondes) pour l'exécution de l'activité avant qu'une erreur soit générée. La valeur par défaut est de 30 000 millisecondes (30 secondes).

Entrée

• Charge JSON (JSONPayload) - Information que vous souhaitez envoyer au point de terminaison Orchestrator indiqué, au format JSON. Le JSON ne doit pas être indenté. Ce champ prend en charge les chaînes, les variables de chaîne ou les expressions de chaîne uniquement.
• Méthode : la méthode de requête à utiliser lors de l'appel de l'API Orchestrator. Les verbes HTTP suivants sont pris en charge : GET, POST, PUT, PATCH et DELETE. Par défaut, le verbe GET est sélectionné.
• Noeud final relatif (RelativeEndpoint) - Point de terminaison au niveau duquel doivent être effectuées les requêtes, par rapport à l'URL de votre Orchestrator de base.

Divers

• Chemin du dossier (Folder Path) : le chemin du dossier où la demande doit être effectuée, s'il est différent du dossier dans lequel le processus s'exécute. Ce champ prend uniquement en charge les valeurs de chaîne, avec / comme séparateur permettant d'indiquer les sous-dossiers. Par exemple, "Finance/Accounts Payable".
• Privé (Private) - Si cette option est sélectionnée, les valeurs des variables et des arguments ne sont plus enregistrées au niveau Détaillé (Verbose).

Sortie

• En-têtes (Headers) : référence aux en-têtes renvoyés par la demande.
• Réponse JSON (JSONResponse) - JSON renvoyé par la requête HTTP, sous la forme d'une variable de chaîne.
• Code d'état (StatusCode) - Code d'état renvoyé par la requête HTTP en tant que variable de type integer.

Par exemple, la requête de la capture d'écran suivante vous permet de créer une nouvelle unité d'organisation (unité Documentation) sur l'Orchestrator auquel votre Robot est connecté. La réponse JSON et le code d'état sont enregistrés en tant que variables.