Solicitações de tenants

Observação: você deve ser um administrador de host para fazer solicitações de inquilino.

Observação: os parâmetros AdminEmailAddress, AdminName, AdminSurname, AdminPassworde AdminUserKey são sempre retornados como null.

Recuperando locatários ativos

A solicitação abaixo permite que você recupere todos os inquilinos habilitados. Observe que o exemplo de resposta foi truncado.

Obter

{OrchestratorURL}/odata/Tenants?$filter=IsActive eq true

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#Tenants",
    "@odata.count": 125,
    "value": [{
            "Name": "mynewtenant",
            "AdminEmailAddress": null,
            "AdminName": null,
            "AdminSurname": null,
            "AdminPassword": null,
            "LastLoginTime": "2017-12-04T16:20:58.65Z",
            "IsActive": true,
            "Id": 93,
            "License": null
        },
    {...},
        {
            "Name": "testing_orche",
            "AdminEmailAddress": null,
            "AdminName": null,
            "AdminSurname": null,
            "AdminPassword": null,
            "LastLoginTime": "2018-01-16T03:40:43.073Z",
            "IsActive": true,
            "Id": 100,
            "License": null
        }
    ]
}

Recuperando um inquilino de acordo com seu ID

O exemplo a seguir permite visualizar os detalhes do inquilino com o 99 Id.

Obter

{OrchestratorURL}/odata/Tenants(99)

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#Tenants/$entity",
  "Name": "Documentation",
  "AdminEmailAddress": null,
  "AdminName": null,
  "AdminSurname": null,
  "AdminPassword": null,
  "LastLoginTime": "2018-11-26T11:28:03.56Z",
  "IsActive": true,
  "Id": 99,
  "License": {
    "HostLicenseId": null,
    "CreationTime": "2018-01-12T11:49:48.177Z",
    "Code": "1234567890",
    "Id": 99,
    "Allowed": {
      "Unattended": 99,
      "Attended": 99,
      "NonProduction": 99,
      "Development": 99
    }
  }
}

Desabilitando um tenant

Postar

{OrchestratorURL}/odata/Tenants/UiPath.Server.Configuration.OData.SetActive

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
    "tenantIds": [375],
    "active": false
}

Código de resposta

200 OK

Desativando um recurso

Essa solicitação desativa o recurso de monitoramento para um locatário com Id de 4 .

Para ativar o recurso, faça uma solicitação para o endpoint /odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk , definindo o parâmetro Monitoring.Enabled como true.

Postar

{OrchestratorURL}/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
    "Name": "Monitoring.Enabled",
    "TenantId": [4]
    "Value": False
}

Código de resposta

200 OK