Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

REST Web Service-package

  • Aktualisiert: 2022/02/20
    • Automation 360 v.x
    • Erstellen
    • RPA Workspace

REST Web Service-package

Verwenden Sie die actions im REST Web Service-package als Methoden (DELETE, GET, PATCH, POST oder PUT), um Anforderungen an eine API zu senden und Antworten von ihr zu erhalten.

Arbeiten mit REST Web Service-actions

Geben Sie die folgenden Informationen an, um eine REST-Anforderung zu senden und eine Antwort zu erhalten. Nicht alle Parameter sind für alle Methoden erforderlich.
  • URI: Eindeutige Adresse für eine API-Ressource.
  • Authentifizierungsmodus: Es gibt drei unterstützte Authentifizierungsmodi:
    • Basic: Textzeichenfolgen können für die grundlegende Authentifizierung verwendet werden.
    • Angemeldeter AD-Nutzer: Active Directory-Nutzer, die zum Zugriff auf die entsprechende API berechtigt sind, werden über das AD authentifiziert. Für die Anforderung sind keine Anmeldedaten erforderlich.
    • Authentifizierung über Windows NT LAN Manager (NTLM) (AD-Nutzer): Challenge/Response-Authentifizierungsmethode, mit der Clients ihren Nutzernamen und ihr Passwort als verschlüsselte Anmeldedaten oder als Klartext angeben können. Wir empfehlen, dass Sie Anmeldedaten verwenden, die im Automation Anywhere-Credential Vault gespeichert sind.
  • Header: Nicht alle Methoden benötigen einen Header. Ein Header enthält die mit der Anforderung verbundenen Metadaten.
    Anmerkung: Um einen API-Schlüssel in Ihrer Anforderung zu verwenden, geben Sie api_key im Feld Name des Headers ein und den Schlüsselwert in das Feld Wert.
  • Fehlerreaktion erfassen: Aktivieren Sie das Kontrollkästchen, um die Fehlerreaktion zu erfassen (mit Ausnahme der Antwort Erfolg/OK). Die Einzelheiten der Fehlerreaktion werden im Antwortkörper festgehalten.
  • Unsichere Verbindung bei https erlauben: Aktivieren Sie das Kontrollkästchen, um eine unsichere Verbindung bei der Verwendung von https zu erlauben.
  • Inhaltstyp: Wenn ein Header einen Inhaltstyp enthält, definiert dieser die Content Negotiation Inhaltsvereinbarung zwischen dem Client und dem Server. REST Web Service-actions unterstützen folgende Dateitypen:
    • application/json
    • application/xml
    • text/plain
    • text/html
    • text/xml
    • Mehrteilig/Formulardaten
  • Auf Abschluss der Aktion warten: Sie können einen Timeout-Wert festlegen, wenn Sie eine REST-Anforderung senden und eine Antwort erhalten. Bei der Durchführung von actions wie POST, PUT, DELETE, PATCH oder GET können sie in der Spalte Auf Abschluss der Aktion warten die Wartezeit in Millisekunden angeben. Standardmäßig beträgt die Wartezeit 60.000 Millisekunden.
  • Ausgabevariable: Die Antwortausgabe wird in einer Wörterbuchvariablen erfasst. Eine Wörterbuchvariable ist ein Paar aus Schlüssel und Wert. Verwenden Sie den Namen des Antwort-Headers als Schlüssel, um den Header-Wert zurückzugeben, oder verwenden Sie „Body“ als Schlüssel, um den Antwortkörper zurückzugeben.
    Anmerkung: Der Antwortschlüssel mit seinem Wert ist in der Wörterbuchvariablen verfügbar, um den Antwortstatus der REST-API anzuzeigen.
    Führen Sie die folgenden Schritte aus, um eine Liste der Header-Namen für die API-Ressource zu erhalten:
    1. Fügen Sie nach der REST Web Service-action eine Loop-action ein.
    2. Wählen Sie den Iterator Für jeden Schlüssel im Wörterbuch aus.
    3. Wählen Sie im Feld Wörterbuchvariable die Variable aus, die als Ausgabe die REST Web Service-action enthält.
    4. Weisen Sie $prompt-assignment$ den Wert jedes Schlüssels zu.
    5. Fügen Sie eine Log To File-action ein.
    6. Geben Sie den Dateipfad zu einer Textdatei an, die die Liste der Header-Namen enthält.
    7. Fügen Sie $prompt-assignment$ im Feld Zum Protokollieren Text eingeben ein.
    8. Wählen Sie die Option Vorhandene Datei überschreiben.
    9. Klicken Sie auf Speichern.

      Wenn Sie den bot ausführen, druckt er die Header-Namen aus der API-Ressource in die ausgewählte Datei.

Werte sicher übermitteln

Sie können Werte sicher vom Credential Vault an den Webdienst übermitteln, indem Sie den locker, die Anmeldedaten und das Attribut in den folgenden unterstützten action-Feldern angeben:
  • URI
  • Benutzerdefinierte Header
  • Textkörper: Für den Inhaltstyp application/x-www-form-urlencoded klicken Sie auf Parameter hinzufügen und wählen Sie den Wert aus dem Credential Vault.

    Für alle anderen Inhaltstypen wählen Sie die Option Anmeldedaten als Parameter auswählen und klicken Sie auf Wählen.

Actions im REST Web Service-package

Action Beschreibung
DELETE-Methode Entfernt die Ressource, die durch den URI identifiziert wird.
GET-Methode Ruft Informationen ab, die durch die im URI enthaltenen Parameter identifiziert werden. Es gibt keinen Inhaltstyp für die GET-Methode, da alle Parameter als Teil des URI übergeben werden.

Die GET-Methode hat folgende Beschränkungen und Merkmale:

  • Die URI-Länge ist auf 2048 Zeichen begrenzt.
  • Alle Parameter werden im URI übergeben.
  • Die GET-Methode gibt Daten preis, die im URI enthalten sind. Sie ist daher weniger sicher als die POST-Methode.
  • Die GET-Methode ändert keine Daten und ist daher für alle Nutzer unabhängig von deren Berechtigung sicher.
Patch-Methode Ändert die Ressource, die durch den URI identifiziert wird.
POST-Methode Erzeugt eine neue Ressource im URI.
  • Die Parameter werden im Anforderungstext übergeben.
  • Es gibt keine Längenbeschränkung für einen Anforderungstext.
PUT-Methode Aktualisiert oder ersetzt eine Ressource anhand von Parametern, die im URI oder im Textkörper übergeben werden.

Proxy-Support

Wenn Ihr Gerät mit einem Proxy konfiguriert ist, werden alle ausgehenden Anforderungen von diesem package über den Proxyserver geleitet. Einzelheiten finden Sie unter Den Bot agent mit einem Gerät mit Proxy verbinden.

Feedback senden