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

Registro de flujo de UIP

uip flow registry por el registro del nodo de flujo : el catálogo de bloques de creación que se pueden utilizar dentro de un archivo .flow . El registro contiene actividades OOTB (uipath.agent, uipath.http, …) y nodos conectores que llaman a las API de terceros (Slack, Salesforce, Jira, …). Al iniciar sesión, el registro incluye además nodos de conector instalados en tu tenant.

El registro se comparte en todas las superficies de flujo de trabajo de UiPath; la misma implementación respalda uip maestro (consulta el registro maestro, expuesto a través de uip maestro bpmn registry).

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

Sinopsis

uip flow registry pull   [-f, --force]
uip flow registry list   [-l, --limit <n>] [--local]
uip flow registry search [<keyword>] [-f, --filter <expr>] [--local]
uip flow registry get    <nodeType> [--connection-id <id>] [--local]
uip flow registry pull   [-f, --force]
uip flow registry list   [-l, --limit <n>] [--local]
uip flow registry search [<keyword>] [-f, --filter <expr>] [--local]
uip flow registry get    <nodeType> [--connection-id <id>] [--local]

Flujo de trabajo típico

# 0. (Optional) Login for the full, tenant-enriched registry
uip login

# 1. Sync the registry (once per session — cache expires after 30 minutes)
uip flow registry pull

# 2. Search for a candidate node
uip flow registry search slack --filter "displayname:contains=send"

# 3. Inspect the full schema
uip flow registry get uipath.connector.slack.send-message

# 4. Extract just the input field definitions (useful for building requests)
uip flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields"
# 0. (Optional) Login for the full, tenant-enriched registry
uip login

# 1. Sync the registry (once per session — cache expires after 30 minutes)
uip flow registry pull

# 2. Search for a candidate node
uip flow registry search slack --filter "displayname:contains=send"

# 3. Inspect the full schema
uip flow registry get uipath.connector.slack.send-message

# 4. Extract just the input field definitions (useful for building requests)
uip flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields"

Sin inicio de sesión, solo se devuelven los nodos integrados (OOTB).


extracción de registro de flujo de uip

Obtiene el registro del nodo y lo escribe en una caché local. Las llamadas posteriores list, search y get leen desde esta caché.

Opciones

  • -f, --force — fuerza la actualización, ignorando la caché.

Cache behavior

  • La caché caduca después de 30 minutos. Una caché caducada o faltante desencadena una recuperación en vivo.
  • Cuando no se ha iniciado sesión, los nodos OOTB se devuelven sin actualizar la caché.
  • En caso de fallo de obtención autenticada, el comando recurre a los nodos OOTB sin actualizar la caché.

Data shape (--output json)

{
  "Code": "NodePullSuccess",
  "Data": {
    "NodesCount":   184,
    "FromCache":    false,
    "AgeMinutes":   null,
    "Source":       "authenticated",
    "CacheWritten": true,
    "Message":      "Synced fresh nodes",
    "Info":         null
  }
}
{
  "Code": "NodePullSuccess",
  "Data": {
    "NodesCount":   184,
    "FromCache":    false,
    "AgeMinutes":   null,
    "Source":       "authenticated",
    "CacheWritten": true,
    "Message":      "Synced fresh nodes",
    "Info":         null
  }
}

Source es "ootb" (no autenticado) o "authenticated" (específico del tenant). AgeMinutes se rellena cuando FromCache: true.


lista de registro de flujo de uip

Nodos en caché de muestra. Por defecto, las 20 primeras entradas.

Opciones

OpciónPredeterminadoDescripción
-l, --limit <n>20Número de nodos que devolver. Aprobado -1 para todos. Debe ser un número entero positivo o -1.
--localDesactivadoMostrar solo nodos de proyecto en solución. Requiere un .uipx en el CWD, principal o principal.

Si se llama a list sin un pull previo, el servicio obtiene primero los datos en vivo.

Forma de datos

{
  "Code": "NodeListSuccess",
  "Data": [
    {
      "NodeType":    "uipath.slack.connector.send-message",
      "Category":    "connector",
      "DisplayName": "Send Message",
      "Description": "Post a message to a Slack channel",
      "Version":     "1.0.0",
      "Tags":        "slack, messaging"
    }
  ]
}
{
  "Code": "NodeListSuccess",
  "Data": [
    {
      "NodeType":    "uipath.slack.connector.send-message",
      "Category":    "connector",
      "DisplayName": "Send Message",
      "Description": "Post a message to a Slack channel",
      "Version":     "1.0.0",
      "Tags":        "slack, messaging"
    }
  ]
}

Si el resultado se trunca, se emite una línea de registro en stderr que muestra el total frente al mostrado.


Encuentre nodos por palabra clave, por filtro estructurado o ambos.

Argumentos

  • [keyword] : subcadena coincidente con nodeType, category, tags, display.label, description.

Opciones

OpciónDescripción
-f, --filter <expr>Filtro de campo estructurado (consulta la sintaxis a continuación).
--localBuscar solo nodos en la solución (requiere .uipx cerca).

Se requiere al menos uno de <keyword> o --filter .

Sintaxis de filtro

