UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
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.

proceso de flujo maestro de uip y procesos de flujo maestro de uip

Sintaxis y opciones para `proceso de flujo maestro de uip` y `procesos de flujo maestro de uip`, que cubren las operaciones de proceso de flujo publicadas por carpeta y en todo el tenant.

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

Sinopsis

# Singular — per-folder, operational
uip maestro flow process list -f <folder-key> [--filter <odata>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <process-key> --folder-key <key>
# Singular — per-folder, operational
uip maestro flow process list -f <folder-key> [--filter <odata>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <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 maestro 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).
--filter <odata>NoFiltro OData adicional aplicado en el lado del servidor.
--login-validity <minutes>NoUmbral de actualización del token (predeterminado 10).

Forma de datos (--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 maestro 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)
  • --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 maestro 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.
--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.
--attachment <name=path>Upload a local file to Orchestrator and bind it as a file-type input variable. Repeatable, e.g. --attachment file1=./resume.pdf. Overrides the same variable name if also present in --inputs.
--waitBlock until the job reaches a terminal state instead of returning immediately with Pending.
--timeout <seconds>Maximum seconds to wait. 0 = no timeout. Requires --wait.
--poll-interval <seconds>Segundos entre comprobaciones de estado mientras se espera. Requiere --wait.
--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 maestro 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 maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

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

# Validate before running
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate
# Run with inline JSON
uip maestro 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 maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

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

# Validate before running
uip maestro 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 maestro flow job traces <jobKey> a la ejecución de la transmisión o uip maestro flow job status <jobKey> al sondeo.


uip maestro flow process settings

Get or update a process's runtime settings.

uip maestro flow process settings get

Argumentos
  • <process-key> (obligatorio) : clave de definición del proceso.
Opciones
  • -f, --folder-key <key> (obligatorio)
Forma de datos

Code: "ProcessSettingsGet", Data is the process settings object.

uip maestro flow process settings set

Argumentos
  • <process-key> (obligatorio)
Opciones
OpciónDescripción
-f, --folder-key <key>(required) Folder key (GUID).
--inputs <value>Settings payload as a JSON string, an @file path, or piped via stdin.
Forma de datos

Code: "ProcessSettingsSet".

uip maestro flow process variable-tags

Get or update searchability tags on a process's output variables — which variables can be used to filter instances.

uip maestro flow process variable-tags get

Argumentos
  • <process-key> (obligatorio)
Opciones
  • -f, --folder-key <key> (obligatorio)
Forma de datos

Code: "ProcessVariableTagsGet", Data is the process's variableTags map ({} if none are set).

uip maestro flow process variable-tags set

Two mutually exclusive input styles: pass --inputs with a full JSON payload, or use the friendly --variable/--all/--searchable/--tags/--add-tags/--remove-tags flags — combining both fails with an error.

Argumentos
  • <process-key> (obligatorio)
Opciones
OpciónDescripción
-f, --folder-key <key>(required) Folder key (GUID).
--variable <name>Name of a variable (output) to tag. Repeatable, to tag several in one call.
--element-id <id>Element that owns the variable — disambiguates when the same name appears on multiple elements. Only valid with a single --variable.
--allApply the change to every taggable variable.
--searchable <bool>Mark the variable(s) searchable for instance filtering (true/false).
--tags <csv>Advanced: replace the variable's current tags outright. Empty value clears them.
--add-tags <csv>Add tags to the variable's current tags.
--remove-tags <csv>Remove tags from the variable's current tags.
--inputs <value>Full variable-tags payload as a JSON string, an @file path, or piped via stdin — an alternative to the flags above.
Forma de datos

Code: "ProcessVariableTagsSet".


lista de procesos de flujo maestro 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 Maestro

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> (required) — folder key to scope the lookup.

Forma de datos

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}
{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

Consulta uip maestro flow incident para ver la forma por incidente.

uip maestro flow processes diagnose

Correlate a process's summary, incidents, and error codes in one call — a quick triage command.

Argumentos

  • <process-key> (obligatorio) : clave de definición del proceso.

Opciones

  • --folder-key <key> (obligatorio)

Forma de datos

{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}
{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}

uip maestro flow processes error-codes

Get the unique set of error codes seen across a process's incidents.

Argumentos

  • <process-key> (obligatorio)

Opciones

  • --folder-key <key> (obligatorio)

Forma de datos

{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}
{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}

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