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 maestro flow nodes and uip maestro flow edges

Syntax and options for `uip maestro flow nodes` and `uip maestro flow edges`, which create, configure, list, and delete nodes and edges in a `.flow` file.

Un flujo es un gráfico. Los nodos son los vértices (desencadenadores, actividades, conectores, agentes); los bordes son las conexiones dirigidas entre ellos. Los comandos uip maestro flow nodes y uip maestro flow edges editan un archivo .flow in situ: añaden, configuran, enumeran y eliminan ambos.

Esta página también cubre dos grupos de comandos complementarios que editan el archivo .flow de la misma manera: variables y bindings.

Sinopsis​

uip maestro flow nodes create    <file> <node-type> [-i <json>] [--position <x,y>] [--label <label>] [--source <uuid>] [--parent <node-id>] [--metadata <file> --scripts <dir>]
uip maestro flow nodes configure <file> <node-id> --detail <json>
uip maestro flow nodes list      <file> [--limit <n>] [--offset <n>]
uip maestro flow nodes delete    <file> <node-id>

uip maestro flow edges create <file> <source-id> <target-id> [--source-port <port>] [--target-port <port>]
uip maestro flow edges list   <file> [--limit <n>] [--offset <n>]
uip maestro flow edges delete <file> <edge-id>
uip maestro flow nodes create    <file> <node-type> [-i <json>] [--position <x,y>] [--label <label>] [--source <uuid>] [--parent <node-id>] [--metadata <file> --scripts <dir>]
uip maestro flow nodes configure <file> <node-id> --detail <json>
uip maestro flow nodes list      <file> [--limit <n>] [--offset <n>]
uip maestro flow nodes delete    <file> <node-id>

uip maestro flow edges create <file> <source-id> <target-id> [--source-port <port>] [--target-port <port>]
uip maestro flow edges list   <file> [--limit <n>] [--offset <n>]
uip maestro flow edges delete <file> <edge-id>

Prevalece las opciones globales. Los códigos de salida siguen el contrato estándar.

The singular group names node, edge, variable, and binding are aliases of nodes, edges, variables, and bindings. add is an alias of create in all four groups, and remove is an alias of delete in variables and bindings.


uip maestro flow nodes create​

Create a node in a .flow file. The node type must exist in the registry — use uip maestro flow registry search to discover valid <node-type> values.

Argumentos​

  • <file> (obligatorio) : ruta al archivo .flow .
  • <node-type> (obligatorio) : identificador de tipo de nodo (p. ej. core.trigger.manual, uipath.connector.slack.send-message).

Opciones​

OpciónDescripción
-i, --input <json>Objeto JSON de valores de entrada para establecer en el nodo (por ejemplo '{"script":"…"}'). Debe ser un objeto JSON, no una matriz o escalar. Para los nodos de conector (tipo uipath.connector.*), no pase --input aquí; ejecute nodes configure después.
--position <x,y>Posición del lienzo, p. ej. 250,150. Tanto x como y son números obligatorios.
--label <label>Mostrar etiqueta para el nodo.
--source <uuid>UUID de origen para tipos de nodos cuya definición declara una dependencia de origen (rellena inputs.source). Para un nodo de agente en línea, pasa el ProjectId del agente. Para un nodo de recursos de agente, pasa el recurso id desde el resources[] del agente en línea principal.
--parent <node-id>ID del nodo existente que debe contener este nodo: se establece al crear un cuerpo de bucle cuya contención no se puede inferir solo de los bordes (normalmente el ID de un nodo core.logic.loop).
--metadata <file>Solo actividades fuera del catálogo. El archivo de metadatos de la actividad (<Name>.json) generado por uip is activities metadata generate. La definición de nodo se crea a partir de este archivo en lugar del registro, y <node-type> debe ser uipath.connector.custom.<connector-key>.<slug>. Requiere --scripts.
--scripts <dir>Solo actividades fuera del catálogo. Directorio que contiene <scriptRef>.js para la acción y para cada búsqueda a la que hacen referencia los metadatos. Las fuentes del script están incrustadas en el nodo. Requiere --metadata.

Ejemplo​

uip maestro flow nodes create invoice-flow.flow uipath.connector.slack.send-message --label "Notify team"
uip maestro flow nodes create invoice-flow.flow uipath.connector.slack.send-message --label "Notify team"

Forma de datos (--output json)​

{
  "Code": "NodeAddSuccess",
  "Data": {
    "Node": { "id": "node_a1b2c3d4", "type": "uipath.connector.slack.send-message" },
    "DefinitionAdded": true,
    "BindingsCreated": 0,
    "VariableCount": 0
  }
}
{
  "Code": "NodeAddSuccess",
  "Data": {
    "Node": { "id": "node_a1b2c3d4", "type": "uipath.connector.slack.send-message" },
    "DefinitionAdded": true,
    "BindingsCreated": 0,
    "VariableCount": 0
  }
}

DefinitionAdded es true en la primera inserción de un node-type dado: se crea la entrada correspondiente en la matriz .flow definitions[] .

Al pasar solo uno de --metadata y --scripts , el comando falla.


uip maestro flow nodes configure​

Populate inputs.detail on an already-added node and create the workflow bindings it needs. Run this after nodes create for connector, managed HTTP, and file nodes (core.action.file.read, core.action.file.create). A file node's Orchestrator connection is bound only by nodes configure; a connectionId passed in nodes create --input is not bound.

Argumentos​

  • <file> (obligatorio) : ruta al archivo .flow .
  • (obligatorio) <node-id> ID del nodo a configurar (encuéntralo con nodes list).

Opciones​

  • --detail <json> (obligatorio) : JSON de configuración. La forma depende del tipo de nodo:

Nodos de conector (uipath.connector.*)​

Obtener method y endpoint de connectorMethodInfo en la salida registry get .

  • Requerido: connectionId, folderKey, method, endpoint
  • Required for Generic activities (manifest activityType Generic, such as *.insert-record or *.list-records): objectName. Discover objects with uip is resources list and uip is resources describe.
  • Optional: bodyParameters, queryParameters, pathParameters, filter, customFieldsRequestDetails

A value that reads another node's output must use the $vars. prefix inside the =js: expression, for example "=js:$vars.createEntityRecord1.output.Id". The bare form ("=js:createEntityRecord1.output.Id") resolves to undefined at runtime.

uip maestro flow nodes configure invoice-flow.flow node_a1b2c3d4 --detail '{
  "connectionId": "b2c3d4e5-0000-0000-0000-000000000001",
  "folderKey":    "c3d4e5f6-0000-0000-0000-000000000001",
  "method":       "POST",
  "endpoint":     "/issues",
  "bodyParameters": { "summary": "Bug" }
}'
uip maestro flow nodes configure invoice-flow.flow node_a1b2c3d4 --detail '{
  "connectionId": "b2c3d4e5-0000-0000-0000-000000000001",
  "folderKey":    "c3d4e5f6-0000-0000-0000-000000000001",
  "method":       "POST",
  "endpoint":     "/issues",
  "bodyParameters": { "summary": "Bug" }
}'

Connector triggers and wait-for events (uipath.connector.trigger., uipath.connector.event.)​

A connector trigger starts the flow; a wait-for event node pauses the flow until the event fires. Both take the same detail shape.

  • Required: connectionId, folderKey, eventMode (for example polling or webhooks)
  • Required for Generic triggers and events (manifest activityType GenericTrigger, such as a Data Fabric *.record-created): objectName, the object to subscribe to
  • Optional: eventParameters, queryParameters, pathParameters, filter (a structured filter tree, not a raw expression)

Discover eventMode with uip is triggers describe <connector-key> <eventType> <object> --connection-id <uuid>.

uip maestro flow nodes configure invoice-flow.flow node_trigger1 --detail '{"connectionId":"…","folderKey":"…","eventMode":"polling"}'
uip maestro flow nodes configure invoice-flow.flow node_trigger1 --detail '{"connectionId":"…","folderKey":"…","eventMode":"polling"}'

File nodes (core.action.file.read, core.action.file.create)​

Bind the Orchestrator connection the node uses to reach job attachments.

  • Required: connectionId (a uipath-uipath-orchestrator connection UUID)
  • Optional: folderKey (defaults to the connection's folder)
uip maestro flow nodes configure invoice-flow.flow node_file1 --detail '{"connectionId":"…"}'
uip maestro flow nodes configure invoice-flow.flow node_file1 --detail '{"connectionId":"…"}'

Nodos HTTP gestionados (core.action.http.v2)​

Dos modos de autenticación:

Modo de conector (authentication: "connector"): utiliza una conexión de Integration Service para la autenticación:

  • Requerido: authentication, method, connectionId, folderKey, targetConnector
  • method ∈ GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD
  • Opcional: url (ruta adjunta a la URL base del conector), headers, query, body
uip maestro flow nodes configure invoice-flow.flow node_abc --detail '{
  "authentication":  "connector",
  "targetConnector": "uipath-microsoft-outlook365",
  "connectionId":    "…",
  "folderKey":       "…",
  "method":          "GET",
  "url":             "/me"
}'
uip maestro flow nodes configure invoice-flow.flow node_abc --detail '{
  "authentication":  "connector",
  "targetConnector": "uipath-microsoft-outlook365",
  "connectionId":    "…",
  "folderKey":       "…",
  "method":          "GET",
  "url":             "/me"
}'

Modo manual (authentication: "manual"): sin autenticación de conector, proporciona tú mismo la URL completa y cualquier encabezado de autenticación:

  • Obligatorio: authentication, method, url (URL completa)
  • Opcional: headers, query, body (cadena; puede ser una expresión, por ejemplo =js:({…}))
uip maestro flow nodes configure invoice-flow.flow node_abc --detail '{
  "authentication": "manual",
  "method":         "GET",
  "url":            "https://api.example.com/data",
  "headers":        { "Authorization": "Bearer <token>" }
}'
uip maestro flow nodes configure invoice-flow.flow node_abc --detail '{
  "authentication": "manual",
  "method":         "GET",
  "url":            "https://api.example.com/data",
  "headers":        { "Authorization": "Bearer <token>" }
}'

Forma de datos (--output json)​

{
  "Code": "NodeConfigureSuccess",
  "Data": {
    "NodeId": "node_a1b2c3d4",
    "BindingsCreated": 2,
    "DetailPopulated": true
  }
}
{
  "Code": "NodeConfigureSuccess",
  "Data": {
    "NodeId": "node_a1b2c3d4",
    "BindingsCreated": 2,
    "DetailPopulated": true
  }
}

uip maestro flow nodes list​

Enumera todos los nodos en un archivo .flow .

Argumentos​

  • <file> (obligatorio) : ruta al archivo .flow .

Opciones​

OpciónDescripción
-l, --limit <number>Number of rows to return, 1–10000.
--offset <number>Number of rows to skip, 0–1000000. Default 0.

Without --limit or --offset, every row comes back. With either one, Count is the number of rows returned, and the response carries a Pagination object with:

  • Returned
  • Limit
  • Offset
  • Total
  • HasMore

Forma de datos (--output json)​

{
  "Code": "NodeListSuccess",
  "Data": {
    "Nodes": [
      { "id": "start",          "type": "core.trigger.manual" },
      { "id": "node_a1b2c3d4",  "type": "core.action.http.v2" }
    ],
    "Count": 2
  }
}
{
  "Code": "NodeListSuccess",
  "Data": {
    "Nodes": [
      { "id": "start",          "type": "core.trigger.manual" },
      { "id": "node_a1b2c3d4",  "type": "core.action.http.v2" }
    ],
    "Count": 2
  }
}

