instancias de uip maestro bpmn

Sintaxis y opciones para la `instancia de uip maestro bpmn`, que inspecciona y dirige las instancias individuales del proceso Maestro BPMN.

uip maestro bpmn instance y dirige instancias de proceso individuales: una ejecución de un proceso BPMN de Maestro publicado. El nombre del comando es singular (instance) aunque la entrada de la barra lateral dice instances. Cada verbo aquí está registrado en la rama bpmn: no hay uip maestro bpmn instance simple.

Todos los subcomandos requieren uip login y respetan las opciones globales. Los códigos de salida siguen el contrato estándar.

Sinopsis

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> es necesario en cada subcomando.

Opciones comunes

• -f, --folder-key <key> (obligatorio) : clave de carpeta (GUID).
• --comment <text> solo comandos de operación) : comentario opcional grabado con la operación. Enviado como una cadena vacía si se omite.

Subcomandos

lista de instancias de uip maestro bpmn

Enumerar instancias en una carpeta, con ámbito de processType=ProcessOrchestration. Los filtros se aplican en el servidor. Página de resultados por cursor, no por desplazamiento: lee Pagination.NextPage de una respuesta y la devuelve a través de --next-page.

Opciones

Opción	Predeterminado	Descripción
-l, --limit <n>	DEFAULT_PAGE_SIZE	Número de elementos a devolver (1-500).
--next-page <cursor>	—	Cursor de Pagination.NextPage de una respuesta anterior.
--offset <n>	—	No es compatible con esta API. --offset 0 se acepta silenciosamente como no-op (equivalente a ningún cursor); cualquier otro valor falla con un error que te indica que utilices --next-page en su lugar.
--process-key <guid>	—	Filtrar por clave de proceso: debe ser un GUID. Para el identificador de paquete con puntos (p. ej. InvoiceOrchestration:1.0.0) que uip or processes list se imprime como ProcessKey, utiliza --package-id en su lugar.
--package-id <id>	—	Filtrar por ID de paquete (el identificador de paquete con puntos).
--error-code <code>	—	Filtrar por código de error.
--status <status>	—	Filtrar por estado de instancia. Repetible, semántica OR. Un valor no válido falla rápidamente al enumerar el conjunto aceptado.
--from-date <iso-8601>	—	Incluir solo las instancias iniciadas en o después de esta marca de tiempo, por ejemplo 2026-01-01T00:00:00Z.
--to-date <iso-8601>	—	Incluir solo las instancias iniciadas en o antes de esta marca de tiempo.

Forma de datos

Code: "InstanceList", Data es una matriz de objetos de instancia de proceso más un bloque Pagination (returned, limit, hasMore, nextPage).

obtención de instancia de uip maestro bpmn

Obtener una sola instancia por ID. Forma de datos: Code: "InstanceGet", Data es el objeto de instancia de proceso.

pausa de instancia de uip maestro bpmn

Pausar una instancia en ejecución. Forma de datos: Code: "InstancePaused".

reanudación de la instancia de uip maestro bpmn

Reanudar una instancia en pausa. Forma de datos: Code: "InstanceResumed".

cancelación de instancia de uip maestro bpmn

Cancelar una instancia en ejecución. Forma de datos: Code: "InstanceCanceled".

reintento de instancia de uip maestro bpmn

Reintentar una instancia defectuosa. Forma de datos: Code: "InstanceRetried".

migrar instancia de uip maestro bpmn

Migra una instancia a una versión de paquete diferente.

Argumentos: <instance-id>, <new-version> (versión del paquete de destino).

Forma de datos: Code: "InstanceMigrated".

variables de instancia de uip maestro bpmn

Obtener variables para una instancia.

Opciones: --parent-element-id <id> — filtrar variables por elemento principal.

Forma de datos: Code: "InstanceVariables", Data lleva la carga útil de las variables de instancia.

conjunto de variables de instancia de uip maestro bpmn

Parchear (actualizar) variables para una instancia en ejecución.

Opciones

Opción	Descripción
--inputs <value>	Carga útil de variables de parche como cadena JSON, ruta @file o canalizada a través de la entrada estándar. Obligatorio (el comando falla si no se resuelve ninguna carga útil).

Forma de datos

Code: "InstanceVariablesSet".

variables de instancia de uip maestro bpmn-all

Obtenga todas las variables para una instancia, incluidas las variables de subproceso.

Forma de datos: Code: "InstanceVariablesAll".

Variables globales de la instancia de UIP Maestro bpmn

Obtener las variables globales de una instancia.

Forma de datos: Code: "InstanceGlobalVariables".

incidentes de instancia de uip maestro bpmn

Forma de datos: Code: "InstanceIncidents", Data es una matriz de objetos incidentes.

activo de instancia de uip maestro bpmn

Obtenga el activo BPMN adjunto a la versión de esta instancia.

Forma de datos: Code: "InstanceAsset", Data es la carga útil del activo BPMN.

cursores de instancia de uip maestro bpmn

Obtener las posiciones actuales del cursor de ejecución: en qué elemento(s) se detiene la instancia.

Forma de datos: Code: "InstanceCursors", Data enumera las posiciones actuales del cursor.

instancia de uip maestro bpmn ir a

Mueve un cursor de ejecución de un elemento a otro.

Argumentos

• <instance-id> (obligatorio)
• <transitions> (obligatorio) : matriz JSON de transiciones, cada una con sourceElementId y targetElementId.

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

Forma de datos

Code: "InstanceGoto".

Ejecuciones de elementos de instancia de uip maestro bpmn

Obtener el historial de ejecución por elemento para una instancia.

Forma de datos

Code: "InstanceElementExecutions", Data es el historial de ejecución por elemento.

envío de mensaje de instancia de uip maestro bpmn

Enviar un mensaje a las suscripciones de flujo de trabajo que escuchan en este proceso: no en el ámbito de un solo ID de instancia; la carga útil del proveedor determina a qué instancias llega el mensaje.

Opciones

Opción	Obligatorio	Descripción
-f, --folder-key <key>	Sí	Clave de carpeta (GUID).
--inputs <value>	—	Carga útil del mensaje como cadena JSON, ruta @file o canalizada a través de la entrada estándar. Falla si no se resuelve ninguna carga útil.

Forma de datos

Code: "MessageSent".

cancelación de elemento de instancia de uip maestro bpmn

Cancela un elemento dentro de una instancia en ejecución, sin cancelar toda la instancia.

Argumentos

• <instance-id> (obligatorio)
• <element-id> (obligatorio)

Opciones

Opción	Descripción
-f, --folder-key <key>	Clave de carpeta (GUID). Obligatorio.
--comment <text>	Comentario opcional para la operación.

Forma de datos

Code: "ElementCanceled".

reintento de elemento de instancia de uip maestro bpmn

Reintentar un elemento defectuoso dentro de una instancia.

Argumentos

• <instance-id> (obligatorio)
• <element-id> (obligatorio)

Opciones

Opción	Descripción
-f, --folder-key <key>	Clave de carpeta (GUID). Obligatorio.
--comment <text>	Comentario opcional para la operación.

Forma de datos

Code: "ElementRetried".

Ejemplos

# 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}'

Ver también

• uip maestro bpmn incidents — incidentes separados de una instancia específica
• uip maestro bpmn job : la vista de trabajo de una ejecución de instancia
• uip maestro bpmn process — iniciar nuevas instancias
• Trabajos de Orchestrator
• Descripción general de Maestro