uip maestro flow process and uip maestro flow processes

Syntax and options for `uip maestro flow process` and `uip maestro flow processes`, covering per-folder and tenant-wide published Flow process operations.

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 maestro 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 maestro flow processes — résumés à l'échelle du locataire et recherche d'incidents par processus.

Synthèse

# Singular — per-folder, operational
uip maestro flow process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro 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 maestro flow processes list
uip maestro 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.

---

uip maestro flow process list

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).

Format des données (--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"
    }
  ]
}

---

uip maestro flow process get

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 exemple MyFlow.flow.Flow:1.0.0 ou <package-id>:<version>.
• <feed-id> (obligatoire) : ID de flux (à partir de la sortie list ).

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\":{}}"
    }
  ]
}

InputSchema et OutputSchema sont ré-chaînes JSON; les analyser sous forme de schémas JSON pour piloter la construction d'entrée.

---

uip maestro flow process run

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 maestro 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 maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip maestro 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"
  }
}

Étape suivante: uip maestro flow job traces <jobKey> pour diffuser l'exécution ou uip maestro flow job status <jobKey> pour interroger.

---

uip maestro flow processes list

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":  "…"
    }
  ]
}

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.

---

uip maestro flow processes incidents

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 */ ]
}

Voir uip maestro flow incident pour la forme par incident.

Voir également

• uip maestro flow instance — inspecter et piloter les exécutions en cours d'exécution
• uip maestro flow job — traçages et statut pour une seule tâche
• uip maestro flow incident — résumés et détails des incidents
• Tâches Orchestrator, Processus Orchestrator
• Vue d’ensemble du flux