UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

processo de fluxo uip e processos de fluxo uip

Depois que um pacote de fluxo é publicado no Orchestrator, ele se torna um processo. Esta página abrange dois grupos de comando relacionados:

  • uip flow process operações por pasta em uma única definição de processo (listar em uma pasta, obter seu esquema, executá-la).
  • uip flow processes plral) — resumos de todo o tenant e pesquisa de incidentes por processo.

Resumo

# Singular — per-folder, operational
uip flow process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip flow process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>] [-t, --tenant <name>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip flow processes list
uip flow processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip flow process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip flow process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>] [-t, --tenant <name>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip flow processes list
uip flow processes incidents <process-key> [--folder-key <key>]

Todos os subcomandos exigem uip login e honram as opções globais. Os códigos de saída seguem o contrato padrão.


lista de processos de fluxo de uip

Lista os processos de fluxo disponíveis (versões) em uma pasta específica.

Opções

OpçãoRequiredDescription
-f, --folder-key <key>simChave da pasta (GUID).
-t, --tenant <name>nãoNome do tenant. O padrão para o tenant autenticado.
--filter <odata>nãoFiltro OData adicional aplicado no lado do servidor.
--login-validity <minutes>nãoLimite de atualização do token (padrão 10).

Formato dos dados (--output json)

{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "active":     "Yes",
      "latest":     "Yes"
    }
  ]
}
{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "active":     "Yes",
      "latest":     "Yes"
    }
  ]
}

processo de fluxo de uip obter

Buscar o esquema de ponto de entrada (esquemas JSON de entrada/saída) para um processo de Flow. Use o resultado para criar uma carga --inputs válida para process run.

Argumentos

  • <process-key> (necessário) — chave de processo, por exemplo MyFlow.flow.Flow:1.0.0 ou <package-id>:<version>.
  • <feed-id> (necessário) — ID do feed (da saída do list ).

Opções

  • -f, --folder-key <key> (necessário)
  • -t, --tenant
  • --login-validity

Formato dos dados

{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}
{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema e OutputSchema são JSON com nova string; analise-os como esquema JSON para direcionar a construção de entrada.


execução do processo de fluxo de uip

Inicie um trabalho de fluxo para um processo publicado.

Argumentos

  • <process-key> (necessário) — chave do processo (por exemplo MyFlow.flow.Flow:1.0.0).
  • <folder-key> necessário) — chave de pasta (GUID).

Opções

OpçãoDescription
-i, --inputs <json>Entradas como uma string JSON ou @path/to/file.json. Se omitido e stdin estiver tabulado, stdin será analisado como entradas.
-t, --tenant <name>Nome do tenant (o padrão é tenant autenticado).
--release-key <key>Chave de lançamento (GUID) — de process list.
--feed-id <id>ID do feed para pesquisa de pacote (opcional).
--robot-ids <ids>IDs de robô separados por vírgulas (inteiros). Os valores inválidos falham rapidamente.
--validateValide entradas em relação ao esquema do processo antes de executar. Executa apenas verificações básicas — campos necessários presentes e correspondência de tipos primitivos. Restrições complexas (enums, padrões, referências) não são aplicadas por este passe.
--login-validity <minutes>Limite de atualização do token (padrão 10).

Precedência de entrada: --inputs <json> / --inputs @file.json > stdin > empty object {}.

Exemplos

# Run with inline JSON
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Run with inputs from a file
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate
# Run with inline JSON
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Run with inputs from a file
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate

Formato dos dados

{
  "Code": "FlowJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}
{
  "Code": "FlowJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}

Próxima etapa: para transmitir uip flow job status <jobKey> uip flow job traces <jobKey> pesquisar.


lista de processos de fluxo da uip

Resumo de todo o tenant dos processos de fluxo (/processes/summary?processType=Flow). Sem argumentos, sem opções além de globais.

Formato dos dados

{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}
{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}
Observação:

O conjunto de campos exato de cada resumo de processo é especificado pelo runtime do Maestro e pode evoluir; execute o comando uma vez com --output json em um tenant com dados para ver os campos que você consumirá e fixe @uipath/cli no CI se você analisar campos específicos.


incidentes de processos de fluxo de uip

Obtenha todos os incidentes para uma definição específica do processo Flow (não uma única instância).

Argumentos

  • <process-key> necessário) — chave de definição de processo.

Opções

  • --folder-key <key> opcional) — chave de pasta para delimitar a pesquisa.

Formato dos dados

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}
{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

Consulte uip flow incidents para obter o formato por incidente.

Veja também

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades