HTTP Request (legacy)

UiPath.Web.Activities.HttpClient

Wichtig:

Diese Aktivität ist in WebAPI-Paketversionen vor 2.0.0-preview verfügbar. Verwenden Sie für eine aktualisierte Erfahrung die verbesserte Aktivität HTTP Request , die in der WebAPI-Version 2.0.0-preview enthalten ist.

Beschreibung

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.

Hinweis:

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.

Wichtig:

Das WebAPI-Paket ist mit den folgenden Aktivitäten nicht kompatibel: UiPath.Salesforce.Activities und UiPath.Jira.Activities.

Projektkompatibilität

Windows - Legacy | Windows | Plattformübergreifend

Windows, Windows – Legacy-Konfiguration

Das Fenster des Importassistenten

Damit können Sie eine HTTP-Anfrage im CURL-Format importieren.

Das HTTP-Anfrageassistent-Fenster (HTTP Request Wizard Window)

Alle Felder im Assistenten sind auch im Eigenschaftenbereich verfügbar. Daher können Sie Ihre Einstellungen auch nach dem Schließen des Assistenten bearbeiten. Sie können die Aktivität im Assistenten mithilfe hartcodierter Werte oder Variablen konfigurieren.

Hinweis:

Wenn Variablen verwendet werden, ist die Vorschaufunktion nicht verfügbar.

Die Registerkarte Anfragegenerator (Request Builder Tab)

• 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.
• Vorschau URL (Preview URL) - Eine Vorschau der im Feld Endpunkt (End Point) bereitgestelten URL. Die im Bereich Parameter (Parameters) bereitgestellten Informationen werden entsprechend berücksichtigt.
• Enable SSL certificate verification - Check this box to verify SSL certificates when sending a request. Verification failures will result in the request being aborted.
• Auszeit (Timeout) - Gibt die Wartezeit (in Millisekunden) bis zur Fehlerausgabe einer laufenden Aktivität an. Der Standardwert ist 6000 Millisekunden (6 Sekunden).
• Client-Zertifikat – Der Speicherort, an dem die Client-Zertifikatdatei gespeichert wird. Der vollständige Pfad muss angegeben werden. Die unterstützte Zertifikatscodierung ist X.509 und die unterstützten Erweiterungen sind .pfx und .p12. Es unterstützt die Zwei-Wege-Handshake-Verifizierung.
  Hinweis:

  Der Pfad darf nicht in Anführungszeichen stehen.

• Client-Zertifikat-Passwort (Client Certificate Password) - Das Passwort der von Ihnen verwendeten Client-Zertifikatdatei.
• Anfragemethode (Request Method) - Die zu verwendende Anfragemethode, wenn die API aufgerufen wird. Folgende HTTP-Verben werden unterstützt: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH und MERGE. Standardmäßig wird die Methode GET ausgewählt.
• Authentifizierung (Authentication) - Gibt das Authentifizierungsprotokoll an, das beim Aufruf der API verwendet werden soll. Folgende Protokolle werden unterstützt:
  • Keine (None) - Die Standardoption. Sollte verwendet werden, wenn der Webserver, an den Sie Anfragen senden, kein Authentifizierungsprotokoll benötigt.
  • Einfaches Http (Simple Http) - Diese Option muss ausgewählt werden, wenn die API, an die Sie Anfragen senden, ein einfaches HTTP-Authentifizierungsprotokoll verwendet. Bei Auswahl werden zwei zusätzlicher Felder angezeigt - Benutzername (Username) und Passwort (Password). Diese Felder müssen mit gültigen Anmeldedaten für die angegebene API befüllt werden.
  • OAuth1 (OAuth1) - Diese Option muss ausgewählt werden, wenn die API, an die Sie Anfragen senden, ein OAuth1-Protokoll verwendet. Bei Auswahl werden vier Felder angezeigt: Verbraucherschlüssel (Consumer Key), Verbrauchergeheimnis (Consumer Secret), Zugangstoken (Access Token), Zugriffstokengeheimnis (Access Token Secret).
  • OAuth2 (OAuth2) - Diese Option muss ausgewählt werden, wenn die API, an die Sie Anfragen senden, ein OAuth2-Protokoll verwendet. Wenn diese Option ausgewählt ist, wird das Feld Zugangstoken (Access Token) angezeigt. Dieser Zugriffstoken wird normalerweise als Antwort auf eine andere HTTP-Anfrage an die angegebene API generiert.

