orchestrator
2023.10
false
UiPath logo, featuring letters U and I in white

Anleitung für die Orchestrator-API

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Letzte Aktualisierung 18. Dez. 2024

Lizenzabfragen

Abfragen aller beaufsichtigten Roboter mit einer benannten Benutzerlizenz

Die folgende Abfrage an den Endpunkt odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') ermöglicht Ihnen, alle beaufsichtigten Roboter abzufragen, die mit einer benannten Benutzerlizenz lizenziert sind.
Hinweis: Diese Abfrage ergibt maximal 1.000 Einträge.

Abrufen

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')

Anforderungsheader

Schlüssel

Wert

Autorisierung

Inhaber

Antwortcode

200 OK

Antworttext

{
  "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#NamedUserLicenses",
  "@odata.count": 1,
  "value": [
    {
      "UserName": "uipath\\documentation",
      "Key": "uipath\\documentation",
      "LastLoginDate": "2018-09-19T10:44:45.757Z",
      "MachinesCount": 1,
      "IsLicensed": false,
      "ActiveRobotId": null,
      "MachineNames": [
        "MINDAGOMIR"
      ],
      "ActiveMachineNames": []
    }
  ]
}{
  "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#NamedUserLicenses",
  "@odata.count": 1,
  "value": [
    {
      "UserName": "uipath\\documentation",
      "Key": "uipath\\documentation",
      "LastLoginDate": "2018-09-19T10:44:45.757Z",
      "MachinesCount": 1,
      "IsLicensed": false,
      "ActiveRobotId": null,
      "MachineNames": [
        "MINDAGOMIR"
      ],
      "ActiveMachineNames": []
    }
  ]
}

Enabling or Disabling a Machine

Das folgende Beispiel deaktiviert die Dokumentationsmaschine, sodass die damit verbundenen Roboter keine NonProduction-/Unattended-Lizenzen verbrauchen.

Sie können auch einen Computer mit einer Abfrage an den Endpunkt /odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled aktivieren. Dazu müssen Sie den Parameter enabled auf true stellen.

Posten

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabled

Anforderungsheader

Schlüssel

Wert

Autorisierung

Inhaber

Anforderungstext

{
    "key": "Documentation",
    "robotType": "Unattended",
    "enabled": false
}{
    "key": "Documentation",
    "robotType": "Unattended",
    "enabled": false
}

Antwortcode

200 OK

Abrufen von Lizenzinformationen

Folgende Abfrage kann nur jeweils für einen Mandanten durchgeführt werden. Wenn Sie Swagger verwenden, wird diese Abfrage an den Mandanten gerichtet, bei dem Sie in Orchestrator angemeldet sind, wenn Sie die Anfrage durchführen. Wenn Sie ein API-Test-Tool verwenden, ist der Mandant, für den Sie die Abfrage durchführen, derjenige, der zum Generieren des Bearer-Tokens verwendet wird.

Abrufen

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetLicense

Anforderungsheader

Schlüssel

Wert

Autorisierung

Inhaber

Antwortcode

200 OK

Antworttext

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
    "ExpireDate": 1545392350,
    "IsRegistered": true,
    "Concurrent": false,
    "IsExpired": false,
    "AllowedRobots": {
        "Unattended": 50,
        "Attended": 50,
        "NonProduction": 50,
        "Development": 50
    },
    "DefinedRobots": {
        "Unattended": 1,
        "Attended": 0,
        "NonProduction": 3,
        "Development": 1
    },
    "ConcurrentRobots": {
        "Unattended": 0,
        "Attended": 0,
        "NonProduction": 0,
        "Development": 0
    }
}{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
    "ExpireDate": 1545392350,
    "IsRegistered": true,
    "Concurrent": false,
    "IsExpired": false,
    "AllowedRobots": {
        "Unattended": 50,
        "Attended": 50,
        "NonProduction": 50,
        "Development": 50
    },
    "DefinedRobots": {
        "Unattended": 1,
        "Attended": 0,
        "NonProduction": 3,
        "Development": 1
    },
    "ConcurrentRobots": {
        "Unattended": 0,
        "Attended": 0,
        "NonProduction": 0,
        "Development": 0
    }
}

War diese Seite hilfreich?

Hilfe erhalten
RPA lernen – Automatisierungskurse
UiPath Community-Forum
Uipath Logo White
Vertrauen und Sicherheit
© 2005–2024 UiPath. Alle Rechte vorbehalten