UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
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.

Instances UIP Maestro

uip maestro instance inspecte et pilote les instances de processus individuelles — une exécution d'un processus Maestro publié. Le nom de la commande est au unique (instance), même si l'entrée de la barre latérale indique instances.

Toutes les sous-commandes nécessitent uip login et respectent les options globales. Les codes de sortie suivent le contrat standard.

Synthèse

uip maestro instance list                                  -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro instance get                 <instance-id>     -f <folder-key>
uip maestro instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro instance incidents           <instance-id>     -f <folder-key>
uip maestro instance asset               <instance-id>     -f <folder-key>
uip maestro instance cursors             <instance-id>     -f <folder-key>
uip maestro instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro instance element-executions  <instance-id>     -f <folder-key>
uip maestro instance list                                  -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro instance get                 <instance-id>     -f <folder-key>
uip maestro instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro instance incidents           <instance-id>     -f <folder-key>
uip maestro instance asset               <instance-id>     -f <folder-key>
uip maestro instance cursors             <instance-id>     -f <folder-key>
uip maestro instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro instance element-executions  <instance-id>     -f <folder-key>

-f, --folder-key <key> est requis sur chaque sous-commande.

Options communes

  • -f, --folder-key <key> (obligatoire) — clé de dossier.
  • --comment <text> (commandes d'opération uniquement) — commentaire facultatif enregistré avec l'opération. Envoyé comme une chaîne vide si omis.

Sous-commandes

Liste des instances UIP Maestro

Répertorier les instances dans un dossier, avec une étendue définie sur processType=ProcessOrchestration.

Options
OptionDefaultDescription
-l, --limit <n>DEFAULT_PAGE_SIZENombre d'éléments à renvoyer (1-10 000).
--offset <n>0Nombre d’éléments à ignorer (0-1000 000).
--process-key <k>Filtrer par clé de processus.
--package-id <id>Filtrez par ID de package.
--error-code <code>Filtrez par code dʹerreur.
Format des données

Code: "InstanceList", Data est un tableau d'objets d'instance de processus.

Obtenir l’instance UIP Maestro

Récupérez une seule instance par ID. Format des données: Code: "InstanceGet", Data est l'objet d'instance de processus.

pause d’instance uip maestro

Suspendez une instance en cours d'exécution. Format des données: Code: "InstancePaused".

Reprise d’une instance UIP Maestro

Reprenez une instance suspendue. Format des données: Code: "InstanceResumed".

annulation d’instance uip maestro

Annulez une instance en cours d'exécution. Format des données: Code: "InstanceCanceled".

Nouvelle tentative d’instance Maestro uip

Réessayez une instance défaillante. Format des données: Code: "InstanceRetried".

Migration des instances UiPath Maestro

Migrez une instance vers une version de package différente.

Arguments: <instance-id>, <new-version> (version du package cible).

Format des données: Code: "InstanceMigrated".

Variables d’instance UIP Maestro

Obtenir les variables d'une instance.

Options: --parent-element-id <id> — filtrer les variables par élément parent.

Format des données: Code: "InstanceVariables", Data porte la charge utile des variables de l’instance.

incidents d’instance uip maestro

Format des données: Code: "InstanceIncidents", Data est un tableau d’objets d’incident.

Ressource d’instance uip maestro

Récupérez la ressource BPMN associée à la version de cette instance.

Format des données: Code: "InstanceAsset", Data est la charge utile de la ressource BPMN.

curseurs d’instance uip maestro

Obtenir les positions actuelles du curseur d'exécution — à quel(s) élément(s) l'instance est suspendue.

Format des données: Code: "InstanceCursors", Data répertorie les positions actuelles du curseur.

Goto d’instance UIP Maestro

Déplacez un curseur d'exécution d'un élément à un autre.

Arguments
  • <instance-id> (requis)
  • <transitions> (obligatoire) — Tableau JSON de transitions, chacune avec sourceElementId et targetElementId.
uip maestro instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-uip maestro instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-…
Format des données

Code: "InstanceGoto".

Instance UiPath Maestro Element-Executions

Obtenir l'historique d'exécution par élément pour une instance.

Format des données

Code: "InstanceElementExecutions", Data correspond à l'historique d'exécution par élément.

Exemples

# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
  --process-key "InvoiceOrchestration:1.0.0" --limit 50

# Pause, fix, resume
uip maestro instance pause  <id> --folder-key <k> --comment "Investigating"
uip maestro instance resume <id> --folder-key <k>

# Inspect cursors, jump a faulted node, retry
uip maestro instance cursors <id> --folder-key <k>
uip maestro instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip maestro instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"
# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
  --process-key "InvoiceOrchestration:1.0.0" --limit 50

# Pause, fix, resume
uip maestro instance pause  <id> --folder-key <k> --comment "Investigating"
uip maestro instance resume <id> --folder-key <k>

# Inspect cursors, jump a faulted node, retry
uip maestro instance cursors <id> --folder-key <k>
uip maestro instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip maestro instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"

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