Abonnieren

UiPath-Aktivitäten

Die Anleitung zu UiPath-Aktivitäten (The UiPath Activities Guide)

HTTP-Anfrage (HTTP Request)

UiPath.Web.Activities.HttpClient

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.

📘

Important!

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.

📘

Note:

Der Assistent kann nicht zum zweiten Mal geöffnet werden.

All the fields present in this window are also available in the Properties panel. As a result, you can still edit your preferences after closing the wizard.

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

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.
  • Auszeit (Timeout) - Gibt die Wartezeit (in Millisekunden) bis zur Fehlerausgabe einer laufenden Aktivität an. Der Standardwert ist 6000 Millisekunden (6 Sekunden).
  • Client Certificate - The location in which the Client Certificate file is stored. The full path must be provided.

📘

Note:

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.
  • Antwort akzeptieren als (Accept response as) - Das Format, in dem die Antwort des Webservers empfangen werden soll. Folgende Optionen werden unterstützt: JEDE (ANY) - der Standardwert, XML (XML) und JSON (JSON).
  • 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.

The Parameters Section

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

📘

Note:

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.

The 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.
  • Type - The type of line. The following options are available:
    GetOrPost - Indicates that the line is a parameter that can be used in requests.
    HttpHeader - Indicates that the line added in the Parameters table is a request header to be sent when making the API call.
    * UrlSegment - Indicates that the line added is a fragment or the URL provided in the End point field.
    For example, if you want to perform a GET request for the Robot with the ID 28 in the Community Edition Orchestrator, you should fill in the End point field with https://platform.uipath.com/odata/Robots({id}), the Parameters table should be filled in with one parameter with the id Name, the 28 Value, and the UrlSegment Type.

📘

Important!

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.

The Attachments Section

  • 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.
  • Delete Attachment - Enables you to delete a previously added line, in the Attachments section.
  • Name (Name) - Der Name der Datei, die Sie anhängen möchten.
  • Dateipfad (File Path) - Der vollständige Pfad der anzuhängenden Datei.
  • Type - Indicates what type of information you are sending. This field is automatically filled in with Attachment.
    Preview - Enables you to preview the HTTP request you built, and opens the Response tab.

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. Auf diese Registerkarte kann beim Ausfüllen aller Felder und Konfigurieren der Anforderungen durch Klicken auf die Schaltfläche Vorschau (Preview) im HTTP-Anforderungsassistenten zugegriffen werden. 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

Client-Zertifikatsauthentifizierung (Client Certificate Authentication)

  • Client-Zertifikat (ClientCertificate) - den vollständigen Pfad zur Datei mit dem Client-Zertifikat auf Ihrer Festplatte. Dieses Feld unterstützt nur Strings und Variablen des Typs String.
  • Client-Zertifikat-Passwort (ClientCertificatePassword) - Das Passwort für die Datei mit dem angegebenen Client-Zertifikat. Dieses Feld unterstützt nur Strings und Variablen des Typs String.

Common

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

📘

Note:

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.

  • DisplayName - The display name of the activity.

Input

  • 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, application/xml, text/json, text/x-json, text/javascript, text/xml.
  • EndPoint - 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.
  • Methode (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.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

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 (Attachments) - Ermöglicht das Anhängen von Dateien an Anfragen. Klicken Sie auf die Schaltfläche Ellipse (Ellipsis), um das Fenster Anhänge (Attachments) zu öffnen und die gewünschten 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 - The cookies in the HTTP Request. Click the Ellipsis button to open the Cookies window.
  • Kopfzeilen (Headers) - Ermöglicht das Einsetzen von benutzerdefinierten Kopfzeilen in der HTTP-Anfrage. Klicken Sie auf die Schaltfläche Ellipse (Ellipsis), um das Fenster Kopfzeilen (Headers) zu öffnen.
  • Parameters - The request parameters. Click the Ellipsis button to open the Parameters window, which corresponds to the Parameters section.
  • RessourcenPfad (ResourcePath) - Ein Dateipfad, in dem die Antwort gespeichert werden soll. Das Feld unterstützt Zeichenfolgen und Zeichenfolgenvariablen.
  • UrlSegments - Custom segments added to the Endpoint URL between braces "{}". Click the Ellipsis button to open the URLSegments window. For example, the https://platform.uipath.com/odata/Robots(28) URL 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. This field supports strings and string variables.

Output

  • Ergebnis (Result) - Die empfangene Antwort einer HTTP-Anfrage als Variable vom Typ Zeichenfolge (String).
  • StatusCode (StatusCode) - Der von der HTTP-Anfrage empfangene Statuscode als Variable vom Typ Integer.

Einfache Authentifizierung (Simple Authentification)

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

Aktualisiert vor 7 Monaten


HTTP-Anfrage (HTTP Request)


Auf API-Referenzseiten sind Änderungsvorschläge beschränkt

You can only suggest edits to Markdown body content, but not to the API spec.