- Información general
- Comience ya
- Conceptos
- Uso de UiPath CLI
- UiPath para agentes de codificación
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- UIP Docsai
- Init
- Paquete
- Depurar
- proceso/procesos
- Instancias
- incidentes
- Trabajo
- Registro
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- restore
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- UIA
- Seguimientos de UIP
- Migración
- Referencia y soporte
Guía del usuario de UiPath CLI
Una vez que se publica un paquete de Maestro en Orchestrator, se convierte en un proceso de tipo ProcessOrchestration. Esta página cubre dos grupos de comandos relacionados:
uip maestro process— operaciones por carpeta en una sola definición de proceso (lista en una carpeta, obtener su esquema, ejecutarlo).uip maestro processesplural) : resúmenes de todo el tenant y búsqueda de incidentes por proceso.
Sinopsis
# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro 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 maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro 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 maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]
Todos los subcomandos requieren uip login y respetan las opciones globales. Los códigos de salida siguen el contrato estándar.
lista de procesos de uip maestro
Enumera los procesos de Maestro disponibles (versiones) en una carpeta específica.
Opciones
| Opción | Obligatorio | Descripción |
|---|---|---|
-f, --folder-key <key> | Sí | Clave de carpeta (GUID). |
-t, --tenant <name> | No | Nombre del tenant. El valor predeterminado es el tenant autenticado. |
--filter <odata> | No | Filtro OData adicional aplicado en el lado del servidor. |
--login-validity <minutes> | No | Umbral de actualización del token (predeterminado 10). |
Data shape (--output json)
{
"Code": "MaestroProcessList",
"Data": [
{
"name": "InvoiceOrchestration",
"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": "MaestroProcessList",
"Data": [
{
"name": "InvoiceOrchestration",
"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"
}
]
}
obtención del proceso maestro de uip
Obtén el esquema de punto de entrada (esquemas JSON de entrada/salida) para un proceso de Maestro.
Argumentos
<process-key>(obligatorio) : clave de proceso.<feed-id>(obligatorio) : ID de fuente (delist).
Opciones
-f, --folder-key <key>(obligatorio)-t, --tenant--login-validity
Forma de datos
{
"Code": "MaestroProcessGet",
"Data": [
{
"Path": "/content/main.bpmn#Event_start",
"DisplayName": "Manual trigger",
"Type": "processorchestration",
"InputSchema": "{\"type\":\"object\",\"properties\":{}}",
"OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
}
]
}
{
"Code": "MaestroProcessGet",
"Data": [
{
"Path": "/content/main.bpmn#Event_start",
"DisplayName": "Manual trigger",
"Type": "processorchestration",
"InputSchema": "{\"type\":\"object\",\"properties\":{}}",
"OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
}
]
}
InputSchema y OutputSchema son cadenas de esquema JSON restringidas.
ejecución del proceso maestro de uip
Inicia un trabajo de Maestro para un proceso publicado.
Argumentos
<process-key>(obligatorio) : clave de proceso.<folder-key>(obligatorio) : clave de carpeta (GUID).
Opciones
| Opción | Descripción |
|---|---|
-i, --inputs <json> | Entradas como una cadena JSON o @path/to/file.json. Si se omite y se canaliza la entrada estándar, se analiza la entrada estándar. |
-t, --tenant <name> | Nombre del tenant (el valor predeterminado es tenant autenticado). |
--release-key <key> | Clave de versión (GUID): desde process list. |
--feed-id <id> | ID de fuente para la búsqueda de paquetes (opcional). |
--robot-ids <ids> | ID de robot separados por comas (entero). Los valores no válidos fallan rápidamente. |
--validate | Valida las entradas con el esquema del proceso antes de ejecutar. Solo comprobaciones básicas: campos obligatorios + tipos primitivos. |
--login-validity <minutes> | Umbral de actualización del token (predeterminado 10). |
Precedencia de entrada: --inputs <json> / --inputs @file.json > stdin > objeto vacío {}.
Ejemplos
# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
--inputs '{"amount":100}'
# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json
# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"
# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
--inputs '{"amount":100}' --validate
# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
--inputs '{"amount":100}'
# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json
# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"
# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
--inputs '{"amount":100}' --validate
Forma de datos
{
"Code": "MaestroJobStarted",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"state": "Pending",
"traceId": "d4e5f6a7-0000-0000-0000-000000000001"
}
}
{
"Code": "MaestroJobStarted",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"state": "Pending",
"traceId": "d4e5f6a7-0000-0000-0000-000000000001"
}
}
Siguiente paso: uip maestro job traces <jobKey> a la ejecución de la transmisión o uip maestro job status <jobKey> al sondeo.
lista de procesos de uip maestro
Resumen de todo el tenant de los procesos de Maestro (no se aplica ningún filtro processType en esta capa; el comando en plural se comparte entre las herramientas y no afecta al servidor ProcessOrchestration ).
Argumentos
Nada.
Forma de datos
{
"Code": "ProcessList",
"Data": [ /* array of Maestro process summaries */ ]
}
{
"Code": "ProcessList",
"Data": [ /* array of Maestro process summaries */ ]
}
El tiempo de ejecución de Maestro especifica el conjunto de campos exacto de cada resumen de proceso y puede evolucionar; ejecuta el comando una vez con --output json en un tenant con datos para ver los campos que consumirás y ancla @uipath/cli en CI si analizas campos específicos.
incidentes de procesos de uip maestro
Obtener todos los incidentes para una definición de proceso de Maestro específica.
Argumentos
<process-key>(obligatorio) : clave de definición del proceso.
Opciones
--folder-key <key>opcional) : clave de carpeta para el ámbito de la búsqueda.
Forma de datos
{
"Code": "ProcessIncidents",
"Data": [ /* array of process incidents */ ]
}
{
"Code": "ProcessIncidents",
"Data": [ /* array of process incidents */ ]
}
Ver también
uip maestro instances: inspeccionar y dirigir las ejecuciones en ejecuciónuip maestro job: seguimientos y estado de un solo trabajouip maestro incidents— resúmenes y detalles de incidentes- Trabajos de Orchestrator, procesos de Orchestrator
- Descripción general de Maestro
- Sinopsis
- lista de procesos de uip maestro
- Opciones
- Data shape (
--output json) - obtención del proceso maestro de uip
- Argumentos
- Opciones
- Forma de datos
- ejecución del proceso maestro de uip
- Argumentos
- Opciones
- Ejemplos
- Forma de datos
- lista de procesos de uip maestro
- Argumentos
- Forma de datos
- incidentes de procesos de uip maestro
- Argumentos
- Opciones
- Forma de datos
- Ver también