Cada entrada incluye como mínimo id y type; el servicio también adjunta metadatos de visualización de la matriz .flow definitions[] .


uip maestro flow nodes delete​

Delete a node and everything it owns. Use nodes list to find the node ID. Deletes:

  • Bordes conectados
  • Vinculaciones huérfanas
  • Definiciones huérfanas
  • Variables de nodo propiedad del nodo eliminado
  • Actualizaciones de variables propiedad del nodo eliminado

Argumentos​

  • <file> (obligatorio) : ruta al archivo .flow .
  • <node-id> obligatorio) : ID del nodo a eliminar.

Forma de datos (--output json)​

{
  "Code": "NodeDeleteSuccess",
  "Data": {
    "DeletedNode":           { "id": "node_a1b2c3d4", "type": "core.action.http.v2" },
    "EdgesRemoved":          1,
    "BindingsRemoved":       0,
    "DefinitionsRemoved":    0,
    "VariablesRemoved":      0,
    "VariableUpdatesRemoved": 0
  }
}
{
  "Code": "NodeDeleteSuccess",
  "Data": {
    "DeletedNode":           { "id": "node_a1b2c3d4", "type": "core.action.http.v2" },
    "EdgesRemoved":          1,
    "BindingsRemoved":       0,
    "DefinitionsRemoved":    0,
    "VariablesRemoved":      0,
    "VariableUpdatesRemoved": 0
  }
}

uip maestro flow edges create​

Create an edge between two nodes.

Argumentos​

  • <file> (obligatorio) : ruta al archivo .flow .
  • <source-id> obligatorio) : ID del nodo de origen.
  • <target-id> obligatorio) : ID del nodo de destino.

Opciones​

  • --source-port <port> — source port name. Defaults to the port the node's definition marks as default, else output, else the node's only flow port. A node with several flow ports and no default, such as a decision, needs --source-port (for example --source-port true).
  • --target-port <port> — target port name. Defaults to the port the node's definition marks as default, else input, else the node's only flow port.

Running the command again with the same arguments returns the existing edge with Code: "EdgeAlreadyExists" and writes a warning to stderr.

Forma de datos (--output json)​

{
  "Code": "EdgeAddSuccess",
  "Data": {
    "Edge": {
      "id":         "edge_a1b2c3d4",
      "source":     "Node_1",
      "target":     "Node_2",
      "sourcePort": "output",
      "targetPort": "input"
    }
  }
}
{
  "Code": "EdgeAddSuccess",
  "Data": {
    "Edge": {
      "id":         "edge_a1b2c3d4",
      "source":     "Node_1",
      "target":     "Node_2",
      "sourcePort": "output",
      "targetPort": "input"
    }
  }
}

uip maestro flow edges list​

List all edges in a .flow file.

uip maestro flow edges list <file> [--limit <n>] [--offset <n>]
uip maestro flow edges list <file> [--limit <n>] [--offset <n>]

Opciones​

OpciónDescripción
-l, --limit <number>Number of rows to return, 1–10000.
--offset <number>Number of rows to skip, 0–1000000. Default 0.

