- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- UiPath pour les agents de codage
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- UiPath Docsai
- add-test-data-entity
- ajouter une file d'attente de données de test
- add-test-data-variation
- Analyser
- Construire
- créer-projet
- Différence
- recherche-activités
- Obtenir les règles de l'analyse
- récupérer-activité-xaml par défaut
- Récupérer les erreurs
- obtenir des cas de test manuels
- Obtenir les étapes de test manuelles
- Obtenir les versions
- exemple de workflow
- indiquer l'application
- indiquer l'élément
- inspecter-package
- install-data-fabric-entities
- installer-ou-Update-packages
- list-data-fabric-entités
- listes-exemples-workflow
- Créer un package
- restore
- Exécuter le fichier
- modèles-recherche
- Démarrer-Studio
- arrêter l'exécution
- UIA
- Traçages UIP
- Migration
- Référence et assistance
Guide de l'utilisateur de UiPath CLI
Une fois qu'un package de flux est publié dans Orchestrator, il devient un processus. Cette page couvre deux groupes de commandes associés:
uip flow process— opérations par dossier sur une seule définition de processus (répertorier dans un dossier, obtenir son schéma, l'exécuter).uip flow processes— résumés à l'échelle du locataire et recherche d'incidents par processus.
Synthèse
# Singular — per-folder, operational
uip flow process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip flow process get <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip flow process run <process-key> <folder-key>
[-i, --inputs <json>] [-t, --tenant <name>]
[--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
[--validate] [--login-validity <minutes>]
# Plural — tenant-wide summary and incident surface
uip flow processes list
uip flow processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip flow process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip flow process get <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip flow process run <process-key> <folder-key>
[-i, --inputs <json>] [-t, --tenant <name>]
[--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
[--validate] [--login-validity <minutes>]
# Plural — tenant-wide summary and incident surface
uip flow processes list
uip flow processes incidents <process-key> [--folder-key <key>]
Toutes les sous-commandes nécessitent uip login et respectent les options globales. Les codes de sortie suivent le contrat standard.
liste des processus de flux uip
Répertoriez les processus de flux (versions) disponibles dans un dossier spécifique.
Options
| Option | Requis | Description |
|---|---|---|
-f, --folder-key <key> | oui | Clé de dossier. |
-t, --tenant <name> | non | Nom du locataire. La valeur par défaut est le locataire authentifié. |
--filter <odata> | non | Un filtre OData supplémentaire est appliqué côté serveur. |
--login-validity <minutes> | non | Seuil d’actualisation du jeton (par défaut 10). |
Data shape (--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"
}
]
}
Obtenir le processus de flux UIP
Récupérez le schéma du point d'entrée (schéma JSON d'entrée/de sortie) d'un processus de flux. Utilisez le résultat pour créer une charge utile --inputs valide pour process run.
Arguments
<process-key>(obligatoire) — clé de processus, par exempleMyFlow.flow.Flow:1.0.0ou<package-id>:<version>.<feed-id>(obligatoire) : ID de flux (à partir de la sortielist).
Options
-f, --folder-key <key>(requis)-t, --tenant--login-validity
Format des données
{
"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 et OutputSchema sont ré-chaînes JSON; les analyser sous forme de schémas JSON pour piloter la construction d'entrée.
Exécution du processus de flux UIP
Démarrez une tâche de flux pour un processus publié.
Arguments
<process-key>(obligatoire) — clé de processus (par ex.MyFlow.flow.Flow:1.0.0).<folder-key>(obligatoire) — clé de dossier.
Options
| Option | Description |
|---|---|
-i, --inputs <json> | Les entrées sous la forme d'une chaîne JSON ou @path/to/file.json. Si ce champ est omis et que stdin est sur la barre de pipeline, st din est analysé en tant qu'entrées. |
-t, --tenant <name> | Nom du locataire (par défaut, le locataire authentifié). |
--release-key <key> | Clé de version — à partir de process list. |
--feed-id <id> | ID de flux pour la recherche des packages (facultatif). |
--robot-ids <ids> | ID de robot (entiers) séparés par des virgules. Les valeurs non valides échouent rapidement. |
--validate | Validez les entrées par rapport au schéma de processus avant l'exécution. Effectue des vérifications de base uniquement - les champs requis présents et les types primitifs correspondent. Les contraintes complexes (énumérations, modèles, références) ne sont pas appliquées par cette transmission. |
--login-validity <minutes> | Seuil d’actualisation du jeton (par défaut 10). |
Priorité d’entrée: --inputs <json> / --inputs @file.json > stdin > objet vide {}.
Exemples
# Run with inline JSON
uip 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 flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json
# Run with inputs piped from stdin
echo '{"amount":100}' | uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"
# Validate before running
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
--inputs '{"amount":100}' --validate
# Run with inline JSON
uip 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 flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json
# Run with inputs piped from stdin
echo '{"amount":100}' | uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"
# Validate before running
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
--inputs '{"amount":100}' --validate
Format des données
{
"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"
}
}
Étape suivante: uip flow job traces <jobKey> pour diffuser l'exécution ou uip flow job status <jobKey> pour interroger.
liste des processus de flux uip
Résumé des processus de flux à l'échelle du locataire (/processes/summary?processType=Flow). Aucun argument, aucune option au-delà des variables globales.
Format des données
{
"Code": "ProcessList",
"Data": [
{
"processKey": "…",
"name": "…",
"folderKey": "…",
"latestVersion": "…"
}
]
}
{
"Code": "ProcessList",
"Data": [
{
"processKey": "…",
"name": "…",
"folderKey": "…",
"latestVersion": "…"
}
]
}
L'ensemble de champs exact de chaque résumé de processus est spécifié par le runtime Maestro et peut évoluer; exécutez la commande une fois avec --output json sur un locataire avec des données pour voir les champs que vous allez utiliser, et épinglez @uipath/cli dans CI si vous analysez des champs spécifiques.
incidents de processus de flux uip
Obtenez tous les incidents pour une définition de processus de flux spécifique (pas une instance unique).
Arguments
<process-key>(obligatoire) : clé de définition du processus.
Options
--folder-key <key>(facultatif) : clé de dossier pour étendre la recherche.
Format des données
{
"Code": "ProcessIncidents",
"Data": [ /* array of process incidents */ ]
}
{
"Code": "ProcessIncidents",
"Data": [ /* array of process incidents */ ]
}
Voir uip flow incidents pour la forme par incident.
Voir également
uip flow instances— inspecter et piloter les exécutions en cours d'exécutionuip flow job— traçages et statut pour une seule tâcheuip flow incidents— résumés et détails des incidents- Tâches Orchestrator, Processus Orchestrator
- Vue d’ensemble du flux
- Synthèse
- liste des processus de flux uip
- Options
- Data shape (
--output json) - Obtenir le processus de flux UIP
- Arguments
- Options
- Format des données
- Exécution du processus de flux UIP
- Arguments
- Options
- Exemples
- Format des données
- liste des processus de flux uip
- Format des données
- incidents de processus de flux uip
- Arguments
- Options
- Format des données
- Voir également