HTTP-Anfrage (HTTP Request)

UiPath.WebAPI.Activities.HttpClient

Beschreibung

Ermöglicht Ihnen die Ausführung von HTTP-Anforderungen für eine angegebene Web-API. Wenn Sie diese Aktivität zuerst in das Panel Designer ziehen, wird das Fenster HTTP-Anforderungsassistent (HTTP Request Wizard) angezeigt, in dem Sie einfacher Anforderungen erstellen und Server-Antworten als Vorschau anzeigen können.

Hinweis: Wenn der zurückgegebene HTTP-Statuscode (StatusCode) 0ist, bedeutet dies, dass der Server aus irgendeinem Grund keine tatsächliche Antwort zurückgegeben hat. Dies weist normalerweise auf einige Konnektivitäts- oder Netzwerkprobleme hin, die Sie möglicherweise haben.

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

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.
• Anforderungs-URL – Die URL, an die Sie die Anforderung stellen möchten. Benutzerdefinierte Segmente müssen zwischen geschweiften Klammern „{}“ platziert und im Abschnitt Parameter definiert werden. 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.
• Parameter - Die Anforderungsparameter. Klicken Sie auf das Feld, um das Fenster Wörterbuch zu öffnen.
• Header – Ermöglicht es Ihnen, benutzerdefinierte Header in die HTTP-Anforderung aufzunehmen. Klicken Sie auf das Feld, um das Fenster Wörterbuch 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 richten, ein OAuth1-Protokoll verwendet. Wenn diese Option ausgewählt wird, 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 vollständige Pfad zum Speicherort der Clientzertifikatdatei. Die unterstützte Zertifikatscodierung ist X.509 und die unterstützten Erweiterungen sind .pfx und .p12.
    • Clientzertifikatpasswort – Das Passwort, das während des Exports der Clientzertifikatdatei festgelegt wurde.

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).
• Bei Fehler fortsetzen – Gibt an, ob die Automatisierung fortgesetzt werden soll, auch wenn die Aktivität einen Fehler ausgibt. Dieses Feld unterstützt nur boolesche Werte (true, false). Der Standardwert ist „false“. Wenn das Feld also nicht konfiguriert ist und ein Fehler auftritt, wird die Ausführung des Projekts angehalten. Wenn der Wert auf „true“ gesetzt ist, wird die Ausführung des Projekts unabhängig von einem Fehler fortgesetzt.
• SSL-Zertifikatüberprüfung – Wenn diese Option ausgewählt ist, werden SSL-Zertifikate beim Senden einer Anforderung überprüft. Fehler bei der Überprüfung führen dazu, dass die Anforderung abgebrochen wird.
• Format akzeptieren ( Accept Format ) - Das Format, in dem die Antwort des Webservers empfangen werden soll. Die folgenden Optionen werden unterstützt: ANY – der Standardwert, XML, JSON und CUSTOM. Wenn Sie das CUSTOM AcceptFormat auswählen und ein Accept - oder accept -Header-Parameter vorhanden ist, wird er 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

  .
• Dateianhänge – Liste der Anhänge für die Anforderung.
• Dateiname für Antwortanlage – Der Dateiname, der für die von der Anforderung zurückgegebene Datei verwendet werden soll.
• TextkörperFormat (BodyFormat) - Das Format, in dem der Textkörper sein muss. Standardmäßig wird dies mit application/xml ausgefüllt. Dieses Feld unterstützt nur Strings und Stringvariablen.
• Cookies – Die Cookies in der HTTP-Anforderung. Klicken Sie auf das Feld, um das Fenster Wörterbuch zu öffnen.
• URL-Segmente – Benutzerdefinierte Segmente, die der Endpunkt-URL zwischen geschweiften Klammern „{}“ hinzugefügt werden. Klicken Sie auf das Feld, um das Fenster Wörterbuch zu öffnen. Beispielsweise kann die URL https://platform.uipath.com/odata/Robots(28) als https://platform.uipath.com/odata/Robots{id}geschrieben werden und der Wert des Parameters id kann im Fenster Wörterbuch angegeben werden. Dieses Feld unterstützt Zeichenfolgen und Zeichenfolgenvariablen.

Ausgabe

• Antwortinhalt – Die von der HTTP-Anforderung empfangene Antwort als Zeichenfolgenvariable.
• Antwortstatus – Der von der HTTP-Anforderung empfangene Statuscode als Integer-Variable.
• Antwortheader – Die von der HTTP-Anforderung empfangene Antwort.
• Antwortanhang – Der aus der Antwort gespeicherte Anhang.

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 im Assistenten vorhandenen Felder sind auch im Panel Eigenschaften verfügbar. Daher können Sie Ihre Einstellungen nach dem Schließen des Assistenten noch bearbeiten. Sie können die Aktivität im Assistenten mithilfe von hartcodierten Werten oder Variablen konfigurieren.

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

Die Registerkarte Anfragegenerator (Request Builder Tab)

• Endpunkt (End Point) - Die URL, an die Sie Ihre Anfrage senden möchten. Benutzerdefinierte Segmente müssen zwischen geschweiften Klammern „{}“ platziert und im Abschnitt Parameter definiert werden. 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 Abschnitt Parameter als UrlSegment bereitgestellt werden.
• 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.
• SSL-Zertifikatüberprüfung aktivieren – Aktivieren Sie dieses Kontrollkästchen, um SSL-Zertifikate beim Senden einer Anforderung zu überprüfen. Fehler bei der Überprüfung führen dazu, dass die Anforderung abgebrochen wird.
• Auszeit (Timeout) - Gibt die Wartezeit (in Millisekunden) bis zur Fehlerausgabe einer laufenden Aktivität an. Der Standardwert ist 6000 Millisekunden (6 Sekunden).

• Clientzertifikat - Der Speicherort, an dem die Clientzertifikatdatei gespeichert ist. Der vollständige Pfad muss angegeben werden.

  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 - Gibt an, dass die hinzugefügte Zeile ein Fragment oder die URL ist, die im Feld Endpunkt angegeben ist.

    Hinweis: In einigen Fällen kann ein Fehler zurückgegeben werden, der besagt, dass keine doppelten Parameter vorhanden sein können. Diese können durch Authentifizierungsanforderungen verursacht werden, die die Parameter Password und Username enthalten müssen. In diesen Fällen empfehlen wir, sie mit der Eigenschaft 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. 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-Panel

Client-Zertifikatsauthentifizierung (Client Certificate Authentication)

• Clientzertifikat – Der vollständige Pfad zum Speicherort der Clientzertifikatdatei. Die unterstützte Zertifikatscodierung ist X.509 und die unterstützten Erweiterungen sind .pfx und .p12.
• Clientzertifikatpasswort – Das Passwort, das während des Exports der Clientzertifikatdatei festgelegt wurde.
• SSL-Zertifikatüberprüfung aktivieren – Überprüfen Sie SSL-Zertifikate beim Senden einer Anforderung. Fehler bei der Überprüfung führen dazu, dass die Anforderung abgebrochen wird. Dieses Feld unterstützt nur boolesche Werte (True, False).
• SecureClientCertificatePassword – Das Kennwort für die angegebene Clientzertifikatdatei in Form einer sicheren Zeichenfolge. Dieses Feld unterstützt nur SecureString-Variablen.

Allgemein

• BeiFehlerFortfahren (ContinueOnError) - Gibt an, ob die Automatisierung auch bei Auftreten eines Fehlers weiterlaufen soll. Das Feld unterstützt nur Boolesche Werte (Wahr, Falsch). Der Standardwert ist Falsch. Dadurch wird die Ausführung des Projekts beim Auftreten eines Fehlers angehalten, wenn das Feld leer. Wenn der Wert auf Wahr gesetzt ist, wird das Projekt weiter ausgeführt, auch wenn Fehler auftreten.

  Hinweis: Wenn diese Aktivität in Try Catch enthalten ist und der Wert der Eigenschaft BeiFehlerFortsetzen auf „True“ gesetzt ist, wird kein Fehler beim Ausführen des Projekts aufgefangen.
• 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 - Das Format, in dem die Antwort des Webservers empfangen werden soll. Die folgenden Optionen werden unterstützt: ANY – der Standardwert, XML, JSONund CUSTOM. Wenn Sie CUSTOM AcceptFormat auswählen und ein Accept - oder accept -Header-Parameter vorhanden ist, wird er als benutzerdefiniertes Akzeptanzformat gesendet. Wenn kein Headerparameter festgelegt ist, erhält accept den RestSharp-Standardwert: application/json, application/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.
• Anforderungs-URL – Die URL, an die Sie die Anforderung stellen möchten. Benutzerdefinierte Segmente müssen zwischen geschweiften Klammern „{}“ platziert und im Abschnitt Parameter definiert werden. 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.

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 (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.
• TextkörperFormat (BodyFormat) - Das Format, in dem der Textkörper sein muss. Standardmäßig wird dies mit application/xml ausgefüllt. Dieses Feld unterstützt nur Strings und Stringvariablen.
• Cookies – Die Cookies in der HTTP-Anforderung. Klicken Sie auf die Schaltfläche mit den Auslassungspunkten , um das Fenster Cookies zu öffnen.
• Dateianhänge – Liste der Anhänge für die Anforderung.
• Dateiname für Antwortanlage – Der Dateiname, der für die von der Anforderung zurückgegebene Datei verwendet werden soll.
• 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.
• Parameter (Parameters) - Die Anfrageparameter. Klicken Sie auf die Schaltfläche Ellipse (Ellipsis), um das Fenster Parameter (Parameters) zu öffnen. Das Fenster entspricht dem Bereich Parameter (Parameters).
• UrlSegmente (UrlSegments) - Benutzerdefinierte Segmente, die in eckigen Klammern "{}" der Endpunkt-URL hinzugefügt wurden. Klicken Sie auf die Schaltfläche Ellipse (Ellipsis), um das Fenster URLSegmente (URLSegments) 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

• Header – Die von der HTTP-Anforderung empfangene Antwort.
• Antwortanhang – Der aus der Antwort gespeicherte Anhang.
• Antwortinhalt – Die von der HTTP-Anforderung empfangene Antwort als Zeichenfolgenvariable.
• Antwortstatus – Der von der HTTP-Anforderung empfangene Statuscode als 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 – Gibt an, dass der Webdienst die sichere Authentifizierung verwendet und Ihnen die Eingabe Ihres sicheren Zeichenfolgenkennworts ermöglicht. Die Eingabe eines Benutzernamens ist auch erforderlich. Diese Eigenschaft unterstützt sichere String-Variablen.
• 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.