Without --limit or --offset, every row comes back. With either one, Count is the number of rows returned, and the response carries a Pagination object with:

  • Returned
  • Limit
  • Offset
  • Total
  • HasMore
{
  "Code": "EdgeListSuccess",
  "Data": {
    "Edges": [
      { "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
    ],
    "Count": 1
  }
}
{
  "Code": "EdgeListSuccess",
  "Data": {
    "Edges": [
      { "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
    ],
    "Count": 1
  }
}

uip maestro flow edges delete​

Deletes a single edge by ID. Use edges list to find the ID.

Argumentos​

  • <file> (obligatorio) : ruta al archivo .flow .
  • <edge-id> (required) — ID of the edge to delete.

Forma de datos (--output json)​

{
  "Code": "EdgeDeleteSuccess",
  "Data": {
    "DeletedEdge": { "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
  }
}
{
  "Code": "EdgeDeleteSuccess",
  "Data": {
    "DeletedEdge": { "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
  }
}

Variables​

The variables group edits the variables subtree of a .flow file.

uip maestro flow variables​

uip maestro flow variables create <file> <variable-id> -d, --direction <direction> [-t, --type <type>] [--default-value <val>] [--description <text>] [--schema <json>] [--sub-type <type>] [--trigger-node-id <nodeId>]
uip maestro flow variables list   <file> [--limit <n>] [--offset <n>]
uip maestro flow variables delete <file> <variable-id>
uip maestro flow variables create <file> <variable-id> -d, --direction <direction> [-t, --type <type>] [--default-value <val>] [--description <text>] [--schema <json>] [--sub-type <type>] [--trigger-node-id <nodeId>]
uip maestro flow variables list   <file> [--limit <n>] [--offset <n>]
uip maestro flow variables delete <file> <variable-id>
  • direction ∈ in, out, inout (obligatorio).
  • type ∈ string, number, boolean, object, array, file (predeterminado string).
  • --default-value se analiza por --type : los valores object/array deben ser JSON válidos de la forma coincidente.
  • --schema debe ser un objeto JSON (por ejemplo '{"type":"string"}').
  • --trigger-node-id <nodeId> : el nodo desencadenador al que pertenece una variable de entrada . El valor predeterminado es el único nodo desencadenador del flujo; requerido cuando el flujo tiene más de un punto de entrada.

list takes --limit and --offset, as nodes list does.

Data shapes: VariableAddSuccess (Data.Variable) for create, VariableListSuccess (Data.Variables[], Count), VariableRemoveSuccess (Data.DeletedVariable) for delete.


Bindings​

Las vinculaciones declaran los recursos externos que necesita un flujo en el momento de la publicación/implementación (un proceso de destino, un agente, una conexión, una cola, etc.) y a qué propiedad de nodo se conectan.

uip maestro flow bindings create <file> <name> <resource> <default-value> [--resource-key <key>] [--property-attribute <attr>] [--resource-sub-type <type>]
uip maestro flow bindings list   <file> [--limit <n>] [--offset <n>]
uip maestro flow bindings delete <file> <resource-key>
uip maestro flow bindings create <file> <name> <resource> <default-value> [--resource-key <key>] [--property-attribute <attr>] [--resource-sub-type <type>]
uip maestro flow bindings list   <file> [--limit <n>] [--offset <n>]
uip maestro flow bindings delete <file> <resource-key>
  • <resource> is a resource type, such as connection, queue, process, or bucket. Run uip maestro flow bindings create --help for the full list.
  • --property-attribute es la propiedad del nodo de destino que rellena la vinculación (p. ej. name, folderPath, connection).
  • --resource-sub-type proporciona subclasificación (p. ej. Agent, Process).
  • bindings delete deletes all bindings with the given resource key, not a single entry by ID. list takes --limit and --offset, as nodes list does.

Data shapes: BindingAddSuccess (Data.Binding) for create, BindingListSuccess (Data.Bindings[], Count), BindingRemoveSuccess (Data.DeletedBindings[], Count) for delete.


formato de flujo maestro de uip​

Diseño automático: reposiciona los nodos en un archivo .flow para eliminar las superposiciones y organizar el gráfico de forma limpia.

uip maestro flow format <file>
uip maestro flow format <file>

Forma de datos: Code: "FlowFormat", Data: { File, NodesTotal, EdgesTotal, NodesRepositioned, NodesResized, SubflowsTidied, VariableCount }.

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte(opens in new window)

¿Quiere aprender? UiPath Academy(opens in new window)

¿Tiene alguna pregunta? Foro de UiPath(opens in new window)

Manténgase actualizado