UiPath Documentation
uipath-cli
latest
false
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía del usuario de UiPath CLI

instancias de uip maestro

uip maestro instance y dirige instancias de proceso individuales: una ejecución de un proceso de Maestro publicado. El nombre del comando es singular (instance) aunque la entrada de la barra lateral dice instances.

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

Sinopsis

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

-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

Enumerar instancias en una carpeta, con ámbito de processType=ProcessOrchestration.

Opciones
OpciónPredeterminadoDescripción
-l, --limit <n>DEFAULT_PAGE_SIZENúmero de elementos a devolver (1-10000).
--offset <n>0Número de elementos a omitir (0-1000000).
--process-key <k>Filtrar por clave de proceso.
--package-id <id>Filtrar por ID de paquete.
--error-code <code>Filtrar por código de error.
Forma de datos

Code: "InstanceList", Data is an array of process-instance objects.

obtención de instancia de uip maestro

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

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

reanudación de la instancia de uip maestro

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

Cancelación de instancia de uip maestro

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

reintento de instancia de uip maestro

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

Migración de instancia de uip maestro

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

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.

Incidentes de instancia de uip maestro

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

activo de instancia de uip maestro

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

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.

Ir a instancia de uip maestro

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 instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-uip maestro 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

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

Forma de datos

Code: "InstanceElementExecutions", Data is the per-element execution history.

Ejemplos

# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
  --process-key "InvoiceOrchestration:1.0.0" --limit 50

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

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

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

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

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

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

Ver también

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado