Solicitações de licenças

Exemplos de solicitação de API para recuperar informações de licença de Named User para robôs do Orchestrator

Recuperação de todos os robôs attended com uma licença Named User

A chamada a seguir para o ponto de extremidade odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') permite que você recupere todos os robôs assistidos licenciados com uma licença de usuário nomeado.

Observação:

Essa solicitação retorna um máximo de 1.000 entradas.

Obter

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

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Código de resposta

200 OK

Corpo da Resposta

{
  "@odata.context": "https://{yourDomain}/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": []
    }
  ]
}

Habilitação ou desabilitação de uma máquina

O exemplo a seguir desabilita a máquina Documentation, para que os UiPath Robots conectados a ela não consumam licenças NonProduction/Unattended.

Você também pode habilitar uma máquina com uma solicitação para o terminal /odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled definindo o parâmetro enabled como true.

Postar

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

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

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

Código de resposta

200 OK

Recuperação de informações de licença

A solicitação a seguir pode ser realizada apenas em um tenant por vez. Se você estiver usando o Swagger, essa consulta é executada no tenant ao qual está se conectado ao Orchestrator ao fazer a solicitação. Se você estiver usando uma ferramenta de teste de API, o tenant para o qual você faz essa solicitação é aquele usado para gerar o token de portador.

Obter

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

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Código de resposta

200 OK

Corpo da Resposta

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