Instances BPMN uip Maestro

Syntaxe et options de `uip maestro bpmn instance`, qui inspecte et contrôle les instances de processus BPMN Maestro individuelles.

uip maestro bpmn instance inspecte et pilote les instances de processus individuelles — une exécution d'un processus Maestro BPMN publié. Le nom de la commande est au unique (instance) même si l'entrée de la barre latérale indique instances. Chaque verbe est enregistré ici sous la branche bpmn — il n'y a pas de barre uip maestro bpmn instance.

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 bpmn instance list                                  -f <folder-key> [-l <limit>] [--next-page <cursor>] [--process-key <guid>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso>] [--to-date <iso>]
uip maestro bpmn instance get                 <instance-id>     -f <folder-key>
uip maestro bpmn instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro bpmn instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro bpmn instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro bpmn instance variables-set       <instance-id>     -f <folder-key> --inputs <json|@file>
uip maestro bpmn instance variables-all       <instance-id>     -f <folder-key>
uip maestro bpmn instance global-variables    <instance-id>     -f <folder-key>
uip maestro bpmn instance incidents           <instance-id>     -f <folder-key>
uip maestro bpmn instance asset               <instance-id>     -f <folder-key>
uip maestro bpmn instance cursors             <instance-id>     -f <folder-key>
uip maestro bpmn instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro bpmn instance element-executions  <instance-id>     -f <folder-key>
uip maestro bpmn instance message send                          -f <folder-key> --inputs <json|@file>
uip maestro bpmn instance element cancel      <instance-id> <element-id> -f <folder-key> [--comment <text>]
uip maestro bpmn instance element retry       <instance-id> <element-id> -f <folder-key> [--comment <text>]

-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 BPMN uip Maestro

Répertorie les instances dans un dossier, avec une étendue définie sur processType=ProcessOrchestration. Les filtres sont appliqués côté serveur. Page de résultats par curseur, non décalé — lisez Pagination.NextPage à partir d'une réponse et renvoyez-la via --next-page.

Options

Option	Default	Description
-l, --limit <n>	DEFAULT_PAGE_SIZE	Nombre d'éléments à renvoyer (1 à 500).
--next-page <cursor>	—	Curseur du Pagination.NextPage d'une réponse précédente.
--offset <n>	—	Non pris en charge par cette API. --offset 0 est accepté en mode silencieux en tant que non-opération (équivalent à aucun curseur); toute autre valeur échoue avec une erreur vous demandant d’utiliser --next-page à la place.
--process-key <guid>	—	Filtrer par clé de processus — doit être un GUID. Pour l’identifiant de package à points (par ex. InvoiceOrchestration:1.0.0) qui uip or processes list s’imprime en tant ProcessKey que, utilisez --package-id à la place.
--package-id <id>	—	Filtrez par ID de package (l’identifiant de package en pointillés).
--error-code <code>	—	Filtrez par code dʹerreur.
--status <status>	—	Filtrez par statut d’instance. Répétable, sémantique OU. Une valeur non valide échoue rapidement dans la liste de l’ensemble accepté.
--from-date <iso-8601>	—	N'incluez que les instances commençant à ou après cet horodatage, par exemple 2026-01-01T00:00:00Z.
--to-date <iso-8601>	—	N'incluez que les instances commencées à ou avant cet horodatage.

Format des données

Code: "InstanceList", Data est un tableau d'objets d'instance de processus, plus un bloc Pagination (returned, limit, hasMore, nextPage).

Obtenir l’instance BPMN uip Maestro

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

Suspension d’instance BPMN uip Maestro

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

Reprise d’instance BPMN uip Maestro

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

Annuler une instance BPMN uip Maestro

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

Nouvelle tentative d’instance BPMN uip Maestro

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

Migration d’instance bpmn uip 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 BPMN 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.

Variables d’instance BPMN uip Maestro

Variables de correctif (mise à jour) pour une instance en cours d'exécution.

Options

Option	Description
--inputs <value>	Charge utile des variables de correctif sous forme de chaîne JSON, de chemin @file ou de pipeline via st din. Requis (la commande échoue si aucune charge utile ne se résout).

Format des données

Code: "InstanceVariablesSet".

uip maestro bpmn variables-all

Obtenez chaque variable d'une instance, y compris les variables de sous-processus.

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

Variables globales d’instance BPMN uip Maestro

Récupérez les variables globales d'une instance.

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

Incidents d’instance BPMN uip Maestro

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

Ressource d’instance BPMN 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 BPMN 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.

Instance BPMN uip Maestro - Goto

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 bpmn instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-…

Format des données

Code: "InstanceGoto".

Instance-exécutions BPMN uip Maestro

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.

Message d’instance BPMN uip Maestro

Envoyer un message aux abonnements au workflow qui écoutent ce processus — pas limité à un seul ID d'instance; la charge utile du fournisseur détermine l'instance ou les instances affectées par le message.

Options

Option	Requis	Description
-f, --folder-key <key>	oui	Clé de dossier.
--inputs <value>	—	Charge utile du message sous forme de chaîne JSON, de chemin @file ou de pipeline via st din. Échoue si aucune charge utile ne se résout.

Format des données

Code: "MessageSent".

Supprimer l’élément d’instance BPMN uip Maestro

Annulez un élément dans une instance en cours d'exécution sans annuler l'instance entière.

Arguments

• <instance-id> (requis)
• <element-id> (requis)

Options

Option	Description
-f, --folder-key <key>	Clé de dossier. Requis.
--comment <text>	Commentaire facultatif pour l'opération.

Format des données

Code: "ElementCanceled".

Réessai d’élément d’instance BPMN uip Maestro

Réessayez un élément défaillant dans une instance.

Arguments

• <instance-id> (requis)
• <element-id> (requis)

Options

Option	Description
-f, --folder-key <key>	Clé de dossier. Requis.
--comment <text>	Commentaire facultatif pour l'opération.

Format des données

Code: "ElementRetried".

Exemples

# Paginate through instances for a specific process, filtered by status
uip maestro bpmn instance list --folder-key <k> \
  --status Faulted --status Paused --limit 50

# Page through with the cursor from a previous response
uip maestro bpmn instance list --folder-key <k> --next-page <cursor>

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

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

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

# Retry a single faulted element instead of the whole instance
uip maestro bpmn instance element retry <id> Activity_2 --folder-key <k>

# Patch a variable on a running instance
uip maestro bpmn instance variables-set <id> --folder-key <k> --inputs '{"amount": 250}'

Voir également

• uip maestro bpmn incidents — incidents détachés d'une instance spécifique
• uip maestro bpmn job — la vue de la tâche d'une exécution d'instance
• uip maestro bpmn process — de nouvelles instances de démarrage
• Tâches Orchestrator
• Vue d’ensemble de Maestro