UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

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​

BandeiraDescription
-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-authSkip 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-file foi passado.
  • --output-dir foi passado.
  • O fluxo de trabalho usa as atividades File to Base64 ou Base64 to File.

Cada recusa retorna Result: "Failure" com Instructions para executar uip login e descartar --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.

Uma execução com falha sai de diferente de zero de acordo com os códigos de saída padrão e retorna Result: "Failure" com a causa em Message e a próxima etapa em Instructions. Quando o fluxo de trabalho foi concluído, mas seus arquivos de saída não puderam ser baixados, a falha também carrega a saída do fluxo de trabalho em Data, portanto, os IDs dos anexos são mantidos.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades