orchestrator
2023.10
true
- Introdução
- Autenticação
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de Tarefas Genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de webhooks
- APIs de gestão de plataforma
Solicitações de tenants
Guia da API do Orchestrator
Last updated 17 de jun de 2024
Solicitações de tenants
Observação: você deve ser um administrador da organização para fazer solicitações de tenants.
Observação: os parâmetros
AdminEmailAddress
, AdminName
, AdminSurname
, AdminPassword
e AdminUserKey
são sempre retornados como null
.
A solicitação abaixo permite que você recupere todos os inquilinos habilitados. Observe que o exemplo de resposta foi truncado.
Obter
https://{yourDomain}/odata/Tenants?$filter=IsActive eq true
{
"@odata.context": "https://{yourDomain}/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
}
]
}
{
"@odata.context": "https://{yourDomain}/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
}
]
}
O exemplo a seguir permite visualizar os detalhes do inquilino com o 99
Id
.
Obter
https://{yourDomain}/odata/Tenants(99)
{
"@odata.context": "https://{yourDomain}/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
}
}
}
{
"@odata.context": "https://{yourDomain}/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
}
}
}
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
https://{yourDomain}/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk
{
"Name": "Monitoring.Enabled",
"TenantId": [4]
"Value": False
}
{
"Name": "Monitoring.Enabled",
"TenantId": [4]
"Value": False
}
- Recuperando locatários ativos
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Recuperando um inquilino de acordo com seu ID
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Desabilitando um tenant
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Desativando um recurso
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta