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.

instâncias de fluxo da UIP

uip flow instance inspeciona e orienta instâncias de processos individuais — uma execução de um processo de fluxo publicado. O nome do comando é ímpar (instance) mesmo que a entrada da barra lateral diga instances.

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

Resumo

uip flow instance list                <instance-id>             -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip flow instance get                 <instance-id>             -f <folder-key>
uip flow instance pause               <instance-id>             -f <folder-key> [--comment <text>]
uip flow instance resume              <instance-id>             -f <folder-key> [--comment <text>]
uip flow instance cancel              <instance-id>             -f <folder-key> [--comment <text>]
uip flow instance retry               <instance-id>             -f <folder-key> [--comment <text>]
uip flow instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip flow instance variables           <instance-id>             -f <folder-key> [--parent-element-id <id>]
uip flow instance incidents           <instance-id>             -f <folder-key>
uip flow instance asset               <instance-id>             -f <folder-key>
uip flow instance cursors             <instance-id>             -f <folder-key>
uip flow instance goto                <instance-id> <transitions> -f <folder-key>
uip flow instance element-executions  <instance-id>             -f <folder-key>
uip flow instance list                <instance-id>             -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip flow instance get                 <instance-id>             -f <folder-key>
uip flow instance pause               <instance-id>             -f <folder-key> [--comment <text>]
uip flow instance resume              <instance-id>             -f <folder-key> [--comment <text>]
uip flow instance cancel              <instance-id>             -f <folder-key> [--comment <text>]
uip flow instance retry               <instance-id>             -f <folder-key> [--comment <text>]
uip flow instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip flow instance variables           <instance-id>             -f <folder-key> [--parent-element-id <id>]
uip flow instance incidents           <instance-id>             -f <folder-key>
uip flow instance asset               <instance-id>             -f <folder-key>
uip flow instance cursors             <instance-id>             -f <folder-key>
uip flow instance goto                <instance-id> <transitions> -f <folder-key>
uip flow instance element-executions  <instance-id>             -f <folder-key>

-f, --folder-key <key> é necessário em cada subcomando.

Opções comuns

  • -f, --folder-key <key> necessário) — chave de pasta (GUID).
  • --comment <text> (apenas comandos de operação) — comentário opcional gravado com a operação. Enviado como uma string vazia se omitido.

Subcomandos

lista de instâncias de fluxo uip

Liste instâncias em uma pasta, com escopo para Processes de fluxo (processType=Flow).

Opções
OpçãoPadrãoDescription
-l, --limit <n>DEFAULT_PAGE_SIZENúmero de itens a serem retornados (1 a 10000).
--offset <n>0Número de itens a ignorar (0-1000000).
--process-key <k>Filtra por chave de processo.
--package-id <id>Filtrar por ID de pacote.
--error-code <code>Filtra por código de erro.
Formato dos dados

Code: "InstanceList" Data é uma matriz de objetos de instância de processo.

obtenção da instância do fluxo uipath

Buscar uma única instância por ID.

Formato dos dados: Code: "InstanceGet", Data é o objeto da instância do processo.

pausa da instância do fluxo de uip

Pausar uma instância em execução. Formato dos dados: Code: "InstancePaused".

retomada da instância do fluxo uip

Retome uma instância pausada. Formato dos dados: Code: "InstanceResumed".

instância do fluxo de uip cancelamento

Cancele uma instância em execução. Formato dos dados: Code: "InstanceCanceled".

nova tentativa da instância do fluxo de uip

Tente novamente uma instância com falha. Formato dos dados: Code: "InstanceRetried".

migração da instância de fluxo de uip

Migre uma instância para uma versão diferente do pacote.

Argumentos: <instance-id>, <new-version> (versão do pacote de destino).

Formato dos dados: Code: "InstanceMigrated".

variáveis de instância do fluxo de uip

Obtenha variáveis para uma instância.

Opções: --parent-element-id <id> filtre variáveis por elemento pai.

Formato dos dados: Code: "InstanceVariables", Data carrega a carga das variáveis de instância.

incidentes de instância de fluxo de uip

Obtenha incidentes para uma instância específica.

Formato dos dados: Code: "InstanceIncidents", Data é uma matriz de objetos de incidentes.

ativo de instância de fluxo de uip

Busque a definição do fluxo (o ativo .flow ) anexada à versão desta instância — útil ao depurar para ver o gráfico exato que a instância executou.

Formato dos dados: Code: "InstanceAsset", Data é o Fluxo JSON.

cursores de instância de fluxo de uip

Obter as posições atuais do cursor — em quais elementos a instância está pausada.

Formato dos dados: Code: "InstanceCursors", Data lista as posições atuais do cursor.

instância do fluxo uip Ir para

Mova um cursor de execução de um elemento para outro. Útil para recuperar uma instância com falha ignorando ou tentando novamente nós específicos.

Argumentos
  • <instance-id> (necessário)
  • <transitions> (necessário) — Array JSON de transições, cada uma com sourceElementId e targetElementId.
uip flow instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Node_1","targetElementId":"Node_3"}]' \
  --folder-key c3d4e5f6-uip flow instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Node_1","targetElementId":"Node_3"}]' \
  --folder-key c3d4e5f6-…

A CLI valida as análises JSON e cada entrada tem ambos os IDs antes de chamar a API.

Formato dos dados

Code: "InstanceGoto".

execuções de elementos da instância do fluxo uip

Obtenha o histórico de execução por elemento para uma instância (o que foi executado, quando e com qual resultado).

Formato dos dados

Code: "InstanceElementExecutions", Data é o histórico de execução por elemento.

Exemplos

# Paginate through instances for a specific process
uip flow instance list --folder-key <k> --process-key "InvoiceFlow.flow.Flow:1.0.0" --limit 50

# Pause, fix, resume
uip flow instance pause   <id> --folder-key <k> --comment "Investigating"
uip flow instance resume  <id> --folder-key <k>

# Skip a faulted node by moving the cursor forward, then retry
uip flow instance cursors <id> --folder-key <k>
uip flow instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip flow instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip flow instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"
# Paginate through instances for a specific process
uip flow instance list --folder-key <k> --process-key "InvoiceFlow.flow.Flow:1.0.0" --limit 50

# Pause, fix, resume
uip flow instance pause   <id> --folder-key <k> --comment "Investigating"
uip flow instance resume  <id> --folder-key <k>

# Skip a faulted node by moving the cursor forward, then retry
uip flow instance cursors <id> --folder-key <k>
uip flow instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip flow instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip flow instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"

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