UiPath Documentation
uipath-cli
latest
false
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Guide de l'utilisateur de UiPath CLI

Registre de flux UIP

uip flow registry parcourt le registre des nœuds de flux - le catalogue de blocs constitutifs utilisables dans un fichier .flow . Le registre contient des activités OOTB (uipath.agent, uipath.http, ...) et des nœuds de connecteur qui font appel à des API tierces (Slack, Salesforce, Jira, …). Lorsque vous êtes connecté, le registre inclut en outre les nœuds de connecteur installés dans votre locataire.

Le registre est partagé entre les interfaces UiPath workflow; la même implémentation prend en charge uip maestro (voir registre Maestro, exposé via uip maestro bpmn registry).

Toutes les sous-commandes respectent les options globales. Les codes de sortie suivent le contrat standard.

Synthèse

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]

Workflow standard

# 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"

Sans connexion, seuls les nœuds intégrés sont renvoyés.


extraction du registre de flux uip

Récupère le registre de nœuds et l’écrit dans un cache local. Les appels list, search et get suivants sont lus à partir de ce cache.

Options

  • -f, --force — actualisation forcée, ignorant le cache.

Cache behavior

  • Expiration du cache après 30 minutes. Un cache expiré ou manquant déclenche une extraction en direct.
  • Lorsqu'ils ne sont pas connectés, les nœuds OOTB sont renvoyés sans mettre à jour le cache.
  • En cas d’échec de l’extraction d’authentification, la commande revient aux nœuds OOTB sans mettre à jour le cache.

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 est "ootb" (non authentifié) ou "authenticated" (Spécifique au locataire). AgeMinutes est renseigné lorsque FromCache: true.


liste des registres de flux uip

Exemples de nœuds mis en cache. La valeur par défaut est les 20 premières entrées.

Options

OptionDefaultDescription
-l, --limit <n>20Nombre de nœuds à renvoyer. Transmettez -1 pour tous. Doit être un entier positif ou -1.
--localdésactivéAfficher uniquement les nœuds de projet dans la solution. Nécessite un .uipx dans le CWD, le parent ou le grand-parent.

Si list est appelé sans pull précédent, le service extrait d'abord les données dynamiques.

Format des données

{
  "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 le résultat est tronqué, une ligne de journal est émise sur stderr affichant le total des éléments affichés.


Recherchez des nœuds par mot-clé, par filtre structuré ou les deux.

Arguments

  • [keyword] — la sous-chaîne correspond à nodeType, category, tags, display.label, description.

Options

OptionDescription
-f, --filter <expr>Filtre de champ structuré (voir la syntaxe ci-dessous).
--localRechercher uniquement les nœuds dans la solution (nécessite .uipx à proximité).

Au moins une des propriétés <keyword> ou --filter est requise.

Syntaxe de filtre

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)

Opérateurs: equals (par défaut), contains, startsWith, endsWith, in.

Champs filtrables (alias indiqués entre parenthèses):

  • category [cat] — ex. connector, agent, trigger
  • type [nodetype] — identificateur de type nœud
  • tags [tag] — balises de nœud
  • displayname [display_name, name, label] — nom lisible par un humain
Exemples
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"

Format des données: même forme que listCode: "NodeSearchSuccess", Data: [flattened nodes…].


Obtenir le registre de flux uip

Renvoyez les détails complets pour un nœud unique.

Arguments

  • <nodeType> (requis) : identificateur de type de nœud (insensible à la casse).

Options

OptionDescription
--connection-id <id>ID de connexion pour l’enrichissement Integration Service. Requis pour les nœuds de déclencheur du connecteur; facultatif pour les nœuds d'activité du connecteur.
--localObtenez le nœud des projets en solution uniquement.

Enrichissement Integration Service

Pour les nœuds balisés "connector", get appelle automatiquement Integration Service et fusionne les métadonnées actives:

Nœuds d'activité du connecteur (uipath.connector.*, non déclencheur):

  • inputDefinition.fields[] — champs à configurer. Chacun a name, displayName, type, required et éventuellement reference (recherche: objectName, path, lookupValue, lookupNames, childPath) ou enum.
  • outputResponseDefinition — champs produits après l'exécution du nœud.
  • connectorMethodInfo — Méthode HTTP, chemin, opérationId.
  • --connection-id est facultatif; le fait d'passer un ajoute des champs personnalisés spécifiques à ce compte.

Nœuds de déclencheur de connecteur (uipath.connector.trigger.*):

  • eventParameters — les champs qui configurent le déclencheur (par exemple quel dossier surveiller).
  • filterFields — champs utilisés pour filtrer les événements qui déclenchent le déclencheur.
  • outputResponseDefinition — champs produits par la charge utile de l'événement.
  • eventMode"webhooks" ou "polling".
  • Les connexions et --connection-id sont requises; sans les deux, aucun enrichissement n’est retourné.

Métadonnées par champ d’entrée

Chaque entrée sous inputDefinition.fields:

PropriétéDescription
nameClé JSON pour la requête/réponse.
displayNameLibellé lisible par un humain.
typeType de données (string, boolean, integer, …).
requiredtrue si obligatoire (champs d'entrée uniquement).
descriptionCe que fait le champ.
enumValeurs autorisées (si restreintes).
referenceMétadonnées de référence d'objet — le champ attend un ID, et non un nom simple.
responseOnlytrue sur les champs de sortie.
Format des données
{
  "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" }
        ]
      }
    }
  }
}

Exemples

# 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

Voir également

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour