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.

uip o procesos

Sintaxis y opciones para `uip o procesos`, que gestiona las vinculaciones de carpetas de paquetes a procesos ejecutables en Orchestrator.

uip or processes las vinculaciones ejecutables de paquetes a carpetas, lo que Orchestrator llama internamente Versiones. Un proceso es lo que uip or jobs start apunta; un paquete es el artefacto .nupkg subyacente (consulta uip or packages).

Sinopsis​

uip or processes <verb> [options]
uip or processes <verb> [options]

Verbos​

VerboPropósito
listEnumerar procesos en una carpeta.
getObtener un proceso por clave, incluidos los esquemas de argumentos y la retención.
resourcesEnumera los recursos del paquete (colas, activos, depósitos, conexiones) requeridos por un proceso.
version-historyEnumera el historial cronológico de versiones de paquetes para un proceso.
createVincula un paquete a una carpeta como un nuevo proceso.
update-versionActualiza uno o más procesos a la última versión del paquete (o a una específica).
update (alias edit)Actualizar la configuración del proceso (semántica PATCH en los campos seleccionados).
deleteEliminar un proceso vinculado por clave (no elimina el paquete).
rollbackRevierte un proceso a su versión anterior del paquete.

uip o lista de procesos​

Enumerar procesos en una carpeta. Requiere --folder-path o --folder-key. Devuelve la clave del proceso (GUID), el nombre, la versión y los metadatos básicos.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--folder-pathRuta—Carpeta de destino por ruta.
—--folder-keyGUID—Carpeta de destino por clave.
—--all-foldersMarcaDesactivadoListado de todo el tenant. Mutuamente exclusivo con --folder-path/--folder-key.
-n--nametext—Contiene coincidencia en el nombre del proceso.
—--process-typeENUM—Process, Agent, Flow, TestAutomationProcess, WebApp, Api, MCPServer, BusinessRules, CaseManagement, Function.
—--all-fieldsMarcaDesactivadoDevuelve la carga útil de la API completa.
-l--limitNúmero50Tamaño de la página.
—--offsetNúmero0Omitir recuento.
—--sort-byCampoId descOrdenación de OData.

Ejemplos​

uip or processes list --folder-path "Shared"
uip or processes list --folder-path "Shared" --process-type Agent
uip or processes list --folder-path "Shared" \
    --output-filter 'Data[].{key:Key, name:Name, v:ProcessVersion}'

# Tenant-wide audit across every folder
uip or processes list --all-folders --name "Invoice"
uip or processes list --folder-path "Shared"
uip or processes list --folder-path "Shared" --process-type Agent
uip or processes list --folder-path "Shared" \
    --output-filter 'Data[].{key:Key, name:Name, v:ProcessVersion}'

# Tenant-wide audit across every folder
uip or processes list --all-folders --name "Invoice"

Forma de datos (--json de salida)​

