instâncias bpmn do uip Maestro

Sintaxe e opções para "uip Maestro bpmn instance", que inspeciona e orienta instâncias individuais do processo BPMN do Maestro.

uip maestro bpmn instance inspeciona e orienta instâncias de processos individuais — uma execução de um processo BPMN do Maestro publicado. O nome do comando é ímpar (instance), mesmo que a entrada da barra lateral diga instances. Cada verbo aqui está registrado na ramificação bpmn — não existe uip maestro bpmn instance apenas.

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 maestro bpmn instance list                                  -f <folder-key> [-l <limit>] [--next-page <cursor>] [--process-key <guid>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso>] [--to-date <iso>]
uip maestro bpmn instance get                 <instance-id>     -f <folder-key>
uip maestro bpmn instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro bpmn instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro bpmn instance variables-set       <instance-id>     -f <folder-key> --inputs <json|@file>
uip maestro bpmn instance variables-all       <instance-id>     -f <folder-key>
uip maestro bpmn instance global-variables    <instance-id>     -f <folder-key>
uip maestro bpmn instance incidents           <instance-id>     -f <folder-key>
uip maestro bpmn instance asset               <instance-id>     -f <folder-key>
uip maestro bpmn instance cursors             <instance-id>     -f <folder-key>
uip maestro bpmn instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro bpmn instance element-executions  <instance-id>     -f <folder-key>
uip maestro bpmn instance message send                          -f <folder-key> --inputs <json|@file>
uip maestro bpmn instance element cancel      <instance-id> <element-id> -f <folder-key> [--comment <text>]
uip maestro bpmn instance element retry       <instance-id> <element-id> -f <folder-key> [--comment <text>]

-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 bpmn do uip Maestro

Liste instâncias em uma pasta com escopo de processType=ProcessOrchestration. Os filtros são aplicados no lado do servidor. Página de resultados por cursor, não deslocamento — leia Pagination.NextPage de uma resposta e passe-a de volta por meio de --next-page.

Opções

Opção	Padrão	Description
-l, --limit <n>	DEFAULT_PAGE_SIZE	Número de itens a serem retornados (1 a 500).
--next-page <cursor>	—	Cursor de Pagination.NextPage de uma resposta anterior.
--offset <n>	—	Não é compatível com esta API. --offset 0 é aceito silenciosamente como um não operacional (equivalente a nenhum cursor); qualquer outro valor falha com um erro informando para você usar --next-page em vez disso.
--process-key <guid>	—	Filtrar por chave de processo — deve ser um GUID. Para o identificador de pacote pontilhado (por exemplo InvoiceOrchestration:1.0.0) em que uip or processes list imprime como ProcessKey, use --package-id em vez disso.
--package-id <id>	—	Filtrar por ID de pacote (o identificador de pacote pontilhado).
--error-code <code>	—	Filtra por código de erro.
--status <status>	—	Filtre por status da instância. Repetível, semântica OR. Um valor inválido falha rapidamente listando o conjunto aceito.
--from-date <iso-8601>	—	Inclua apenas instâncias iniciadas por ou depois desse registro de data/hora. Por exemplo 2026-01-01T00:00:00Z).
--to-date <iso-8601>	—	Inclui apenas instâncias iniciadas antes ou depois deste carimbo de data/hora.

Formato dos dados

Code: "InstanceList", Data é uma matriz de objetos de instância de processo mais um bloco Pagination (returned, limit, hasMore, nextPage).

Instância bpmn do uip Maestro Get

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 uip Maestro bpmn

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

Retomação da instância bpmn do uip Maestro

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

instância bpmn do uip Maestro cancelamento

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

nova tentativa de instância bpmn do uip Maestro

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

migração de instância bpmn do uip Maestro

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 bpmn do uip Maestro

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.

variáveis-set de instância do uip Maestro bpmn

Corrigir (atualizar) variáveis para uma instância em execução.

Opções

Opção	Description
--inputs <value>	Carga de variáveis de patch como uma string JSON, caminho @file ou tabulada via stdin. Obrigatório (o comando falha se nenhuma carga for resolvida).

Formato dos dados

Code: "InstanceVariablesSet".

variáveis-todos de instância do uip Maestro bpmn

Obtenha cada variável de uma instância, incluindo variáveis de subprocesso.

Formato dos dados: Code: "InstanceVariablesAll".

instância global-variables da instância bpmn do uip Maestro

Obtenha as variáveis globais de uma instância.

Formato dos dados: Code: "InstanceGlobalVariables".

incidentes de instância bpmn do uip Maestro

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

ativo de instância bpmn do uip Maestro

Busque o ativo BPMN anexado à versão desta instância.

Formato dos dados: Code: "InstanceAsset", Data é a carga do ativo BPMN.

cursores de instância bpmn do uip Maestro

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 bpmn do uip Maestro geto

Mova um cursor de execução de um elemento para outro.

Argumentos

• <instance-id> (necessário)
• <transitions> (necessário) — Array JSON de transições, cada uma com sourceElementId e targetElementId.

uip maestro bpmn instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-…

Formato dos dados

Code: "InstanceGoto".

execuções de elementos-execuções da instância bpmn do uip Maestro

Obtenha o histórico de execução por elemento para uma instância.

Formato dos dados

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

mensagem de instância bpmn do uip Maestro

Envie uma mensagem para assinaturas de fluxo de trabalho ouvindo este processo — não limitado a um único ID de instância; a carga do fornecedor determina quais instâncias a mensagem alcança.

Opções

Opção	Required	Description
-f, --folder-key <key>	sim	Chave da pasta (GUID).
--inputs <value>	—	Carga da mensagem como uma string JSON, caminho @file ou tabulada via stdin. A falha se nenhuma carga for resolvida.

Formato dos dados

Code: "MessageSent".

elemento de instância bpmn do uip Maestro cancelamento

Cancele um elemento em uma instância em execução, sem cancelar a instância inteira.

Argumentos

• <instance-id> (necessário)
• <element-id> (necessário)

Opções

Opção	Description
-f, --folder-key <key>	Chave da pasta (GUID). Obrigatório.
--comment <text>	Comentário opcional para a operação.

Formato dos dados

Code: "ElementCanceled".

nova tentativa de elemento de instância do uip Maestro bpmn

Tente novamente um elemento com falha dentro de uma instância.

Argumentos

• <instance-id> (necessário)
• <element-id> (necessário)

Opções

Opção	Description
-f, --folder-key <key>	Chave da pasta (GUID). Obrigatório.
--comment <text>	Comentário opcional para a operação.

Formato dos dados

Code: "ElementRetried".

Exemplos

# Paginate through instances for a specific process, filtered by status
uip maestro bpmn instance list --folder-key <k> \
  --status Faulted --status Paused --limit 50

# Page through with the cursor from a previous response
uip maestro bpmn instance list --folder-key <k> --next-page <cursor>

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

# Inspect cursors, jump a faulted node, retry
uip maestro bpmn instance cursors <id> --folder-key <k>
uip maestro bpmn instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro bpmn instance retry   <id> --folder-key <k>

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

# Retry a single faulted element instead of the whole instance
uip maestro bpmn instance element retry <id> Activity_2 --folder-key <k>

# Patch a variable on a running instance
uip maestro bpmn instance variables-set <id> --folder-key <k> --inputs '{"amount": 250}'

Veja também

• uip maestro bpmn incidents — incidentes desanexados de uma instância específica
• uip maestro bpmn job — a visualização de trabalho de uma execução de instância
• uip maestro bpmn process — iniciar novas instâncias
• Trabalhos do Orchestrator
• Visão geral do Maestro