HTTP Request (legacy)

UiPath.Web.Activities.HttpClient

Important :

Cette activité est disponible dans les versions de package WebAPI antérieures à 2.0.0-preview. Pour une expérience mise à jour, utilisez l'activité améliorée Demande HTTP incluse dans l'aperçu WebAPI version 2.0.0-preview.

Description

Enables you to perform HTTP requests to a specified web API. When first dragging this activity to the Designer panel, the HTTP Request Wizard window is displayed, providing an easier way of building requests and previewing server responses.

Remarque :

If the returned HTTP status code (StatusCode) is 0, it means that the server did not return an actual response for some reason. This usually points to some connectivity or network issues you might be having.

Important :

Le package WebAPI n’est pas compatible avec les activités suivantes : UiPath.Salesforce.Activities et UiPath.Jira.Activities.

Compatibilité du projet

Windows - Héritage | Windows | Multiplate-forme

Windows, Windows - Configuration héritée

Fenêtre Assistant d'importation (Import Wizard)

Vous pouvez l'utiliser pour importer une requête HTTP au format CURL.

Fenêtre de l'Assistant de requête HTTP

Tous les champs présents dans l’assistant sont également disponibles dans le volet Propriétés. Par conséquent, vous pourrez toujours modifier vos préférences après la fermeture de l’assistant. Vous pouvez configurer l’activité dans l’assistant à l’aide de valeurs ou de variables codées en dur.

Remarque :

Lorsque des variables sont utilisées, la fonctionnalité d'aperçu n'est pas disponible.

Onglet Générateur de requête (Request Builder)

• End Point - The URL to which you want to make the request. Custom segments have to be placed between braces "{}" and defined in the Parameters section. For example, this URL https://platform.uipath.com/odata/Robots(28) can be written as https://platform.uipath.com/odata/Robots({id}), and the value of the id parameter can be provided in the Parameters section, as a UrlSegment.
• Aperçu de l'URL (Preview URL) - Aperçu de l'URL fournie dans le champ Point de terminaison (End point), en tenant compte des informations fournies dans la section Paramètres (Parameters).
• Enable SSL certificate verification - Check this box to verify SSL certificates when sending a request. Verification failures will result in the request being aborted.
• Délai d'expiration (Timeout) - Spécifie la durée (en millisecondes) d'attente d'exécution de l'activité avant la génération d'un message d'erreur. La valeur par défaut est 6 000 millisecondes (6 secondes).
• Certificat client : emplacement dans lequel le fichier de certificat client est stocké. Le chemin complet doit être fourni. L'encodage de certificat pris en charge est X.509 et les extensions acceptées sont .pfx et .p12. Il prend en charge la vérification d'établissement de liaison dans les deux sens.
  Remarque :

  Le chemin d'accès ne doit pas être écrit entre guillemets.

• Mot de passe du certificat de client (Client Certificate Password) : mot de passe qui correspond au fichier de certificat de client que vous utilisez.
• Méthode de requête (Request Method) - Méthode de requête à utiliser lors de l'appel de l'API. Les verbes HTTP suivants sont pris en charge : GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH et MERGE. La méthode GET est sélectionnée par défaut.
• Authentification (Authentication) - Spécifie le protocole d'authentification à utiliser lors de l'appel de l'API. Les protocoles suivants sont pris en charge :
  • None (Aucun) - Option par défaut. Elle doit être utilisée si le serveur Web auquel vous envoyez des requêtes ne nécessite pas de protocole d'authentification.
  • Simple Http (HTTP simple) - Cette option doit être sélectionnée si l'API vers laquelle vous faites une demande utilise un simple protocole d'authentification HTTP. Si vous choisissez cette option, deux champs supplémentaires sont affichés : Nom d'utilisateur (Username) et Mot de passe (Password), qui doivent être renseignés avec des informations d'identification valides pour l'API spécifiée.
  • OAuth1 (OAuth1) - Cette option doit être sélectionnée si l'API vers laquelle vous effectuez des requêtes utilise un protocole OAuth1. Si vous choisissez cette option, quatre champs sont affichés : Clé de consommateur (Consumer Key) , Consumer Secret (Clé secrète), Jeton d'accès (Access Token), Clé de jeton d'accès (Access Token Secret).
  • OAuth2 (OAuth2) - Cette option doit être sélectionnée si l'API vers laquelle vous faites une requête utilise un protocole OAuth2. Si vous choisissez cette option, le champ Jeton d'accès (Access Token) s'affiche. Ce jeton d'accès est généralement généré en réponse à une autre requête HTTP adressée à l'API indiquée.

Section Paramètres

• Ajouter un paramètre (Add Parameter) - Ajoute une nouvelle ligne dans la table des paramètres, avec le type Obtenir ou diffuser (GetOrPost). Aucune nouvelle ligne n'est ajoutée si la ligne précédente n'est pas renseignée.
• Ajouter un en-tête (Add Header) - Ajoute une nouvelle ligne dans la table des paramètres avec le type En-tête Htt (HttpHeader). Aucune nouvelle ligne n'est ajoutée si la ligne précédente n'est pas renseignée.
  Remarque :

  Au cas où vous souhaiteriez ajouter plusieurs valeurs pour un en-tête, elles doivent être concaténées à l'aide d'une virgule (,).

• Ajouter un segment d'URL (Add URL Segment) - Ajoute une nouvelle ligne dans la table des paramètres avec le type URL du segment (UrlSegment). Aucune nouvelle ligne n'est ajoutée si la ligne précédente n'est pas renseignée.
• Supprimer (Delete) - Supprime une ligne sélectionnée dans la table Paramètres. Si une ligne n'est pas sélectionnée, ce bouton est désactivé.

Table des paramètres

• Nom (Name) - Nom du paramètre, de l'en-tête ou du segment d'URL.
• Valeur (Value) - Valeur du paramètre, de l'en-tête ou du segment d'URL.
• Type (Type) - Type de ligne. Les options suivantes sont disponibles :
  • Obtenir ou diffuser (GetOrPost) - indique que la ligne est un paramètre pouvant être utilisé dans les requêtes.
  • En-tête Htt (HttpHeader) - Indique que la ligne ajoutée dans la table Paramètres (Parameters) est un en-tête de requête à envoyer lors de l'appel de l'API.
  • UrlSegment - Indicates that the line added is a fragment or the URL provided in the End point field.
    Remarque :

    Dans certains cas, un message d'erreur peut être renvoyé indiquant que les paramètres doubles ne peuvent pas exister. Cela peut être dû à des requêtes d'authentification qui doivent contenir les paramètres Mot de passe (Password) et Nom d'utilisateur (Username). Dans ce cas, nous recommandons de les transmettre à l'aide de la propriété Corps (Body).

Section Pièces jointes (Attachments)

• Ajouter une pièce jointe (Add Attachment) - Permet d'ajouter un fichier à la requête HTTP effectuée en créant une nouvelle ligne. Option activée uniquement lorsque Méthode de requête (Request Method) est définie sur POST ou PUT.
• Supprimer la pièce jointe (Delete Attachment) - Permet de supprimer une ligne précédemment ajoutée dans la section Pièces jointes (Attachments).
• Nom (Name) - Nom du fichier que vous souhaitez joindre.
• Chemin du fichier (File Path) - Chemin complet du fichier que vous voulez joindre.
• Type : Indique le type d'informations que vous envoyez. Ce champ est automatiquement renseigné avec Pièce jointe. Aperçu - Vous permet d'afficher un aperçu de la requête HTTP que vous avez créée et ouvre l'onglet Réponse.

Onglet Réponse (Response)

Cet onglet permet de prévisualiser la requête que vous souhaitez inclure dans le workflow. Il est accessible en sélectionnant le bouton Aperçu (Preview) dans l’assistant de requête HTTP, une fois que vous avez rempli tous les champs et configuré la requête. Vous pouvez également modifier l’onglet dans la partie supérieure de l’assistant.

Cette page comprend les éléments suivants :

• Informations sur la requête (Request Info) - Cette section affiche des détails sur la requête effectuée. Elle affiche l'URL de la requête, la méthode et le code d'état.
• Aperçu de la réponse (Preview Response) - Affiche la réponse du serveur Web.
• Corps brut (Raw Body) - Affiche la réponse du serveur Web sous forme brute.
• Informations sur la réponse (Response Info) - Affiche des informations sur la réponse du serveur Web. Le statut et le code de la réponse (ainsi que l'en-tête content-type pris en charge) sont affichés.
• Télécharger les ressources (Download Resource) - Permet de télécharger les ressources demandées vers un fichier indiqué.
• Actualiser (Refresh) - Permet d'effectuer à nouveau la requête.

Panneau propriétés

Authentification du certificat client

• CertificatClient : l’emplacement dans lequel le fichier de certificat client est stocké. Le chemin complet doit être fourni. L'encodage de certificat pris en charge est X.509 et les extensions acceptées sont .pfx et .p12. Il prend en charge la vérification d'établissement de liaison dans les deux sens.
• Mot de passe du certificat de client (Client Certificate Password) : mot de passe qui correspond au fichier de certificat de client que vous utilisez.
• Enable SSL certificate verification - Verify SSL certificates when sending a request. Verification failures will result in the request being aborted. This field only supports Boolean values (True, False).
• MotDePasseCertificatClientSécurisé (SecureClientCertificatePassword) : le mot de passe du fichier de certificat client spécifié, sous la forme d’une chaîne sécurisée. Ce champ prend en charge uniquement les variables SecureString.

Commun

• ContinuerSurErreur (ContinueOnError) : spécifie si l’automatisation doit se poursuivre même lorsque 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 est vide 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.
  Remarque :

  Si cette activité est incluse dans Tenter de capturer (Try Catch) et que la valeur de la propriété Poursuite sur erreur (ContinueOnError) est True, aucune erreur n'est détectée lors de l'exécution du projet.

• 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 6000 millisecondes (6 secondes).

Entrée

• AcceptFormat - The format in which to receive the web server's response. The following options are supported: ANY - the default value, XML, JSON, and CUSTOM. When choosing the CUSTOM AcceptFormat, if an Accept or accept Header parameter is present, then it will be sent as the custom accept format. If no header parameter is set, accept will get the RestSharp default value: application/json, aboveapplication/xml, text/json, text/x-json, text/javascript, text/xml.
• Méthode de requête (Request Method) - Méthode de requête à utiliser lors de l'appel de l'API. Les verbes HTTP suivants sont pris en charge : GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH et MERGE. La méthode GET est sélectionnée par défaut.
  Remarque :

  La requête HTTP ne fonctionne correctement qu’avec la version 106.11.2 ou supérieure du package RestSharp. Il renvoie une erreur lorsque RestSharp version 106.11.4 ou supérieure est installée.

• Request URL - The URL to which you want to make the request. Custom segments have to be placed between braces "{}" and defined in the Parameters section. For example, this URL https://platform.uipath.com/odata/Robots(28) can be written as https://platform.uipath.com/odata/Robots{id}, and the value of the id parameter can be provided in the URLSegments window.

Divers

• 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).

OAuth1

• Clé utilisateur (ConsumerKey) - Clé du consommateur à utiliser si l'API vers laquelle vous faites des requêtes est basée sur le protocole d'authentification OAuth1.
• Secret utilisateur (ConsumerSecret) - Clé secrète du consommateur à utiliser si l'API vers laquelle vous effectuez des requêtes est basée sur le protocole d'authentification OAuth1.
• OAuth1Token (OAuth1Token) - Jeton d'accès à utiliser si l'API vers laquelle vous effectuez des requêtes est basée sur le protocole d'authentification OAuth1, après l'approbation d'une requête d'autorisation pour le consommateur.
• OAuth1TokenSecret (OAuth1TokenSecret) - Clé secrète à utiliser si l'API vers laquelle vous effectuez des requêtes est basée sur le protocole d'authentification OAuth1, après l'approbation d'une requête d'autorisation pour le consommateur.

OAuth2

• OAuth2Token (OAuth2Token) - Jeton d'accès à utiliser si l'API vers laquelle vous effectuez des demandes est basée sur le protocole d'authentification OAuth2. Ce jeton d'accès est généralement généré en réponse à une autre requête HTTP adressée à l'API indiquée..

Options

• Pièces jointes (Attachments) : permet de joindre des fichiers à des requêtes. Sélectionnez le bouton Ellipse pour ouvrir la fenêtre Pièces jointes (Attachments) et ajouter tous les fichiers requis.
• Corps (Body) - Corps de la requête.
• Format du corps (BodyFormat) - Format dans lequel doit être le corps. Par défaut, il est renseigné avec application/xml. Ce champ prend en charge les chaînes et les variables de chaîne.
• Cookies : les cookies de la requête HTTP. Sélectionnez le bouton Ellipse pour ouvrir la fenêtre Cookies.
• File attachments - List of attachments for the request.
• Filename for response attachment - The filename to be used for the file returned by the request.
• En-têtes (Headers) : permet d’inclure des en-têtes personnalisés dans la requête HTTP. Sélectionnez le bouton Ellipse pour ouvrir la fenêtre En-têtes (Cookies).
• Paramètres : Paramètres requis. Cliquez sur le bouton Ellipse pour ouvrir la fenêtre Paramètres qui correspond à la section Paramètres.
• SegmentsURL : Segments personnalisés ajoutés à l'URL de point de terminaison entre crochets "{}". Cliquez sur le bouton Ellipse pour ouvrir la fenêtre SegmentsURL . Par exemple, cette URL https://platform.uipath.com/odata/Robots(28) peut être écrite sous la forme https://platform.uipath.com/odata/Robots{id}, et la valeur du paramètre id peut être indiquée dans la fenêtre SegmentsURL . Ce champ ne prend en charge que les chaînes et les variables String.

Sortie

• Headers - The response received from the HTTP request.
• Response attachment - The attachment saved from the response.
• Response content - The response received from the HTTP request, as a string variable.
• Response status - The status code received from the HTTP request, as an integer variable.

Authentification simple

• Mot de passe (Password) - indique que le service Web utilise une authentification simple et vous permet de saisir votre mot de passe. L'ajout d'un nom d'utilisateur est également requis. Cette propriété prend en charge les chaînes et les variables de chaîne.
• SecurePassword - Indicates that the web service uses secure authentication and enables you to input your secure string password. Adding a username is also required. This property supports secure string variables.
• Nom d'utilisateur (Username) - indique que le service Web utilise une authentification simple et vous permet de saisir votre nom d'utilisateur. L'ajout d'un mot de passe est également requis. Cette propriété prend en charge les chaînes et les variables de chaîne.

Configuration multiplateforme