field=value                     # equality (default operator)
field:operator=value            # operator variant
field1=v1,field2=v2             # multiple conditions (AND)
field=value                     # equality (default operator)
field:operator=value            # operator variant
field1=v1,field2=v2             # multiple conditions (AND)

Operadores: equals (predeterminado), contains, startsWith, endsWith, in.

Campos filtrables (alias mostrado entre paréntesis):

  • category [cat] — p. ej. connector, agent, trigger
  • type [nodetype] — identificador de tipo de nodo
  • tags [tag] — etiquetas de nodo
  • displayname [display_name, name, label] — nombre legible por humanos
Ejemplos
uip flow registry search slack
uip flow registry search --filter "category=connector"
uip flow registry search --filter "displayname:contains=send message"
uip flow registry search slack --filter "category=connector"
uip flow registry search --filter "tags:in=ai,automation"
uip flow registry search --filter "category=connector,displayname:contains=slack"
uip flow registry search slack
uip flow registry search --filter "category=connector"
uip flow registry search --filter "displayname:contains=send message"
uip flow registry search slack --filter "category=connector"
uip flow registry search --filter "tags:in=ai,automation"
uip flow registry search --filter "category=connector,displayname:contains=slack"

Forma de los datos: la misma forma que listCode: "NodeSearchSuccess", Data: [flattened nodes…].


obtención del registro de flujo de uip

Devolver detalles completos para un solo nodo.

Argumentos

  • <nodeType> (obligatorio) : identificador de tipo de nodo (no distingue entre mayúsculas y minúsculas).

Opciones

OpciónDescripción
--connection-id <id>ID de conexión para el enriquecimiento de Integration Service. Obligatorio para los nodos de desencadenador de conector; opcional para los nodos de actividad del conector.
--localObtener nodo solo de proyectos en solución.

Enriquecimiento de Integration Service

Para los nodos "connector" etiquetados, get llama automáticamente a Integration Service y fusiona los metadatos activos:

Nodos de actividad del conector (uipath.connector.*, no desencadenador):

  • inputDefinition.fields[] : campos a configurar. Cada uno tiene name, displayName, type, required y, opcionalmente reference (búsqueda: objectName, path, lookupValue, lookupNames, childPath) o enum.
  • outputResponseDefinition — campos producidos después de que se ejecute el nodo.
  • connectorMethodInfo : método HTTP, ruta, IDDeOperación.
  • --connection-id es opcional; pasar uno agrega campos personalizados específicos para esa cuenta.

Nodos de desencadenador de conector (uipath.connector.trigger.*):

  • eventParameters : campos que configuran el desencadenador (por ejemplo, qué carpeta vigilar).
  • filterFields : campos utilizados para filtrar qué eventos activan el desencadenador.
  • outputResponseDefinition : campos producidos por la carga útil del evento.
  • eventMode"webhooks" o "polling".
  • Se requiere inicio de sesión y --connection-id ; sin ambos, no se devuelve ningún enriquecimiento.

Metadatos por campo de entrada

Cada entrada bajo inputDefinition.fields:

PropiedadDescripción
nameClave JSON para la solicitud/respuesta.
displayNameEtiqueta legible por humanos.
typeTipo de datos (string, boolean, integer, …).
requiredtrue si es obligatorio (solo campos de entrada).
descriptionLo que hace el campo.
enumValores permitidos (si están restringidos).
referenceMetadatos de referencia de objetos: el campo espera un ID, no un nombre simple.
responseOnlytrue en los campos de salida.
Forma de datos
{
  "Code": "NodeGetSuccess",
  "Data": {
    "Node": {
      "nodeType":        "uipath.slack.connector.send-message",
      "category":        "connector",
      "display":         { "label": "Send Message" },
      "inputDefinition": {
        "fields": [
          { "name": "channel", "required": true, "type": "string" }
        ]
      }
    }
  }
}
{
  "Code": "NodeGetSuccess",
  "Data": {
    "Node": {
      "nodeType":        "uipath.slack.connector.send-message",
      "category":        "connector",
      "display":         { "label": "Send Message" },
      "inputDefinition": {
        "fields": [
          { "name": "channel", "required": true, "type": "string" }
        ]
      }
    }
  }
}

Ejemplos

# Basic activity lookup (anonymous, OOTB)
uip flow registry get uipath.agent

# Connector activity with optional account-specific enrichment
uip flow registry get uipath.connector.uipath-salesforce-slack.send-message \
  --connection-id <connection-id>

# Connector trigger — requires login + connection-id
uip flow registry get uipath.connector.trigger.uipath-microsoft-outlook365.email-received \
  --connection-id <connection-id>

# Just the input fields, for building a request body
uip flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields" --output json
# Basic activity lookup (anonymous, OOTB)
uip flow registry get uipath.agent

# Connector activity with optional account-specific enrichment
uip flow registry get uipath.connector.uipath-salesforce-slack.send-message \
  --connection-id <connection-id>

# Connector trigger — requires login + connection-id
uip flow registry get uipath.connector.trigger.uipath-microsoft-outlook365.email-received \
  --connection-id <connection-id>

# Just the input fields, for building a request body
uip flow registry get uipath.connector.slack.send-message \
  --output-filter "Node.inputDefinition.fields" --output json

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