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]

• <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	Ignorar o carregamento de credenciais. O fluxo de trabalho é executado em um modo somente local, sem acesso a conectores ou serviços baseados em nuvem (também desabilita --input-file/--output-dir).

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 just the output payload
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}' \
    --output-filter 'Data.Output'

# 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

Formato dos dados (--output json)

{
  "Code": "WorkflowRun",
  "Data": {
    "Status": "Completed",
    "Output": {
      "greeting": "Hello, World!"
    }
  }
}

reflete o estado terminal do executor ( Status , Faulted Completed etc.). Uma execução com falha sai diferente de zero de acordo com os códigos de saída padrão.

Quando a saída do fluxo de trabalho inclui uma referência de arquivo (JobAttachment) e --output-dir estiver definido, a forma centraliza o arquivo baixado:

{
  "Code": "WorkflowRun",
  "Data": {
    "Encoded": {
      "Id": "6f1c0d2e-8a1b-4c3d-9e0f-123456789abc",
      "FullName": "invoice.base64",
      "MimeType": "text/plain",
      "LocalPath": "/abs/path/out/invoice.base64"
    }
  }
}

LocalPath é preenchido apenas quando --output-dir está definido — sem ele, a referência é retornada sem um arquivo local.

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 por run , a menos que --no-auth esteja definido.