Orchestrator
2021.10
falso
Imagem de fundo do banner
Guia da API do Orchestrator
Última atualização 19 de abr de 2024

Solicitações de licenças

Recuperando todos os robôs assistidos com uma licença de usuário nomeado

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 no máximo 1.000 entradas.

Obter

{OrchestratorURL}/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": "{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": []
    }
  ]
}{
  "@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

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
}{
    "key": "Documentation",
    "robotType": "Unattended",
    "enabled": false
}

Código de resposta

200 OK

Recuperando informações de licença

A solicitação a seguir só pode ser executada em um inquilino por vez. Se você estiver usando o Swagger, essa consulta será executada no locatário no qual você fez login no Orchestrator ao fazer a solicitação. Se você estiver usando uma ferramenta de teste de API, o inquilino para o qual você faz essa solicitação é aquele usado para gerar o token do portador.

Obter

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

Was this page helpful?

Obtenha a ajuda que você precisa
Aprendendo RPA - Cursos de automação
Fórum da comunidade da Uipath
Logotipo branco da Uipath
Confiança e segurança
© 2005-2024 UiPath. All rights reserved.