Requêtes relatives aux licences

Récupération de tous les Robots Attended ayant une licence Named User

L'appel suivant effectué vers le point de terminaison odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') permet de récupérer tous les Robots Attended ayant une licence Named User.

Remarque : Cette requête renvoie un maximum de 1 000 entrées.

Obtenir

{OrchestratorURL}/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
  "@odata.context": "{OrchestratorURL}/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

L'exemple suivant désactive la machine Documentation pour que les Robots qui y sont connectés n'utilisent pas les licences NonProduction/Unattended.

Vous pouvez également activer une machine avec une requête effectuée vers le point de terminaison /odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled, en définissant le paramètre enabled sur true.

Publier

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

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Corps de la requête

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

Codes de réponse

200 OK

Récupération des informations de la licence

La requête suivante ne peut être effectuée que sur un locataire à la fois. Si vous utilisez Swagger, cette requête est exécutée sur le locataire avec lequel vous êtes connecté dans Orchestrator lorsque vous effectuez la requête. Si vous utilisez un outil de test API, le locataire pour lequel vous effectuez cette requête est celui utilisé pour générer le jeton du porteur.

Obtenir

{OrchestratorURL}/odata/Settings/UiPath.Server.Configuration.OData.GetLicense

En-têtes de requête.

Clé (Key)	Valeur (Value)
Autorisation	Porteur

Codes de réponse

200 OK

Corps de la réponse

{
    "@odata.context": "{OrchestratorURL}/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
    }
}