Der Abschnitt „Parameter“

• Parameter hinzufügen (Add Parameter) - Fügt eine neue Zeile vom Typ ErhaltenOderSenden (GetOrPost) in der Parametertabelle hinzu. Wenn die vorherige Zeile nicht befüllt ist, wird keine neue Zeile hinzugefügt.
• Kopfzeile hinzufügen (Add Header) - Fügt eine neue Zeile vom Typ HttpKopfzeile (HttpHeader) in der Parametertabelle hinzu. Wenn die vorherige Zeile nicht befüllt ist, wird keine neue Zeile hinzugefügt.
  Hinweis:

  Falls Sie mehrere Werte zu einer Überschrift hinzufügen möchten, müssen diese durch ein Komma (,) abgeschnitten sein.

• URL-Segment hinzufügen (Add URL Segment) - Fügt eine neue Zeile vom Typ URL-Segment (UrlSegment) in der Parametertabelle hinzu. Wenn die vorherige Zeile nicht befüllt ist, wird keine neue Zeile hinzugefügt.
• Löschen (Delete) - Entfernt eine angegebene Zeile in der Parametertabelle. Wenn keine Zeile ausgewählt ist, ist diese Schaltfläche deaktiviert.

Die Parametertabelle (Parameters Table)

• Name (Name) - Der Name des Parameters, der Kopfzeile oder des URL-Segments.
• Wert (Value) - Der Wert des Parameters, der Kopfzeile oder des URL-Segments.
• Typ (Type) - Der Typ der Zeile. Folgende Optionen sind verfügbar:
  • ErhaltenOderSenden (GetOrPost) - Zeigt an, dass die Zeile ein Parameter ist, der in Anfragen verwendet werden kann.
  • HttpKopfzeile (HttpHeader) - Zeigt an, dass die in der Tabelle Parameter (Parameters) hinzugefügte Zeile eine zu sendende Anfrage-Kopfzeile ist, wenn der API-Aufruf ausgeführt wird.
  • UrlSegment - Indicates that the line added is a fragment or the URL provided in the End point field.
    Hinweis:

    In einigen Fällen wird möglicherweise ein Fehler zurückgegeben, der angibt, dass doppelte Parameter nicht vorhanden sein können. Diese doppelten Parameter können durch Authentifizierungsanfragen verursacht werden, die die Parameter Passwort (Password) und Benutzername (Username) enthalten müssen. In diesen Fällen empfehlen wir, diese Parameter mit der Eigenschaft Textkörper (Body) zu übergeben.

Der Abschnitt Anhänge (Attachments)

• Anhang hinzufügen (Add Attachment) - Ermöglicht das Anhängen einer Datei an die auszuführende HTTP-Anfrage, indem eine neue Zeile erstellt wird. Nur aktiviert, wenn Anfragemethode (Request Method) auf POST oder PUT gesetzt ist.
• Anhang löschen (Delete Attachment) - ermöglicht das Löschen einer vorher hinzugefügten Zeile im Bereich Anhänge (Attachments).
• Name (Name) - Der Name der Datei, die Sie anhängen möchten.
• Dateipfad (File Path) - Der vollständige Pfad der anzuhängenden Datei.
• Typ (Type) - Gibt an, welche Arten von Informationen Sie senden. Das Feld ist automatisch befüllt mit Anhang (Attachment).
  Vorschau (Preview) - ermöglicht eine Vorschau der erstellten HTTP-Anfrage und öffnet die Registerkarte Antwort (Response).

Die Registerkarte Antwort (Response Tab)

Über diese Registerkarte können Sie eine Vorschau der Anfrage anzeigen lassen, die Sie in Ihren Workflow aufnehmen möchten. Darauf kann über die Schaltfläche Vorschau im HTTP Request-Assistenten zugegriffen werden, sobald Sie alle Felder ausgefüllt und die Anforderung konfiguriert haben. Alternativ können Sie die Registerkarte auch im oberen Teil des Assistenten ändern.

Diese Seite enthält:

• AnfrageInfo (Request Info) - Dieser Bereich zeigt Einzelheiten der ausgeführten Anfrage an. Angezeigt werden die angefragte URL, die Methode und der Statuscode.
• Vorschau Antwort (Preview Response) - Zeigt die Antwort des Webservers an.
• Reiner Körper (Raw Body) - Zeigt die Antwort des Webservers als reinen Textkörper an.
• Antwort Info (Response Info) - Zeigt Einzelheiten der Webserver-Antwort. Angezeigt werden Antwortstatus, Antwortcode und der unterstützte Inhaltstyp-Kopf.
• Ressource herunterladen (Download Resource) - Ermöglicht das Herunterladen der angefragten Ressourcen in eine angegebene Datei.
• Aktualisieren (Refresh) - Ermöglicht ein erneutes Ausführen der Anfrage.

Eigenschaften-Panel

Client-Zertifikatsauthentifizierung (Client Certificate Authentication)

• Clientzertifikat – Der Speicherort, an dem die Clientzertifikatdatei gespeichert wird. Der vollständige Pfad muss angegeben werden. Die unterstützte Zertifikatscodierung ist X.509 und die unterstützten Erweiterungen sind .pfx und .p12. Es unterstützt die Zwei-Wege-Handshake-Verifizierung.
• Client-Zertifikat-Passwort (Client Certificate Password) - Das Passwort der von Ihnen verwendeten Client-Zertifikatdatei.
• 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).
• SicheresClientzertifikatKennwort (SecureClientCertificatePassword) – Das Kennwort für die angegebene Client-Zertifikatdatei in Form einer sicheren Zeichenfolge. Dieses Feld unterstützt nur Variablen vom Typ „SichereZeichenfolge“ (SecureString).

Allgemein

• BeiFehlerFortsetzen – Gibt an, ob die Automatisierung auch dann fortgesetzt werden soll, wenn die Aktivität einen Fehler ausgibt. Dieses Feld unterstützt nur boolesche Werte (True, False). Der Standardwert ist False. Wenn das Feld leer ist und ein Fehler ausgegeben wird, wird die Ausführung des Projekts angehalten. Wenn der Wert auf True gesetzt ist, wird die Ausführung des Projekts ungeachtet eines Fehlers fortgesetzt.
  Hinweis:

  Wenn die Aktivität in Abfangen versuchen (Try Catch) enthalten ist und der Wert der Eigenschaft BeiFehlerFortfahren (ContinueOnError) auf Wahr (True) gesetzt ist, wird kein Fehler bei der Ausführung des Projekts abgefangen.

• AnzeigeName (DisplayName) - Der Anzeigename der Aktivität.
• Timeout (Millisekunden) (Timeout (milliseconds)) - Gibt an, wie lange (in Millisekunden) die Aktivität laufen muss, bevor ein Fehler ausgegeben wird. Der Standardwert ist 6000 Millisekunden (6 Sekunden).

Eingabe

• 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.
• Anfragemethode (Request Method) - Die zu verwendende Anfragemethode, wenn die API aufgerufen wird. Folgende HTTP-Verben werden unterstützt: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH und MERGE. Standardmäßig wird die Methode GET ausgewählt.
  Hinweis:

  HTTP-Anforderung funktioniert nur mit RestSharp-Paketversion 106.11.2 oder niedriger ordnungsgemäß. Es gibt einen Fehler zurück, wenn RestSharp Version 106.11.4 oder höher installiert ist.

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

Sonstiges

• Privat (Private) - Bei Auswahl werden die Werte von Variablen und Argumenten nicht mehr auf der Stufe Verbose protokolliert.

OAuth1

• Verbraucherschlüssel (Consumer Key) - Der zu verwendende Schlüssel des Verbrauchers, wenn die API, an die Sie Anfragen richten, auf dem OAuth1-Authentifizierungsprotokoll basiert.
• VerbraucherGeheimnis (ConsumerSecret) - Das zu verwendende Geheimnis des Verbrauchers, wenn die API, an die Sie Anfragen richten, auf dem OAuth1-Authentifizierungsprotokoll basiert.
• OAuth1Token (OAuth1Token) - Der zu verwendende Zugriffstoken, wenn die API, an die Sie Anfragen richten, auf dem OAuth1-Authentifizierungsprotokoll basiert, nachdem eine Autorisierungsanfrage für den Verbraucher genehmigt wurde.
• OAuth1TokenGeheimnis (OAuth1TokenSecret) - Das zu verwendende Geheimnis, wenn die API, an die Sie Anfragen richten, auf dem OAuth1-Authentifizierungsprotokoll basiert, nachdem eine Autorisierungsanfrage für den Verbraucher genehmigt wurde.

OAuth2

• OAuth2Token (OAuth2Token) - Der zu verwendende Zugriffstoken, wenn die API, an die Sie Anfragen senden, ein OAuth2-Authentifizierungsprotokoll verwendet. Dieser Zugriffstoken wird normalerweise als Antwort auf eine andere HTTP-Anfrage an die angegebene API generiert.

Optionen

• Anhänge – Ermöglicht das Anhängen von Dateien an Anforderungen. Wählen Sie die Ellipsenschaltfläche aus, um das Fenster „Anhänge“ zu öffnen und alle erforderlichen Dateien hinzuzufügen.
• Textkörper (Body) - Der Textkörper der Anfrage.
• KörperFormat (BodyFormat) - Das Format, in dem der Körper sein muss. Standardmäßig befüllt mit application/xml. Das Feld unterstützt Zeichenfolgen und Zeichenfolgenvariablen.
• Cookies – Die Cookies in der HTTP-Anforderung. Klicken Sie auf die Ellipsenschaltfläche, um das Fenster Cookies zu öffnen.
• File attachments - List of attachments for the request.
• Filename for response attachment - The filename to be used for the file returned by the request.
• Header – Ermöglicht das Einsetzen von benutzerdefinierten Headern in der HTTP-Anforderung. Klicken Sie auf die Ellipsenschaltfläche, um das Fenster Headers zu öffnen.
• Parameter – Die Anfrageparameter. Klicken Sie auf die Ellipsenschaltfläche um das Fenster Parameter zu öffnen. Das Fenster entspricht dem Bereich Parameter.
• UrlSegmente – Benutzerdefinierte Segmente, die in eckigen Klammern „{}“ der Endpunkt-URL hinzugefügt wurden. Klicken Sie auf die Ellipsenschaltfläche , um das Fenster URLSegmente zu öffnen. Diese URL https://platform.uipath.com/odata/Robots(28) kann beispielsweise als https://platform.uipath.com/odata/Robots{id} geschrieben werden, und der Wert des Parameters id kann im Fenster URLSegments bereitgestellt werden. Dieses Feld unterstützt nur Strings und Stringvariablen.

Ausgabe

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

Einfache Authentifizierung (Simple Authentification)

• Passwort (Password) - Zeigt an, dass der Webservice eine einfache Authentifizierung verwendet und ermöglicht Ihnen die Eingabe Ihres Passworts. Die Eingabe eines Benutzernamens ist auch erforderlich. Diese Eigenschaft unterstützt Zeichenfolgen und Zeichenfolgenvariablen.
• 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.
• Benutzername (Username) - Zeigt an, dass der Webservice eine einfache Authentifizierung verwendet und ermöglicht Ihnen die Eingabe Ihres Benutzernamens. Die Eingabe eines Passworts ist auch erforderlich. Diese Eigenschaft unterstützt Zeichenfolgen und Zeichenfolgenvariablen.

Plattformübergreifende Konfiguration

• Anfragemethode (Request Method) - Die zu verwendende Anfragemethode, wenn die API aufgerufen wird. Folgende HTTP-Verben werden unterstützt: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH und MERGE. Standardmäßig wird die Methode GET ausgewählt.
• 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.
• Parameter – Die Anfrageparameter. Wählen Sie das Feld aus, um das Wörterbuchfenster zu öffnen.
• Header – Ermöglicht das Einsetzen von benutzerdefinierten Headern in der HTTP-Anforderung. Wählen Sie das Feld aus, um das Wörterbuchfenster zu öffnen.
• Textkörper (Body) - Der Textkörper der Anfrage.
• Authentifizierung (Authentication) - Gibt das Authentifizierungsprotokoll an, das beim Aufruf der API verwendet werden soll. Folgende Protokolle werden unterstützt:
  • Keine (None) - Die Standardoption. Sollte verwendet werden, wenn der Webserver, an den Sie Anfragen senden, kein Authentifizierungsprotokoll benötigt.
  • Einfaches Http (Simple Http) - Diese Option muss ausgewählt werden, wenn die API, an die Sie Anfragen senden, ein einfaches HTTP-Authentifizierungsprotokoll verwendet. Bei Auswahl werden zwei zusätzlicher Felder angezeigt - Benutzername (Username) und Passwort (Password). Diese Felder müssen mit gültigen Anmeldedaten für die angegebene API befüllt werden.
  • OAuth1 - Diese Option muss ausgewählt werden, wenn die API, an die Sie Anfragen senden, ein OAuth1-Protokoll verwendet. Wenn diese Option ausgewählt ist, werden vier zusätzliche Felder angezeigt: Verbraucherschlüssel, Verbrauchergeheimnis, Zugriffstoken, Zugriffstokengeheimnis.
  • OAuth2 (OAuth2) - Diese Option muss ausgewählt werden, wenn die API, an die Sie Anfragen senden, ein OAuth2-Protokoll verwendet. Wenn diese Option ausgewählt ist, wird das Feld Zugangstoken (Access Token) angezeigt. Dieser Zugriffstoken wird normalerweise als Antwort auf eine andere HTTP-Anfrage an die angegebene API generiert.
  • Clientzertifikat – Diese Option muss ausgewählt werden, wenn ein Clientzertifikat erforderlich ist, um den API-Aufruf durchzuführen. Wenn sie ausgewählt ist, werden zwei zusätzliche Felder angezeigt:
    • Clientzertifikat – Der Speicherort, an dem die Clientzertifikatdatei gespeichert wird. Der vollständige Pfad muss angegeben werden. Die unterstützte Zertifikatscodierung ist X.509 und die unterstützten Erweiterungen sind .pfx und .p12. Es unterstützt die Zwei-Wege-Handshake-Verifizierung.
    • Client-Zertifikat-Passwort (Client Certificate Password) - Das Passwort der von Ihnen verwendeten Client-Zertifikatdatei.

Erweitert (Advanced)

Optionen

• Timeout (Millisekunden) (Timeout (milliseconds)) - Gibt an, wie lange (in Millisekunden) die Aktivität laufen muss, bevor ein Fehler ausgegeben wird. Der Standardwert ist 6000 Millisekunden (6 Sekunden).
• 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.
• Format Akzeptieren – Das Format, in dem die Antwort des Webservers empfangen werden soll. Die folgenden Optionen werden unterstützt: JEDE – der Standardwert, XML, JSON und CUSTOM. Wenn Sie das Annahmeformat CUSTOM auswählen und ein Accept oder accept -Header-Parameter vorhanden ist, wird es als benutzerdefiniertes Annahmeformat gesendet. Wenn kein Header-Parameter festgelegt ist, ruft accept den RestSharp-Standardwert ab:

  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.
• KörperFormat (BodyFormat) - Das Format, in dem der Körper sein muss. Standardmäßig befüllt mit application/xml. Das Feld unterstützt Zeichenfolgen und Zeichenfolgenvariablen.
• Cookies – Die Cookies in der HTTP-Anforderung. Wählen Sie das Feld aus, um das Wörterbuchfenster zu öffnen.
• URL-Segmente – Benutzerdefinierte Segmente, die in eckigen Klammern „{}“ der Endpunkt-URL hinzugefügt wurden. Wählen Sie das Feld aus, um das Wörterbuchfenster zu öffnen. Diese URL https://platform.uipath.com/odata/Robots(28) kann beispielsweise als https://platform.uipath.com/odata/Robots{id} geschrieben werden, und der Wert des Parameters id kann im Fenster Wörterbuch bereitgestellt werden. Dieses Feld unterstützt nur Strings und Stringvariablen.

Ausgabe

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