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

Processus uip Maestro et Processus uip Maestro

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

OptionRequisDescription
-f, --folder-key <key>ouiClé de dossier.
-t, --tenant <name>nonNom du locataire. La valeur par défaut est le locataire authentifié.
--filter <odata>nonUn filtre OData supplémentaire est appliqué côté serveur.
--login-validity <minutes>nonSeuil 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 (depuis list).

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

OptionDescription
-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.
--validateValidez 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 */ ]
}
Remarque :

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

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