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

Proceso de flujo de UIP y procesos de flujo de UIP

Una vez que se publica un paquete de flujo en Orchestrator, se convierte en un proceso. Esta página cubre dos grupos de comandos relacionados:

  • uip flow process — operaciones por carpeta en una sola definición de proceso (lista en una carpeta, obtener su esquema, ejecutarlo).
  • uip flow processes plural) : resúmenes de todo el tenant y búsqueda de incidentes por proceso.

Sinopsis

# Singular — per-folder, operational
uip flow process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip flow process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip flow 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 flow processes list
uip flow processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip flow process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip flow process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip flow 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 flow processes list
uip flow 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 flujo de uip

Enumera los procesos de flujo disponibles (versiones) en una carpeta específica.

Opciones

OpciónObligatorioDescripción
-f, --folder-key <key>Clave de carpeta (GUID).
-t, --tenant <name>NoNombre del tenant. El valor predeterminado es el tenant autenticado.
--filter <odata>NoFiltro OData adicional aplicado en el lado del servidor.
--login-validity <minutes>NoUmbral de actualización del token (predeterminado 10).

Data shape (--output json)

{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "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": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "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 de flujo de uip

Obtener el esquema de punto de entrada (esquemas JSON de entrada/salida) para un proceso de flujo. Utilice el resultado para crear una carga útil --inputs válida para process run.

Argumentos

  • <process-key> (obligatorio) : clave de proceso, p. ej. MyFlow.flow.Flow:1.0.0 o <package-id>:<version>.
  • <feed-id> (obligatorio) : ID de fuente (de la salida list ).

Opciones

  • -f, --folder-key <key> (obligatorio)
  • -t, --tenant
  • --login-validity

Forma de datos

{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}
{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema y OutputSchema son JSON restringidas; analizarlos como esquema JSON para impulsar la construcción de entrada.


ejecución del proceso de flujo de uip

Inicia un trabajo de flujo para un proceso publicado.

Argumentos

  • <process-key> (obligatorio) : clave de proceso (p. ej. MyFlow.flow.Flow:1.0.0).
  • <folder-key> (obligatorio) : clave de carpeta (GUID).

Opciones

OpciónDescripción
-i, --inputs <json>Entradas como una cadena JSON o @path/to/file.json. Si se omite y se canaliza la entrada estándar, la entrada estándar se analiza como entradas.
-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.
--validateValida las entradas con el esquema del proceso antes de ejecutar. Solo realiza comprobaciones básicas: los campos obligatorios presentes y los tipos primitivos coinciden. Este pase no aplica restricciones complejas (enumeraciones, patrones, referencias).
--login-validity <minutes>Umbral de actualización del token (predeterminado 10).

Precedencia de entrada: --inputs <json> / --inputs @file.json > stdin > objeto vacío {}.

Ejemplos

# Run with inline JSON
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Run with inputs from a file
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate
# Run with inline JSON
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Run with inputs from a file
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate

Forma de datos

{
  "Code": "FlowJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}
{
  "Code": "FlowJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001"
  }
}

Siguiente paso: uip flow job traces <jobKey> a la ejecución de la transmisión o uip flow job status <jobKey> al sondeo.


lista de procesos de flujo de uip

Resumen de todo el tenant de los procesos de flujo (/processes/summary?processType=Flow). Sin argumentos, sin opciones más allá de las globales.

Forma de datos

{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}
{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}
Nota:

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 flujo de UIP

Obtener todos los incidentes para una definición de proceso de flujo específica (no una sola instancia).

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 */ ]
}

Consulta uip flow incidents para ver la forma por incidente.

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