APIs

As APIs permitem acessar e interagir com os serviços oferecidos no menu Gerenciar pacotes. Você pode usar essas APIs ao projetar automações codificadas. Visite Automações codificadas para saber mais sobre automações codificadas e como projetá-las usando APIs.

Observação: usar Ir para a definição (F12) permite que você acesse a definição de APIs da UiPath para um determinado serviço. Recomendamos confiar apenas nas APIs expostas diretamente ao implementar automações codificadas. Outras APIs não diretamente expostas com um serviço estão sujeitas a alterações sem notificação prévia.

Sobrecarregas

As APIs frequentemente têm sobrecargas, o que significa que fornecem várias versões do mesmo método com diferentes opções de parâmetros. As sobrecargas permitem que você personalize o comportamento da API com base em seus requisitos específicos. Por exemplo, uma API de Automação de interface gráfica pode ter uma sobrecarga que aceita um parâmetro de tempo limite para especificar o tempo máximo para esperar pela exibição de um elemento de interface gráfica antes de terminar a execução.

Ao usar as APIs com suas respectivas cargas de trabalho, você pode facilmente atingir a lógica e o comportamento de automação desejados.

APIs de testes

Observação: verifique se as APIs não são compatíveis com a captura de tela em sistemas operacionais macOS e Linux.

API	Description
Address	Gera um endereço válido com base no país e cidade aleatório que você fornecer.
AddTestDataQueueItem	Adiciona uma DataRow a uma TestDataQueue especificada.
AttachDocument	Anexe documentos aos resultados de execução de teste para ter prova do resultado.
BulkAddTestDataQueueItems	Adicione uma tabela de dados a uma fila de dados de teste especificada.
DeleteTestDataQueueItems	Excluir itens de fila de dados de teste especificados.
GetTestDataQueueItem	Extrai uma DataRow de uma TestDataQueue especificada.
GetTestDataQueueItems	Extrai linhas de dados de uma TestDataQueue especificada.
GivenName	Gera um primeiro nome aleatório.
LastName	Gera um sobrenome aleatório.
RandomDate	Gera uma data aleatória entre duas datas.
RandomNumber	Gera um inteiro aleatório com um determinado comprimento.
RandomString	Gera uma string aleatória com uma determinada extensão e capitalização.
RandomValue	Escolhe uma linha aleatória no intervalo de 0 a 2 bilhões de uma lista de uma coluna.
VerifyAreEqual	Verifica se duas expressões são iguais.
VerifyAreNotEqual	Verifica se duas expressões não são iguais.
VerifyContains	Verifica se a primeira expressão contém a segunda expressão.
VerifyDocumentsEquivalence	Verifies if two documents are equivalent using multiple comparison options.
VerifyExpression	Verifica o valor de verdade de uma determinada expressão.
VerifyExpressionWithOperator	Verifica uma expressão confirmando a relação dela com uma expressão determinada usando um operador.
VerifyIsGreater	Verifica se a primeira expressão é maior que a segunda expressão.
VerifyIsGreaterOrEqual	Verifica se a primeira expressão é maior ou igual à segunda expressão.
VerifyIsLess	Verifica se a primeira expressão é menor que a segunda expressão.
VerifyIsLessOrEqual	Verifica se a primeira expressão é menor ou igual à segunda expressão.
VerifyIsRegexMatch	Verifica se a primeira expressão é uma correspondência regex com a segunda expressão.
VerifyRange	Verifica se uma expressão está localizada ou não dentro de um determinado intervalo.
Verify Text Email	Verifies if two texts are equivalent using multiple comparison options.

Uso de APIs

Use o seguinte formato para chamar uma API a partir do serviço correspondente: service.API Por exemplo, system.GetAsset