Roboteranfragen

Abrufen von Roboterstatus

Hinweis: Wenn Sie den Wert des Parameters LicenseKey extrahieren möchten, müssen Sie eine GET-Abfrage an den Endpunkt /odata/Robots(Id) richten.

Entsprechend der ID

Im folgenden Beispiel zeigen Sie den aktuellen Status des Roboters mit der ID 749 an.

Abrufen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Sessions?$top=10&$filter=Robot/Id eq 749&$select=State

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Sessions(State)",
    "@odata.count": 1,
    "value": [
        {
            "State": "Available"
        }
    ]
}

Nach dem Namen

Im folgenden Beispiel zeigen Sie den aktuellen Status des Roboters mit dem Namen DocBot an.

Abrufen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Sessions?$top=10&$filter=Robot/Name eq 'DocBot'&$select=State

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Sessions(State)",
    "@odata.count": 1,
    "value": [
        {
            "State": "Available"
        }
    ]
}

Abfragen der Roboterinformationen nach dem Status: Beispiel 1

Im folgenden Beispiel werden die ersten 10 Roboter abgefragt, die den Status „verfügbar“ haben und in den letzten 2 Minuten ein Heartbeat gesendet haben. Nur die relevanten Roboterinformationen werden angezeigt. Sie können den Heartbeat überprüfen, indem Sie den Parameter Berichtszeit (Reporting Time) verwenden und zwei Minuten von der aktuellen Zeit abziehen. Wie Sie vielleicht wissen, werden Roboter als „nicht antwortend“ gekennzeichnet, wenn sie in den letzten 2 Minuten keinen Heartbeat gesendet haben.

Abrufen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Sessions?$top=10&$filter=State eq 'Available' and ReportingTime gt 2018-03-05T03:48:04.147Z&$select=Robot&$expand=Robot

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Sessions(Robot)",
    "@odata.count": 2,
    "value": [
        {
            "Robot": {
                    "LicenseKey": null,
                "MachineName": "MBOBOC",
                "Name": "DocBot",
                "Username": "UIPATH\\MADALINA.BOBOC",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "doc_env,WR_env,Group1",
                "Id": 749,
                "ExecutionSettings": null
            }
        },
        {
            "Robot": {
                    "LicenseKey": null,
                "MachineName": "midragomir",
                "Name": "mr-Rob",
                "Username": "uipath\\mircea.dragomir",
                "Description": "Alerts",
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "",
                "Id": 902,
                "ExecutionSettings": null
            }
        }
    ]
}

Abfragen der Roboterinformationen nach dem Status: Beispiel 2

Im folgenden Beispiel werden die ersten 10 Roboter abgefragt, die den Status „Getrennt“ haben und Roboterinformationen erweitern.

Abrufen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Sessions?$top=10&$filter=State eq 'Disconnected'&$expand=Robot

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Sessions",
    "@odata.count": 2,
    "value": [
        {
            "State": "Disconnected",
            "ReportingTime": "2018-01-15T18:47:07.93Z",
            "Info": null,
            "IsUnresponsive": false,
            "Id": 718,
            "Robot": {
                    "LicenseKey": null,
                "MachineName": "DESKTOP-PMFQGCB",
                "Name": "Stan",
                "Username": "Alex",
                "Description": null,
                "Type": "Unattended",
                "Password": null,
                "RobotEnvironments": "doc_env,a_invoke_env,Group1",
                "Id": 759,
                "ExecutionSettings": null
            }
        },
        {
            "State": "Disconnected",
            "ReportingTime": "2018-01-18T18:14:14.34Z",
            "Info": null,
            "IsUnresponsive": false,
            "Id": 730,
            "Robot": {
                    "LicenseKey": null,
                "MachineName": "DESKTOP-PMFQGCB",
                "Name": "!~#$%^&*()_+=-",
                "Username": "dragomirmir",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "WR_env",
                "Id": 771,
                "ExecutionSettings": null
            }
        }
    ]
}

Abfragen der Roboterinformationen nach der ID

Im folgenden Beispiel werden die Details des Roboters mit der ID 216 abgefragt. Bitte beachten Sie, dass dieser Roboter SmartCard-Authentifizierung verwendet.

Abrufen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Robots(216)

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Robots/$entity",
    "LicenseKey": "fc157179-3724-4bb0-acd2-8261bef82d01",
    "MachineName": "CAPETRINA",
    "MachineId": 15,
    "Name": "Gustavee",
    "Username": "uipath\\john.smith",
    "ExternalName": null,
    "Description": null,
    "Type": "Development",
    "HostingType": "Standard",
    "ProvisionType": "Manual",
    "Password": null,
    "CredentialStoreId": null,
    "UserId": 45,
    "Enabled": true,
    "CredentialType": null,
    "RobotEnvironments": "",
    "IsExternalLicensed": false,
    "LimitConcurrentExecution": false,
    "Id": 216,
    "ExecutionSettings": {
        "ResolutionHeight": 0,
        "ResolutionDepth": 0,
        "FontSmoothing": false,
        "AutoDownloadProcess": false
    }
}

Abfragen aller Roboter, die einen bestimmten Prozess ausführen können

Im folgenden Beispiel wird eine Abfrage an /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess durchgeführt. Damit können Sie auf einfache Weise feststellen, welcher Roboter das Paket mit der ID input_output_arguments_example ausführen kann.

Abrufen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId='input_output_arguments_example')

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
  "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Robots",
  "@odata.count": 2,
  "value": [
    {
      "LicenseKey": null,
      "MachineName": "DESKTOP-ASBD",
      "MachineId": 129,
      "Name": "Stan",
      "Username": "Alex",
      "Description": null,
      "Version": null,
      "Type": "Unattended",
      "HostingType": "Standard",
      "Password": null,
      "RobotEnvironments": "doc_env,a_invoke_env,Group1",
      "Id": 759,
      "ExecutionSettings": null
    },
    {
      "LicenseKey": null,
      "MachineName": "Doc",
      "MachineId": 1066,
      "Name": "DocBot",
      "Username": "uipath\\documentation",
      "Description": null,
      "Version": "18.3.0.558",
      "Type": "NonProduction",
      "HostingType": "Standard",
      "Password": null,
      "RobotEnvironments": "doc_env",
      "Id": 1684,
      "ExecutionSettings": null
    }
  ]
}

Abrufen von Roboterprotokollen anhand des Roboternamens

Im folgenden Beispiel können Sie Roboterprotokolle für den Roboter mit dem Namen DocBot anzeigen.

Abrufen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/RobotLogs?$top=100&$skip=200&$filter=RobotName eq 'DocBot'

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#RobotLogs",
    "@odata.count": 202,
    "value": [
        {
            "Level": "Info",
            "WindowsIdentity": "UIPATH\\john.smith",
            "ProcessName": "TestingSequence_DOC",
            "TimeStamp": "2019-10-14T13:55:18.2473626Z",
            "Message": "TestingSequence_DOC execution started",
            "JobKey": "e49c0012-ee01-45e4-884c-0ce1f2aa6fbb",
            "RawMessage": "{\r\n  \"message\": \"TestingSequence_DOC execution started\",\r\n  \"level\": \"Information\",\r\n  \"logType\": \"Default\",\r\n  \"timeStamp\": \"2019-10-14T13:55:18.2473626+00:00\",\r\n  \"fingerprint\": \"972a32c3-95d9-4264-ae5d-af589bf4f0b5\",\r\n  \"windowsIdentity\": \"UIPATH\\\\petrina.calota\",\r\n  \"machineName\": \"LAPTOP-IN7198N3\",\r\n  \"processName\": \"TestingSequence_DOC\",\r\n  \"processVersion\": \"1.1.7024.37929\",\r\n  \"jobId\": \"e49c0012-ee01-45e4-884c-0ce1f2aa6fbb\",\r\n  \"robotName\": \"G\",\r\n  \"machineId\": 229978,\r\n  \"organizationUnitId\": 67543,\r\n  \"fileName\": \"Main\"\r\n}",
            "RobotName": "DocBot",
            "MachineId": 229978,
            "Id": 0
        },
        {
            "Level": "Info",
            "WindowsIdentity": "UIPATH\\john.smith",
            "ProcessName": "TestingSequence_DOC",
            "TimeStamp": "2019-10-14T13:57:21.4985672Z",
            "Message": "TestingSequence_DOC execution ended",
            "JobKey": "e49c0012-ee01-45e4-884c-0ce1f2aa6fbb",
            "RawMessage": "{\r\n  \"message\": \"TestingSequence_DOC execution ended\",\r\n  \"level\": \"Information\",\r\n  \"logType\": \"Default\",\r\n  \"timeStamp\": \"2019-10-14T13:57:21.4985672+00:00\",\r\n  \"fingerprint\": \"e973b4f2-deec-4290-978b-3a8af0769b35\",\r\n  \"windowsIdentity\": \"UIPATH\\\\petrina.calota\",\r\n  \"machineName\": \"LAPTOP-IN7198N3\",\r\n  \"processName\": \"TestingSequence_DOC\",\r\n  \"processVersion\": \"1.1.7024.37929\",\r\n  \"jobId\": \"e49c0012-ee01-45e4-884c-0ce1f2aa6fbb\",\r\n  \"robotName\": \"G\",\r\n  \"machineId\": 229978,\r\n  \"organizationUnitId\": 67543,\r\n  \"totalExecutionTimeInSeconds\": 123,\r\n  \"totalExecutionTime\": \"00:02:03\",\r\n  \"fileName\": \"Main\"\r\n}",
            "RobotName": "DocBot",
            "MachineId": 229978,
            "Id": 0
        }
  ]
}

Hinweis:

GET-Anforderungen für Roboterprotokolle, die mit Elasticsearch gespeichert werden, rufen nur die ersten 10.000 Einträge ab. Dies ist auf eine Elasticsearch-Einschränkung zurückzuführen und tritt nicht auf, wenn Sie SQL verwenden.

Die Verwendung von $top - und $skip -Parametern, die die Grenze von 10.000 überschreiten, gibt die folgende Fehlermeldung zurück: „Depth of pagination is limited in Elasticsearch by the max_result_window Indexeinstellung. Stellen Sie sicher, dass überspringen + nehmen weniger als 10.000".

Beim Parametrisieren von Anforderungen für Roboterprotokolle, die mit Elasticsearch gespeichert werden, werden nur die folgenden Bedingungs-Verb-Kombinationen unterstützt: RobotName eq, JobKey eq, MachineId eq, Level ge, TimeStamp gt.

Bearbeiten von Roboterinformationen

Im folgenden Beispiel werden Typ und Name des Roboters mit der 749-ID geändert und die Konfiguration der Ausführungseinstellungen geändert. Denken Sie daran, X-UIPATH-OrganizationUnitId in den Anforderungsheader und die Roboter-ID und den Maschinennamen in den Anforderungstext aufzunehmen.

Hinweis:

Bitte berücksichtigen Sie bei PUT-Abfragen an die Roboter-Endpunkte Folgendes:

• Der Benutzername und das Passwort des Roboters werden nicht aktualisiert, wenn Sie denselben Benutzernamen und ein Null- oder leeres Passwort senden.
• Wird ein neuer Benutzername mit einem Null- oder leeren Passwort gesendet, werden die Roboter-Anmeldedaten aktualisiert und der neue Benutzername wird verwendet.

PUT

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Robots(749)

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber
X-UIPATH-OrganizationUnitId	Die Containerordner-ID. Beispiel: 36886.

Anforderungstext

{
  "LicenseKey": "8ec4t984-b2d7-44f2-b5be-0a64ee9a487b",
  "MachineName": "MBOBOC",
  "Name": "DocBot",
  "Type": "Development",
  "Id": 749,
  "Username": "UIPATH\\JustAnotherRobot",
  "ExecutionSettings":{
        "TracingLevel":"Information",
        "StudioNotifyServer":true,
        "LoginToConsole":false,
        "ResolutionWidth":0,
        "ResolutionHeight":0,
        "ResolutionDepth":0,
        "FontSmoothing":false,
        "AutoDownloadProcess":false
    }
}

Antwortcode

200 OK

Löschen eines Roboters

Löschen eines einzelnen Roboters

Um einen bestimmten Roboter zu löschen, führen Sie eine DELETE- Anforderung an den odata/Robots({robot_id}) -Endpunkt aus.

Löschen

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Robots(79)

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Antwortcode

204 Kein Inhalt

Löschen mehrerer Roboter

Um mehrere Roboter gleichzeitig zu löschen, müssen Sie eine POST-Abfrage an den Endpunkt /Robots/UiPath.Server.Configuration.OData.DeleteBulk durchführen.

Posten

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Robots/UiPath.Server.Configuration.OData.DeleteBulk

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
    "robotIds": [119, 120]
}

Antwortcode

204 Kein Inhalt

Aktualisieren des Kennworts für Ihren eigenen Unattended-Roboter

Wenn Sie den folgenden Endpunkt aufrufen, wird das Kennwort Ihres eigenen Unattended-Roboters aktualisiert, indem Sie Ihre Benutzer-ID eingeben (angenommen, Ihre Benutzer-ID ist 88). Für diesen Vorgang sind keine Bearbeitungsberechtigungen für Benutzererforderlich.

Hinweis: Wenn Sie das Kennwort eines anderen Roboters aktualisieren möchten, stellen Sie eine PUT-Anforderung an denselben Endpunkt unter Verwendung der ID des jeweiligen Benutzers.

PATCH

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Users(88)

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
"UnattendedRobot": 
   {
    "Password": "newUnattendedRobotP@ss"
    }
}

Antwortcode

200 OK