Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

Gerätedetails anfordern

  • Aktualisiert: 2020/07/10
    • Automation 360 v.x
    • Erkunden
    • RPA Workspace

Gerätedetails anfordern

Verwenden Sie diese API, um eine Liste von Geräten abzurufen, die für die bot Bereitstellung.

Vorbereitungen

Rollen und Lizenz
Sie müssen sich als Benutzer mit einer Unbeaufsichtigte Bot-Runner-Lizenz.
  • URL:
    http://<your_control_room_url>/v2/devices/list
  • Methode: POST
Unterstützte filterbare Parameter:
id
Der numerische Bezeichner für ein Gerät.
  • Feld: id
  • Typ: Ganzzahl
{
  "filter": {
    "operator": "eq",
    "value": "7",
    "field": "id"
  }
}
hostName
Der Name des registrierten Geräts.
  • Feld: hostName
  • Typ: string
{
  "filter": {
    "operator": "substring",
    "value": "AA",
    "field": "hostName"
  }
}
userId
Eine eindeutige numerische Kennung für den mit dem registrierten Gerät verbundenen Benutzer.
  • Feld: userId
  • Typ: long
{
  "filter": {
    "operator": "eq",
    "value": "13",
    "field": "userId"
  }
}
Status
Der Verbindungsstatus des Geräts.
  • Feld: Status
  • Typ: string
{
  "filter": {
     "operator": "eq",
     "value": "CONNECTED",
     "field": "status"
      }
}

Diese Aufgabe fordert eine Liste aller Geräte an, die eine bestimmte Zeichenfolge im Hostname Parameter und einem bestimmten Status des Geräts. Verwenden Sie die Liste in der Antwort, um festzustellen, welche Geräte angeschlossen und für die Ausführung verfügbar sind bots.

Prozedur

  1. Verwenden Sie die POST Methode, um ein JSON-Web-Token für die Authentifizierung zu erzeugen. Fügen Sie das generierte Authentifizierungs-Token in die Kopfzeile der Anfrage ein.
  2. Wählen Sie die POST-Methode.
  3. Geben Sie die URL für die API ein:
    https://<your_control_room_url>/v2/devices/list
  4. Fügen Sie im Anfragetext die Filter-, Sortier- und Paginierungsregeln hinzu, um die Geräteliste abzurufen, die Sie bereitstellen möchten.
    Anmerkung: Die Felder Array-Filterparameter im Anfragekörper wird derzeit nicht unterstützt. Wenn Sie den Feldnamen im Anforderungsrumpf senden, um die Anzahl der Felder in der Antwort einzuschränken, funktioniert es nicht wie erwartet und gibt stattdessen alle Felder zurück.
    In diesem Anfragetext wird zum Beispiel "und" als Operator und die Geräte "status" und "hostname" als Feld um die gewünschten Ergebnisse zu filtern. Die Ergebnisse werden in "absteigender" Reihenfolge nach "Status" sortiert.
    {
      "sort": [
        {
          "field": "status",
          "direction": "desc"
        }
      ],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "eq",
            "value": "CONNECTED",
            "field": "status"
          },
          {
            "operator": "substring",
            "value": "win",
            "field": "hostName"
          }
        ]
      },
      "fields": [
        
      ],
      "page": {
        "offset": 0,
        "total": 71,
        "totalFilter": 18,
        "length": 100
      }
    }
  5. Senden Sie die Anforderung.
    • Klicken Sie in einem REST-Client auf SENDEN.
    • Klicken Sie in der Swagger-Schnittstelle auf Ausführen.

    Antworttext:

    Die Antwort gibt die Details von zwei Geräten zurück, die sich im Status "verbunden" befinden Status befinden befinden und für die der Hostname mit "win" beginnt, basierend auf den angeforderten Filterkriterien.
    {
      "page": {
        "offset": 0,
        "total": 71,
        "totalFilter": 7
      },
      "list": [{
        "id": "163",
        "type": "ATTENDED_BOT_RUNNER",
        "hostName": "winwlm-2",
        "userId": "",
        "userName": "",
        "status": "CONNECTED",
        "poolName": "",
        "fullyQualifiedHostName": "-",
        "updatedBy": "b2",
        "updatedOn": "2020-07-07T08:24:56.091061Z",
        "botAgentVersion": "12.1"
      }, {
        "id": "162",
        "type": "ATTENDED_BOT_RUNNER",
        "hostName": "winwlm-1",
        "userId": "",
        "userName": "",
        "status": "CONNECTED",
        "poolName": "",
        "fullyQualifiedHostName": "-",
        "updatedBy": "b1",
        "updatedOn": "2020-07-07T08:24:55.982047Z",
        "botAgentVersion": "12.1"
      }
    }

Nächste Maßnahme

Sie können die in der Antwort erhaltenen Geräte-IDs verwenden, um die bots auf Bot Runners.
Feedback senden