{
  "Code": "ProcessList",
  "Data": [
    {
      "Key": "c3d4e5f6-0000-0000-0000-000000000001",
      "Name": "InvoiceProcessing",
      "ProcessKey": "InvoiceProcessing",
      "ProcessVersion": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "RetentionPeriod": 30,
      "RetentionAction": "Delete"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
{
  "Code": "ProcessList",
  "Data": [
    {
      "Key": "c3d4e5f6-0000-0000-0000-000000000001",
      "Name": "InvoiceProcessing",
      "ProcessKey": "InvoiceProcessing",
      "ProcessVersion": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "RetentionPeriod": 30,
      "RetentionAction": "Delete"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

FolderId se añade a cada fila solo cuando se utiliza --all-folders.

uip o procesos get​

Obtener un proceso por clave GUID. Devuelve la versión, el punto de entrada, los esquemas de argumentos de entrada/salida, el tipo de proceso y la configuración. No se necesita contexto de carpeta: la clave se resuelve en varias carpetas.

Argumentos​

NombreObligatorioPropósito
<process-key>SíClave de proceso (GUID). Encuéntralo con processes list.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--all-fieldsMarcaDesactivadoDevuelve la carga útil de la API completa.

Ejemplos​

uip or processes get c3d4e5f6-0000-0000-0000-000000000001
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Data.InputArguments'
uip or processes get c3d4e5f6-0000-0000-0000-000000000001
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Data.InputArguments'

Forma de datos (--json de salida)​

{
  "Code": "ProcessGet",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "Processes vendor invoices",
    "IsLatestVersion": true,
    "ProcessType": "Process",
    "EntryPointPath": "Main.xaml",
    "InputArguments": "{\"invoicePath\":\"String\"}",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "AutoUpdate": false,
    "TargetFramework": "Windows",
    "JobPriority": "Normal",
    "SpecificPriorityValue": 50,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete",
    "StaleRetentionPeriod": 0,
    "StaleRetentionAction": "None",
    "HiddenForAttendedUser": false,
    "AutoCreateConnectedTriggers": false
  }
}
{
  "Code": "ProcessGet",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "Processes vendor invoices",
    "IsLatestVersion": true,
    "ProcessType": "Process",
    "EntryPointPath": "Main.xaml",
    "InputArguments": "{\"invoicePath\":\"String\"}",
    "FolderKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "AutoUpdate": false,
    "TargetFramework": "Windows",
    "JobPriority": "Normal",
    "SpecificPriorityValue": 50,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete",
    "StaleRetentionPeriod": 0,
    "StaleRetentionAction": "None",
    "HiddenForAttendedUser": false,
    "AutoCreateConnectedTriggers": false
  }
}

recursos uip o de procesos​

Enumera los recursos del paquete (colas, activos, depósitos, conexiones y otros requisitos del paquete) a los que hace referencia un proceso. Resuelve la carpeta del proceso automáticamente; no se necesita ningún marcador de carpeta.

Argumentos​

NombreObligatorioPropósito
<process-key>SíClave de proceso (GUID). Encuéntralo con processes list.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--all-fieldsMarcaDesactivadoDevuelve la carga útil de la API completa en lugar del resumen seleccionado.

Ejemplos​

uip or processes resources c3d4e5f6-0000-0000-0000-000000000001
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001 --all-fields

Forma de datos (--json de salida)​

{
  "Code": "ProcessResources",
  "Data": [
    {
      "ResourceType": "Queue",
      "ResourceName": "InvoiceQueue",
      "FolderPath": "Shared",
      "ValidationResult": "Success",
      "ValidationError": "",
      "IsOverwritable": true,
      "ResourceKey": "InvoiceQueue",
      "ResourceId": "123456",
      "Id": 0
    }
  ]
}
{
  "Code": "ProcessResources",
  "Data": [
    {
      "ResourceType": "Queue",
      "ResourceName": "InvoiceQueue",
      "FolderPath": "Shared",
      "ValidationResult": "Success",
      "ValidationError": "",
      "IsOverwritable": true,
      "ResourceKey": "InvoiceQueue",
      "ResourceId": "123456",
      "Id": 0
    }
  ]
}

UIP o el historial de versiones de los procesos​

Enumera el historial cronológico de versiones de paquetes asociado a un proceso. La carpeta es opcional: si no se proporciona, se infiere de la clave del proceso.

Argumentos​

NombreObligatorioPropósito
<process-key>SíClave de proceso (GUID).

Opciones​

CortoLargoValorPredeterminadoDescripción
—--folder-pathRutainferidoOmita la detección automática y utilice esta carpeta.
—--folder-keyGUIDinferidoOmita la detección automática y utilice esta carpeta.
—--all-fieldsMarcaDesactivadoDevuelve la carga útil de la API completa en lugar del resumen seleccionado.

Ejemplos​

uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001
uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001

Forma de datos (--json de salida)​

{
  "Code": "ProcessVersionHistory",
  "Data": [
    {
      "Version": "1.0.0",
      "CreatedAt": "2024-01-10T08:30:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1001
    },
    {
      "Version": "1.0.2",
      "CreatedAt": "2024-01-15T09:45:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1002
    }
  ]
}
{
  "Code": "ProcessVersionHistory",
  "Data": [
    {
      "Version": "1.0.0",
      "CreatedAt": "2024-01-10T08:30:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1001
    },
    {
      "Version": "1.0.2",
      "CreatedAt": "2024-01-15T09:45:00.000Z",
      "ReleaseName": "InvoiceProcessing",
      "ReleaseId": 101,
      "Id": 1002
    }
  ]
}

creación de uip o procesos​

Vincula un paquete a una carpeta como proceso. Requiere --folder-path o --folder-key y tres opciones de paquete necesarias. Utiliza uip or packages list para la clave del paquete y uip or packages versions para las versiones disponibles.

Opciones​

Obligatorio​
CortoLargoValorPredeterminadoDescripción
—--nametext—Nombre del proceso dentro de la carpeta.
—--package-keytext—Clave de paquete (la PackageId de packages list).
—--package-version2020.x—Versión del paquete (por ejemplo, 1.0.0).
Identidad y ámbito​
CortoLargoValorPredeterminadoDescripción
—--folder-pathRuta—Carpeta de destino por ruta.
—--folder-keyGUID—Carpeta de destino por clave.
Configuración del proceso​
CortoLargoValorPredeterminadoDescripción
—--descriptiontext—Descripción del proceso.
—--entry-pointRuta—Ruta del flujo de trabajo del punto de entrada (para paquetes de varios puntos de entrada).
—--input-argumentsJSON—Argumentos de entrada predeterminados como JSON.
—--job-priorityENUM—Low, Normal, High. Mutuamente excluyente con --specific-priority.
—--specific-priority1–100—Prioridad numérica. Mutuamente excluyente con --job-priority.
—--robot-sizeENUM—Tamaño de Cloud Robot: Small, Standard, Medium, Large.
—--tagsCSV—Nombres de etiquetas separados por comas.
—--environment-variablestext—Variables de entorno como pares KEY=VALUE separados por saltos de línea (no JSON), por ejemplo $'FOO=bar\nBAZ=qux'.
—--auto-update / --no-auto-updateMarca—Habilitar/deshabilitar la actualización automática a la última versión del paquete.
—--hidden-for-attended / --visible-for-attendedMarca—Ocultar o mostrar a los usuarios atendidos. Mutuamente excluyentes.
—--auto-create-triggers / --no-auto-create-triggersMarca—Crear automáticamente desencadenadores conectados en la implementación.
Retención​
CortoLargoValorPredeterminadoDescripción
—--retention-perioddías (1–180)30Período de retención del trabajo.
—--retention-actionENUMDeleteDelete, Archive o None.
—--retention-bucketID de depósito—ID de depósito de almacenamiento. Obligatorio cuando --retention-action Archive.
—--stale-retention-perioddías—Período de retención de trabajo obsoleto.
—--stale-retention-actionENUM—Delete, Archive o None.

Ejemplos​

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" \
    --package-key InvoiceProcessing --package-version 1.0.2

uip or processes create --folder-path "Production/EU" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --job-priority High --auto-update --tags "finance,eu"

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --output-filter 'Data.Key'
uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" \
    --package-key InvoiceProcessing --package-version 1.0.2

uip or processes create --folder-path "Production/EU" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --job-priority High --auto-update --tags "finance,eu"

uip or processes create --folder-path "Shared" \
    --name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
    --output-filter 'Data.Key'

Forma de datos (--json de salida)​

{
  "Code": "ProcessCreated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000010",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "",
    "IsLatestVersion": true,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete"
  }
}
{
  "Code": "ProcessCreated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000010",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "ProcessVersion": "1.0.2",
    "Description": "",
    "IsLatestVersion": true,
    "RetentionPeriod": 30,
    "RetentionAction": "Delete"
  }
}

uip o procesos actualizar-versión​

Actualiza uno o más procesos a la última versión del paquete o a una versión específica con --package-version. La carpeta es opcional: si no se proporciona, se infiere de la primera clave del proceso.

  • Una clave + ninguna --package-version → actualizar a la última (llamada única a la API).
  • Una tecla + --package-version → actualizar a esa versión (llamada única a la API).
  • Varias claves + ninguna --package-version → actualización masiva a la última.
  • Varias claves + --package-version → rechazado (error de validación).

Los trabajos en ejecución no se ven afectados; solo los trabajos nuevos utilizan la versión actualizada.

Argumentos​

NombreObligatorioPropósito
<process-keys...>SíUna o más claves de proceso (GUID).

Opciones​

CortoLargoValorPredeterminadoDescripción
—--folder-pathRutainferidoOmita la detección automática y utilice esta carpeta.
—--folder-keyGUIDinferidoOmita la detección automática y utilice esta carpeta.
—--package-version2020.x—Versión específica. Solo es válido con una sola clave.

Ejemplos​

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001 \
    --package-version 1.0.3

uip or processes update-version \
    c3d4e5f6-0000-0000-0000-000000000001 \
    c3d4e5f6-0000-0000-0000-000000000002 \
    --output-filter 'Data.Version'
uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001

uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001 \
    --package-version 1.0.3

uip or processes update-version \
    c3d4e5f6-0000-0000-0000-000000000001 \
    c3d4e5f6-0000-0000-0000-000000000002 \
    --output-filter 'Data.Version'

Forma de datos (--json de salida)​

Clave única:

{
  "Code": "ProcessVersionUpdated",
  "Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}
{
  "Code": "ProcessVersionUpdated",
  "Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}

Devuelve Code: "ProcessVersionsUpdated" de forma masiva con ProcessKeys, Version y un objeto Result repetido desde la API.

actualización de uip o procesos​

Actualizar la configuración del proceso por clave. Lee los valores actuales, aplica los campos PATCH proporcionados y guarda. Solo se cambian los campos proporcionados; los campos omitidos en la CLI se conservan del estado actual. No se necesita marcador de carpeta: la clave se resuelve en varias carpetas.

edit es un alias registrado para este verbo: uip or processes edit funciona de forma idéntica a uip or processes update.

Argumentos​

NombreObligatorioPropósito
<process-key>SíClave de proceso (GUID).

Opciones​

Los mismos campos que processes create excepto por las tres opciones de paquete necesarias y los marcadores de ámbito. Las reglas de exclusión mutua y validación coinciden create (--job-priority frente a --specific-priority, --hidden-for-attended frente a --visible-for-attended, Archive la retención requiere --retention-bucket).

CortoLargoValorPredeterminadoDescripción
-n--nametext—Nuevo nombre para mostrar.
-d--descriptiontext—Nueva descripción.
—--entry-pointRuta—Nueva ruta de punto de entrada.
—--input-argumentsJSON—Argumentos de entrada predeterminados.
—--environment-variablestext—Pares KEY=VALUE separados por saltos de línea (no JSON). Pulse '' para borrarlos.
—--job-priorityENUM—Low, Normal, High.
—--specific-priority1–100—Prioridad numérica.
—--auto-update / --no-auto-updateMarca—Alternar actualización automática.
—--hidden-for-attended / --visible-for-attendedMarca—Visibilidad atendida.
—--auto-create-triggers / --no-auto-create-triggersMarca—Creación automática de desencadenadores conectados.
—--healing-agent / --no-healing-agentMarca—Habilita o deshabilita Healing Agent (Autopilot para Robots) para este proceso. Los trabajos futuros lo utilizan de forma predeterminada una vez habilitado; Autopilot a nivel de tenant ya debe estar activado.
—--retention-perioddías (1–180)—Período de retención del trabajo.
—--retention-actionENUM—Delete, Archive, None.
—--retention-bucketID de depósito—Obligatorio cuando --retention-action Archive.
—--stale-retention-perioddías—Período de retención de trabajo obsoleto.
—--stale-retention-actionENUM—Delete, Archive, None.

Ejemplos​

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --description "Monthly invoice batch"

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --job-priority High --retention-period 60

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --auto-update --output-filter 'Data.Status'
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --description "Monthly invoice batch"

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --job-priority High --retention-period 60

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --auto-update --output-filter 'Data.Status'

Forma de datos (--json de salida)​

{
  "Code": "ProcessUpdated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "Status": "Updated successfully"
  }
}
{
  "Code": "ProcessUpdated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "Status": "Updated successfully"
  }
}

eliminar uip o procesos​

Eliminar una vinculación de proceso por clave. Esto elimina la vinculación de la versión de su carpeta; no elimina el paquete subyacente.

Argumentos​

NombreObligatorioPropósito
<process-key>SíClave de proceso (GUID). Encuéntralo con processes list.

Opciones​

CortoLargoValorPredeterminadoDescripción
-y--yesMarca—Obligatorio. Confirma esta operación irreversible: la CLI nunca solicita.

Ejemplos​

uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes
uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes

Forma de datos (--json de salida)​

{
  "Code": "ProcessDeleted",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "Status": "Deleted successfully"
  }
}
{
  "Code": "ProcessDeleted",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "ProcessKey": "InvoiceProcessing",
    "Status": "Deleted successfully"
  }
}

reversión de uip o procesos​

Revierte un proceso a su versión anterior del paquete. La carpeta es opcional: si no se proporciona, se infiere de la clave del proceso.

Argumentos​

NombreObligatorioPropósito
<process-key>SíClave de proceso (GUID).

Opciones​

CortoLargoValorPredeterminadoDescripción
—--folder-pathRutainferidoOmitir la detección automática.
—--folder-keyGUIDinferidoOmitir la detección automática.

Ejemplos​

uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --folder-path "Shared"
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Data.Status'
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --folder-path "Shared"
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
    --output-filter 'Data.Status'

Forma de datos (--json de salida)​

{
  "Code": "ProcessRolledBack",
  "Data": {
    "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "Status": "Rolled back to previous version"
  }
}
{
  "Code": "ProcessRolledBack",
  "Data": {
    "ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
    "Status": "Rolled back to previous version"
  }
}

Códigos de salida​

Consulta Códigos de salida. No hay anulaciones específicas de verbos más allá de los errores de validación estándar.

  • uip or packages — busca claves de paquete (packages list), versiones (packages versions) y puntos de entrada (packages entry-points) antes de llamar a processes create.
  • uip or jobs , especialmente jobs start, que requiere una clave de proceso.
  • uip or folders : crea o localiza la carpeta de destino antes de vincular.

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