- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- codificador UIP
- Contextualização da uip
- Documento da UIP
- Função UIP
- Proteções da UIP
- configuração-llm-uip
- gateway-llm-uip
- criação do uip Maestro
- Registro do uip Maestro
- hub de modelo da uip
- Atividades Localizar
- atividades get-padrão-xaml
- Analisar
- lista de regras do analisador
- Criar
- Limpeza
- instalação de entidades-de-dados
- lista de entidades de data-fabric
- comparação dos arquivos
- obter-repositório-objeto-da-Biblioteca
- obter-objeto-repositório
- Init
- lista de instâncias
- Empacotar
- inspeção de pacotes
- Instalação dos pacotes
- versões dos pacotes
- Publicar
- Remoto
- restore
- executar, depurar e adicionar; Execução
- Configurações
- Início do Studio
- pesquisa de modelos
- adição de dados de teste
- adicionar-fila-de-dados-de-teste
- adição-variação dos dados de teste
- TM
- UIA
- Validar
- fluxo de trabalho-exemplos obter
- lista de exemplos de fluxo de trabalho
- tarefas do UIP
- anexo
- Campo personalizado
- Defects
- Execuções
- exportar trabalhos
- Migração
- Rótulo do objeto
- Empacotar
- cenário-perf
- grupos de carga do cenário-perf
- dados de execução do cenário-perf
- relatório do cenário-perf
- Projeto
- permissões do projeto
- Prompts
- Relatar
- Requisitos
- Resultado
- Executar
- Agendamentos
- Log de caso de teste
- Casos de teste
- Conjuntos de Testes
- Log de etapa de teste
- Usuário
- Aguardar
- Traces da UIP
- Feedback de traces da uip
- Migração
- Referência e suporte
execução do fluxo de trabalho da API do uip
Sintaxe e opções para "uip api-workflow run", que executa um arquivo JSON de fluxo de trabalho de API localmente usando o executor de fluxo de trabalho sem servidor incluído.
uip api-workflow run executa um arquivo JSON de fluxo de trabalho da API localmente usando o executor de fluxo de trabalho sem servidor incluído. Os argumentos de entrada são transmitidos como JSON. Por padrão, o executor carrega as credenciais da UiPath a partir da sessão uip login para que o fluxo de trabalho possa alcançar conectores e serviços com base na nuvem; passe --no-auth para ignorar o carregamento de credenciais e executar somente em um modo local.
Resumo
uip api-workflow run <file> [options]
uip api-workflow run <file> [options]
<file>— caminho para o arquivo JSON do fluxo de trabalho.
Opções
| Bandeira | Description |
|---|---|
-i, --input-arguments <json> | Argumentos de entrada como uma string JSON, por '{"name": "World"}'. |
--input-file <name=path> | Carregue um arquivo local e passe-o como a entrada do arquivo (JobAttachment) <name>. Repetível para vários arquivos. Precisa de uma sessão conectada. |
--output-dir <dir> | Baixar cada referência de arquivo (JobAttachment) na saída do fluxo de trabalho para <dir>; cada referência baixada ganha um LocalPath. Precisa de uma sessão conectada. |
--folder-key <guid> | Chave da pasta do Orchestrator para os anexos que esta execução cria (entradas carregadas e arquivos escritos pelas atividades File to Base64 / Base64 to File). |
--no-auth | Skip credential loading. The workflow runs in a local-only mode with no access to connectors or cloud-backed services. Refer to Local-only mode. |
Exemplos
# Run with an inline input object
uip api-workflow run ./workflow.json \
--input-arguments '{"name":"World"}'
# Run without loading credentials (offline / local-only)
uip api-workflow run ./workflow.json --no-auth
# Extract a single output field
uip api-workflow run ./workflow.json \
--input-arguments '{"name":"World"}' \
--output-filter 'greeting'
# Upload a local file as a file (JobAttachment) input, and download any file
# outputs the workflow produces
uip api-workflow run ./workflow.json \
--input-file document=./invoice.pdf \
--output-dir ./out
# Run with an inline input object
uip api-workflow run ./workflow.json \
--input-arguments '{"name":"World"}'
# Run without loading credentials (offline / local-only)
uip api-workflow run ./workflow.json --no-auth
# Extract a single output field
uip api-workflow run ./workflow.json \
--input-arguments '{"name":"World"}' \
--output-filter 'greeting'
# Upload a local file as a file (JobAttachment) input, and download any file
# outputs the workflow produces
uip api-workflow run ./workflow.json \
--input-file document=./invoice.pdf \
--output-dir ./out
Modo somente local
With --no-auth, the command refuses to run when the run needs Orchestrator blob storage:
--input-filefoi passado.--output-dirfoi passado.- The workflow uses the File to Base64 or Base64 to File activities.
Each refusal returns Result: "Failure" with Instructions to run uip login and drop --no-auth.
Formato dos dados (--output json)
Data a própria saída do fluxo de trabalho, com nomes de campos mantidos exatamente como o fluxo de trabalho os produz:
{
"Code": "WorkflowRun",
"Data": {
"greeting": "Hello, World!"
}
}
{
"Code": "WorkflowRun",
"Data": {
"greeting": "Hello, World!"
}
}
Um fluxo de trabalho que não produz nenhuma saída retorna Data: { "Message": "(no output)" }.
Quando --output-dir é definido, cada referência de arquivo (JobAttachment) na saída é baixada e ganha um LocalPath:
{
"Code": "WorkflowRun",
"Data": {
"encoded": {
"ID": "6f1c0d2e-8a1b-4c3d-9e0f-123456789abc",
"FullName": "invoice.base64",
"MimeType": "text/plain",
"LocalPath": "/abs/path/out/invoice.base64"
}
}
}
{
"Code": "WorkflowRun",
"Data": {
"encoded": {
"ID": "6f1c0d2e-8a1b-4c3d-9e0f-123456789abc",
"FullName": "invoice.base64",
"MimeType": "text/plain",
"LocalPath": "/abs/path/out/invoice.base64"
}
}
}
Sem --output-dir, a referência é retornada sem um arquivo local.
A failed run exits non-zero per the standard exit codes and returns Result: "Failure" with the cause in Message and the next step in Instructions. When the workflow completed but its output files could not be downloaded, the failure also carries the workflow output in Data, so the attachment IDs are kept.
Relacionado
- compilação do uip api-workflow — compile o projeto antes de executá-lo.
- uip api-workflow pack — empacote um fluxo de trabalho validado para publicação.
Veja também
- Visão geral da ferramenta Fluxo de trabalho da API
- Opções globais
- Códigos de saída
uip login— credenciais carregadas porrun, a menos que--no-authesteja definido.