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 do Sistema

API	Description
Add Data Row	Adiciona uma DataRow à DataTable especificada.
AddQueueItem	Adiciona um novo item numa fila do Orchestrator.
Add Transaction Item	Adicione um item novo na fila e inicie uma transação.
Anexar Linha	Anexa a string especificada em um arquivo, criando o arquivo caso ele ainda não exista.
BulkAddQueueItems	Adiciona uma coleção de itens de um DataTable especificado a uma fila especificada no Orchestrator.
Clear Data Table	Limpa todos os dados na TabelaDeDados especificada.
Compactar Arquivos ZIP	Adiciona os arquivos especificados ou pastas a um arquivo compactado (zip).
Copy File	Copia um arquivo de um local especificado para outro.
Create File	Cria um arquivo vazio no local especificado. Se um arquivo já existir nesse local,
Create Folder	Cria uma pasta no local especificado.
Delete File or Folder	Exclui um arquivo ou pasta especificado.
Delete Queue Items	Permite excluir itens com o estado Novo de uma fila do Orchestrator especificada.
Delete Storage File	Exclui um arquivo de um Bucket de Armazenamento especificado no Orchestrator.
Download Storage File	Baixa localmente uma cópia de um arquivo em um bucket de armazenamento do Orchestrator.
ExtractUnzip Files	Extrai todos os conteúdos de um arquivo zip para uma pasta especificada.
Filtrar Tabela de Dados	Filtra uma TabelaDeDados especificando as condições no widget Filtro.
Get Asset	Obtém um ativo do Orchestrator usando um NomeDoAtivofornecido.
Get Credential	Obtém um ativo do de credencial especificado usando um Nome do Ativo fornecido.
GetJobs	Recupera uma lista de trabalhos do Orchestrator de acordo com um filtro personalizado usando a API do Orchestrator.
Get Queue Item	O método obtém um item da fila para que você possa processá-lo (iniciar a transação) e define seu status como Em Progresso.
GetQueueItems	Permite recuperar uma lista de até 100 transações de uma fila do Orchestrator indicada, de acordo com vários filtros, como data de criação, prioridade, estado e referência.
Obter recurso para caminho local	Crie um recurso a partir do caminho local do arquivo ou pasta.
Get Row Item	Recupera um valor de uma linha em uma TabelaDeDados de acordo com uma coluna especificada.
Obter item de transação	Obtém um item da fila do Orchestrator para que você possa processá-lo (iniciar a transação) e define seu status como Em Progresso.
Invocar Processo	Executa um processo do UiPath que está disponível para a máquina local.
Join Data Tables	Combina linhas de duas tabelas usando valores comuns entre elas de acordo com uma regra de Junção, que é especificada no parâmetro JoinType .
List Storage Files	Lista arquivos que correspondem a um dado padrão de um Bucket de Armazenamento especificado no Orchestrator.
Lookup Data Table	Esse método emula o comportamento da fórmula do VLOOKUP do Excel. Ela permite pesquisar um valor fornecido em uma DataTable especificada e retorna o ÍndiceDeLinha no qual ele foi encontrado.
Merge Data Table	Mescla o destino com a origem, indicando se as alterações devem ser preservadas e como manusear esquemas ausentes na origem.
Move File	Move um arquivo de um local especificado para outro.
Orchestrator HTTP Request	Executa solicitações HTTP para a API do Orchestrator autenticando-se no robô em que é executado.
OutputDataTable	Grava uma DataTable em uma cadeia de caracteres usando o formato CSV.
Path Exists	Verifica se o caminho especificado existe. O caminho pode representar um caminho de arquivo ou de diretório.
Postpone Transaction Item	Adiciona parâmetros de tempo entre os quais uma transação do Orchestrator deve ser processada (não antes do Adiamento e não depois do Prazo).
Read Storage Text	Baixa um arquivo de um Bucket de Armazenamento especificado no Orchestrator e o armazena em uma variável string.
Ler Arquivo de Texto	Lê todos os caracteres de um arquivo especificado e os armazena em uma variável String.
Remove Data Column	Remove uma DataColumn de uma DataTable especificada.
Remove Duplicate Rows	Remove as linhas duplicadas de uma variável DataTable especificada, mantendo apenas a primeira ocorrência.
Substituir	Em uma cadeia de caracteres de entrada especificada, substitui cadeias de caracteres que correspondem a um padrão de expressão regular por cadeias de caracteres especificadas.
Set Asset	Permite atualizar o valor de um ativo indicado, que já está disponível no Orchestrator, seja um ativo global ou por robô.
Set Credential	Permite atualizar o valor de um ativo de credencial indicado, que já está disponível no Orchestrator, seja um ativo global ou por robô.
SetTransactionProgress	Ajuda você a criar status de progresso personalizados para suas transações do Orchestrator em andamento.
Set Transaction Status	Define o status de um item de transação do Orchestrator Para Falha ou Sucesso.
Sort Data Table	Classifica um DataTable inteiro em ordem crescente ou decrescente, de acordo com os valores de uma coluna especificada.
Iniciar Trabalho	Permite iniciar um trabalho no Orchestrator em um número especificado de Robôs.
Parar Tarefa	Permite que você interrompa ou elimine um trabalho no Orchestrator.
Update Row Item	Atribui um valor especificado para a coluna indicada de uma linha de TabelaDeDados.
Upload Storage File	Carrega um arquivo para um Bucket de Armazenamento especificado no Orchestrator.
Wait Queue Item	Recupera um item de fila do Orchestrator de uma fila especificada e o armazena em uma variável QueueItem .
Write Storage Text	Carrega uma string em um Bucket de Armazenamento especificado no Orchestrator.
Gravar Arquivo de Texto	Escreve o texto especificado em um arquivo. Se o arquivo já existir, o texto pré-existente será substituído.

Uso de APIs

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