Automation Suite
2021.10
falso
Imagem de fundo do banner
Guia da API do Automation Suite
Última atualização 22 de nov de 2023

Recursos

Lista de recursos

As APIs de gerenciamento da plataforma dão a seu aplicativo controle sobre os seguintes recursos:

Gerenciamento do Usuário

Auditar

  • GET BaseURL/identity_/api/AuditQuery/{organizationId}— Recupera os logs de auditoria para o ID de organização especificado.
  • GET BaseURL/identity_/api/AuditQuery/{organizationId}/download—Baixa os logs de auditoria para a ID da organização especificada.

Grupo

  • GET BaseURL/identity_/api/Group/{partitionGlobalId}—Recupera todos os grupos locais e integrados do ID de partição especificado (organização ou locatário).
  • GET BaseURL/identity_/api/Group/{partitionGlobalId}/{groupId}—Recupera o grupo local ou interno especificado no ID de partição especificado.
  • POST BaseURL/identity_/api/Group—Cria um novo grupo local.
  • PUT BaseURL/identity_/api/Group/{groupId}—Atualiza as informações de um grupo local.
  • DELETE BaseURL/identity_/api/Group/{partitionGlobalId}—Exclui todos os grupos locais da ID da partição especificada (organização ou tenant).
  • DELETE BaseURL/identity_/api/Group/{partitionGlobalId}/{groupId}—Exclui o grupo local especificado.

Modelo de mensagem

  • GET BaseURL/identity_/api/MessageTemplate— Recupera um modelo de mensagem usando o filtro fornecido.
  • GET BaseURL/identity_/api/MessageTemplate/{templateId}—Recupera o modelo de mensagem especificado.
  • PUT BaseURL/identity_/api/MessageTemplate/{templateId}—Atualiza o modelo de mensagem especificado.

Conta de robô

  • GET BaseURL/identity_/api/RobotAccount/{partitionGlobalId}—Recupera todas as contas de robô no ID de partição especificado (organização ou locatário).
  • GET BaseURL/identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}—Recupera a conta de robô especificada no ID de partição especificado.
  • POST BaseURL/identity_/api/RobotAccount—Cria uma nova conta do UiPath Robot.
  • PUT BaseURL/identity_/api/RobotAccount/{robotAccountId}—Atualiza as informações da conta do robô especificada.
  • DELETE BaseURL/identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}— Exclui a conta do robô especificada.
  • DELETE BaseURL/identity_/api/RobotAccount/{partitionGlobalId}—Exclui todas as contas de robô no ID de partição especificado.

Configuração

  • GET BaseURL/identity_/api/Setting—Recupera as configurações de um aplicativo com base em uma lista de chaves para um locatário específico.
  • PUT BaseURL/identity_/api/Setting—Atualiza ou cria novas configurações em um locatário específico.

Usuário

  • GET BaseURL/identity_/api/User/{userId}—Recupera informações sobre o usuário especificado.
  • POST BaseURL/identity_/api/User—Cria um novo usuário. Este ponto de extremidade é idempotente: tentar substituir um usuário exclui o existente.
  • POST BaseURL/identity_/api/User/BulkCreate—Cria usuários em massa.
  • POST BaseURL/identity_/api/User/{userId}/changepassword—Atualiza a senha para o usuário especificado.
  • PUT BaseURL/identity_/api/User/{userId}—Atualiza as informações específicas do usuário.
  • DELETE BaseURL/identity_/api/User—Exclui todos os usuários.
  • DELETE BaseURL/identity_/api/User/{userId}— Exclui o usuário especificado.

UserLoginAttempt

  • GET BaseURL/identity_/api/User/{userId}/loginAttempts—Recupera as tentativas de login do usuário especificado.

Gerenciamento de Licenças

Hoster

  • PUT BaseURL/lrm/api/host/{hostAccountId}/organization/{organizationId}/license— Aloca a licença para uma organização da licença do host.

Licenças de Serviço

  • PUT BaseURL/lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType}— Aloca uma licença de serviço de uma licença de conta.

Licença de usuário

  • PUT BaseURL/la/api/account/{accountId}/user-license— Aloca licenças de usuário de uma licença de conta.
  • PUT BaseURL/la/api/account/{accountId}/user-license/group/{groupId}— Aloca ou atualiza uma licença de grupo.

Detalhes do recurso

É possível solicitar detalhes sobre um determinado recurso em uma solicitação GET aplicando cláusulas específicas do OData. Eles permitem que você consulte, filtre, classifique, selecione ou expanda informações.

Cláusulas OData

$topo

Ajuda a limitar a quantidade de dados recuperados.

Ele tem um limite superior determinado pelo número de entidades em uma coleção de recursos. O valor passado deve ser do tipo Int32.

Por exemplo, BaseURL/api/{resource_name}?$top=3— retorna as primeiras 3 entidades do recurso.
$filter

Ajuda a filtrar um recurso específico de acordo com suas propriedades. O valor passado pode ser:

  • Numérico: BaseURL/api/{resource_name}?$filter=Id%20eq%123—filtra o recurso por entidades ID = 123.
  • String: BaseURL/api/{resource_name}?$filter=contains(name,'N')— retorna as entidades cujos nomes contêm a letra N .
  • Booleano: BaseURL/api/{resource_name}$filter={flag}%20eq%20true— filtra o recurso por entidades para as quais o valor do sinalizador especificado é verdadeiro.
  • Enums: BaseURL/api/{resource_name}?$filter=UserType%20eq%robot— retorna as entidades cujo tipo de usuário é robot.
Dica:
Os parâmetros de filtro podem ser combinados usando operadores lógicos (AND, OR, NOT) e podem ser agrupados entre parênteses ( ).
$expandir

Ajuda a carregar totalmente as propriedades de navegação do recurso especificado.

Recurso

Propriedades expansíveis

Grupo

Membros

Conta de robô

IDs do grupo

Usuário

IDs do grupo

Por exemplo, BaseURL/api/Group/123/?$expand=members— expande a propriedade members para a entidade com o ID=123 no recurso Grupo.
$selecionar

Ajuda a especificar um subconjunto de propriedades de recursos a serem retornadas.

Se você deseja extrair várias propriedades, separe-as usando uma vírgula.

Por exemplo, BaseURL/api/{resource_name}?$select=id,name— retorna apenas os IDs e nomes das entidades de recursos.
$orderby

Ajuda a ordenar os recursos recuperados pelas propriedades especificadas.

Separe várias propriedades de ordenação por vírgulas.

Acrescentar uma ordem de classificação à cláusula $orderby retorna as entidades de maneira crescente (asc) ou decrescente (desc). Por padrão, as entidades são classificadas em ordem crescente.
Por exemplo, BaseURL/api/{resource_name}?$orderby=id asc— retorna entidades ordenadas de forma ascendente por seus IDs.
$skip
Ajuda você a pular as primeiras N entidades de um recurso.
Por exemplo, BaseURL/api/{resource_name}?$skip=2— ignora as 2 primeiras entidades e retorna a lista começando com a terceira entidade do recurso.
  • Lista de recursos
  • Gerenciamento do Usuário
  • Gerenciamento de Licenças
  • Detalhes do recurso
  • Cláusulas OData

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.