- 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 Maestro est publié dans Orchestrator, il devient un processus de type ProcessOrchestration. Cette page couvre deux groupes de commandes associés:
uip maestro 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 maestro processes— résumés à l'échelle du locataire et recherche d'incidents par processus.
Synthèse
# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro 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 maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro 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 maestro processes list
uip maestro 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 uip Maestro
Répertoriez les processus Maestro (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": "MaestroProcessList",
"Data": [
{
"name": "InvoiceOrchestration",
"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": "MaestroProcessList",
"Data": [
{
"name": "InvoiceOrchestration",
"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"
}
]
}
Processus uip maestro - Obtenir
Récupérer le schéma de point d'entrée (schéma d'entrée/sortie) d'un processus Maestro.
Arguments
<process-key>(obligatoire) : clé de processus.<feed-id>(obligatoire) : ID de flux (depuislist).
Options
-f, --folder-key <key>(requis)-t, --tenant--login-validity
Format des données
{
"Code": "MaestroProcessGet",
"Data": [
{
"Path": "/content/main.bpmn#Event_start",
"DisplayName": "Manual trigger",
"Type": "processorchestration",
"InputSchema": "{\"type\":\"object\",\"properties\":{}}",
"OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
}
]
}
{
"Code": "MaestroProcessGet",
"Data": [
{
"Path": "/content/main.bpmn#Event_start",
"DisplayName": "Manual trigger",
"Type": "processorchestration",
"InputSchema": "{\"type\":\"object\",\"properties\":{}}",
"OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
}
]
}
InputSchema et OutputSchema sont les chaînes de schéma JSON reconfigurées.
Exécution du processus uip maestro
Démarrez une tâche Maestro pour un processus publié.
Arguments
<process-key>(obligatoire) : clé de processus.<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 st depuis est sur la barre de pipeline, st din est analysé. |
-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. Vérifications de base uniquement — champs requis + types primitifs. |
--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
# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
--inputs '{"amount":100}'
# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json
# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"
# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
--inputs '{"amount":100}' --validate
# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
--inputs '{"amount":100}'
# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json
# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"
# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
--inputs '{"amount":100}' --validate
Format des données
{
"Code": "MaestroJobStarted",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"state": "Pending",
"traceId": "d4e5f6a7-0000-0000-0000-000000000001"
}
}
{
"Code": "MaestroJobStarted",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"state": "Pending",
"traceId": "d4e5f6a7-0000-0000-0000-000000000001"
}
}
Étape suivante: uip maestro job traces <jobKey> pour diffuser l'exécution ou uip maestro job status <jobKey> pour interroger.
Liste des processus uip Maestro
Résumé des processus Maestro à l'échelle du locataire (aucun filtre processType appliqué à cette couche — la commande multiple est partagée entre les outils et ne s'applique pas au côté serveur ProcessOrchestration ).
Arguments
Aucun
Format des données
{
"Code": "ProcessList",
"Data": [ /* array of Maestro process summaries */ ]
}
{
"Code": "ProcessList",
"Data": [ /* array of Maestro process summaries */ ]
}
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 uip maestro
Obtenez tous les incidents pour une définition de processus Maestro spécifique.
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 également
uip maestro instances— inspecter et piloter les exécutions en cours d'exécutionuip maestro job— traçages et statut pour une seule tâcheuip maestro incidents— résumés et détails des incidents- Tâches Orchestrator, Processus Orchestrator
- Vue d’ensemble de Maestro
- Synthèse
- Liste des processus uip Maestro
- Options
- Data shape (
--output json) - Processus uip maestro - Obtenir
- Arguments
- Options
- Format des données
- Exécution du processus uip maestro
- Arguments
- Options
- Exemples
- Format des données
- Liste des processus uip Maestro
- Arguments
- Format des données
- incidents de processus uip maestro
- Arguments
- Options
- Format des données
- Voir également