• Méthode de requête (Request Method) - Méthode de requête à utiliser lors de l'appel de l'API. Les verbes HTTP suivants sont pris en charge : GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH et MERGE. La méthode GET est sélectionnée par défaut.
• Request URL - The URL to which you want to make the request. Custom segments have to be placed between braces "{}" and defined in the Parameters section. For example, this URL https://platform.uipath.com/odata/Robots(28) can be written as https://platform.uipath.com/odata/Robots{id}, and the value of the id parameter can be provided in the URLSegments window.
• Paramètres (Parameters) : paramètres de la requête. Sélectionnez le champ pour ouvrir la fenêtre Dictionnaire (Dictionary).
• En-têtes (Headers) : permet d’inclure des en-têtes personnalisés dans la requête HTTP. Sélectionnez le champ pour ouvrir la fenêtre Dictionnaire (Dictionary).
• Corps (Body) - Corps de la requête.
• Authentification (Authentication) - Spécifie le protocole d'authentification à utiliser lors de l'appel de l'API. Les protocoles suivants sont pris en charge :
  • None (Aucun) - Option par défaut. Elle doit être utilisée si le serveur Web auquel vous envoyez des requêtes ne nécessite pas de protocole d'authentification.
  • Simple Http (HTTP simple) - Cette option doit être sélectionnée si l'API vers laquelle vous faites une demande utilise un simple protocole d'authentification HTTP. Si vous choisissez cette option, deux champs supplémentaires sont affichés : Nom d'utilisateur (Username) et Mot de passe (Password), qui doivent être renseignés avec des informations d'identification valides pour l'API spécifiée.
  • OAuth1 - Cette option doit être sélectionnée si l'API vers laquelle vous effectuez des requêtes utilise un protocole OAuth1. Si elle est choisie, quatre champs supplémentaires sont affichés : Clé du consommateur, Secret du consommateur, Jeton d’accès, Clé du jeton d’accès.
  • OAuth2 (OAuth2) - Cette option doit être sélectionnée si l'API vers laquelle vous faites une requête utilise un protocole OAuth2. Si vous choisissez cette option, le champ Jeton d'accès (Access Token) s'affiche. Ce jeton d'accès est généralement généré en réponse à une autre requête HTTP adressée à l'API indiquée.
  • Certificat client - Cette option doit être sélectionnée si un certificat client est nécessaire pour effectuer l'appel de l'API. Si elle est choisie, deux champs supplémentaires s'affichent :
    • CertificatClient : l’emplacement dans lequel le fichier de certificat client est stocké. Le chemin complet doit être fourni. L'encodage de certificat pris en charge est X.509 et les extensions acceptées sont .pfx et .p12. Il prend en charge la vérification d'établissement de liaison dans les deux sens.
    • Mot de passe du certificat de client (Client Certificate Password) : mot de passe qui correspond au fichier de certificat de client que vous utilisez.

Avancé

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 6000 millisecondes (6 secondes).
• Continue On Error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is not configured and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
• SSL certificate verification - If selected, verifies SSL certificates when sending a request. Verification failures will result in the request being aborted.
• Accepter le format : format dans lequel la réponse du serveur Web est reçue. Les options suivantes sont prises en charge : TOUT (ANY ) , XML, JSON, et PERSONNALISÉ (CUSTOM). En cas de sélection du format PERSONNALISÉ (CUSTOM) , si un paramètre d’en-tête Accept ou accept est présent, il sera envoyé dans le format personnalisé. Si aucun paramètre d’en-tête n’est défini, accept obtiendra la valeur par défaut RestSharp :

  application/json, application/xml, text/json, text/x-json, text/javascript,
                          text/xml
  

• File Attachments - List of attachments for the request.
• Filename for response attachment - The filename to be used for the file returned by the request.
• Format du corps (BodyFormat) - Format dans lequel doit être le corps. Par défaut, il est renseigné avec application/xml. Ce champ prend en charge les chaînes et les variables de chaîne.
• Cookies : les cookies de la requête HTTP. Sélectionnez le champ pour ouvrir la fenêtre Dictionnaire (Dictionary).
• Segments d’URL : segments personnalisés ajoutés à l’URL de point de terminaison entre crochets « {} ». Sélectionnez le champ pour ouvrir la fenêtre Dictionnaire . Par exemple, l’URL https://platform.uipath.com/odata/Robots(28) peut être écrite sous la forme https://platform.uipath.com/odata/Robots{id}, et la valeur du paramètre id peut être indiquée dans la fenêtre Dictionnaire . Ce champ ne prend en charge que les chaînes et les variables String.

Sortie

• Response content - The response received from the HTTP request, as a string variable.
• Response status - The status code received from the HTTP request, as an integer variable.
• Response headers - The response received from the HTTP request.
• Response attachment - The attachment saved from the response.