uip Maestro BPMN-Instanzen

Syntax und Optionen für „uip Maestro BPMN Instanz“, die einzelne Maestro BPMN-Prozessinstanzen überprüft und steuert.

uip maestro bpmn instance überprüft und steuert einzelne Prozessinstanzen – eine Ausführung eines veröffentlichten BPMN-Prozesses von Maestro. Der Befehlsname ist Singular (instance), obwohl der Seitenleisteneintrag instances lautet. Jedes Verb wird hier unter der bpmn -Verzweigung registriert – es gibt kein leeres uip maestro bpmn instance.

Alle Unterbefehle erfordern uip login und berücksichtigen globale Optionen. Austrittscodes folgen dem Standardvertrag.

Zusammenfassung

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> ist für jeden Unterbefehl erforderlich.

Allgemeine Optionen

• -f, --folder-key <key> (erforderlich) – Ordnerschlüssel (GUID).
• --comment <text> (nur Vorgangsbefehle) – optionaler Kommentar, der mit dem Vorgang aufgezeichnet wurde. Wird als leere Zeichenfolge gesendet, wenn er nicht angegeben wird.

Unterbefehle

UIP Maestro BPMN-Instanzliste

Listen Sie Instanzen in einem Ordner auf, die auf processType=ProcessOrchestration beschränkt sind. Die Filter werden serverseitig angewendet. Ergebnisseseite nach Cursor, nicht verschoben – lesen Sie Pagination.NextPage aus einer Antwort und geben Sie sie über --next-page zurück.

Optionen

Option	Standard	Beschreibung
-l, --limit <n>	DEFAULT_PAGE_SIZE	Anzahl der zurückzugebenden Elemente (1–500).
--next-page <cursor>	–	Cursor vom Pagination.NextPage einer vorherigen Antwort.
--offset <n>	–	Nicht von dieser API unterstützt. --offset 0 wird im Hintergrund als No-Op akzeptiert (entspricht keinem Cursor); jeder andere Wert schlägt mit einem Fehler fehl, der Sie auffordert, stattdessen --next-page zu verwenden.
--process-key <guid>	–	Nach Prozessschlüssel filtern – muss eine GUID sein. Für die gepunktete Paketkennung (z. B. InvoiceOrchestration:1.0.0), die uip or processes list als ausgegeben ProcessKey wird, verwenden --package-id Sie stattdessen.
--package-id <id>	–	Filtern Sie nach Paket-ID (der gepunktete Paketbezeichner).
--error-code <code>	–	Nach Fehlercode filtern.
--status <status>	–	Filtern Sie nach Instanzstatus. Wiederholbar, OR-Semantik. Ein ungültiger Wert schlägt beim schnellen Auflisten des akzeptierten Satzes fehl.
--from-date <iso-8601>	–	Schließen Sie nur Instanzen ein, die mit oder nach diesem Zeitstempel gestartet wurden, z. B. 2026-01-01T00:00:00Z).
--to-date <iso-8601>	–	Dazu gehören nur Instanzen, die mit oder vor diesem Zeitstempel gestartet wurden.

Datenform

Code: "InstanceList", Data ist ein Array von Prozessinstanzobjekten sowie ein Pagination -Block (returned, limit, hasMore, nextPage).

Abrufen von UIP Maestro BPMN Instanz

Rufen Sie eine einzelne Instanz nach ID ab. Datenform: Code: "InstanceGet", Data ist das Prozessinstanzobjekt.

Anhalten der UIP Maestro BPMN-Instanz

Eine laufende Instanz anhalten. Datenform: Code: "InstancePaused".

Fortsetzen der UIP Maestro BPMN-Instanz

Setzen Sie eine angehaltene Instanz fort. Datenform: Code: "InstanceResumed".

Abbruch der UIP Maestro BPMN-Instanz

Bricht eine laufende Instanz ab. Datenform: Code: "InstanceCanceled".

Wiederholung der UIP Maestro BPMN-Instanz

Eine fehlerhafte Instanz wiederholen. Datenform: Code: "InstanceRetried".

UiP Maestro BPMN-Instanz migrieren

Migrieren Sie eine Instanz zu einer anderen Paketversion.

Argumente: <instance-id>, <new-version> (Zielpaketversion).

Datenform: Code: "InstanceMigrated".

UIP Maestro BPMN-Instanzvariablen

Rufen Sie Variablen für eine Instance ab.

Optionen: --parent-element-id <id> – Filtern Sie Variablen nach dem übergeordneten Element.

Datenform: Code: "InstanceVariables", Data trägt die Nutzlast der Instanzvariablen.

Variablen-Set für UIP Maestro BPMN-Instanz

Patchen (Aktualisieren) Sie Variablen für eine laufende Instanz.

Optionen

Option	Beschreibung
--inputs <value>	Patch-Variablen-Nutzlast als JSON-Zeichenfolge, @file -Pfad oder über Standardpipeline. Erforderlich (der Befehl schlägt fehl, wenn keine Nutzlast aufgelöst wird).

Datenform

Code: "InstanceVariablesSet".

UIP Maestro BPMN Instanzvariablen – alle

Rufen Sie jede Variable für eine Instanz ab, einschließlich der Teilprozessvariablen.

Datenform: Code: "InstanceVariablesAll".

Globale Variablen der UIP Maestro BPMN-Instanz

Rufen Sie die globalen Variablen einer Instanz ab.

Datenform: Code: "InstanceGlobalVariables".

Vorfälle mit UIP Maestro BPMN-Instanzen

Datenform: Code: "InstanceIncidents", Data ist ein Array von Vorfallsobjekten.

UIP Maestro BPMN-Instanz-Asset

Rufen Sie das BPMN-Asset ab, das an das Release dieser Instanz angehängt ist.

Datenform: Code: "InstanceAsset", Data ist die BPMN-Asset-Nutzlast.

Cursor in UIP Maestro BPMN-Instanz

Aktuelle Cursorpositionen für die Ausführung abrufen – bei welchen Elementen die Instanz angehalten wird.

Datenform: Code: "InstanceCursors", Data listet die aktuellen Cursorpositionen auf.

UIP Maestro BPMN Instanz Goto

Verschieben eines Ausführungscursors von einem Element zu einem anderen.

Argumente

• <instance-id> (erforderlich)
• <transitions> (erforderlich) – JSON-Array von Übergängen mit jeweils sourceElementId und targetElementId.

uip maestro bpmn instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-…

Datenform

Code: "InstanceGoto".

Elementausführungen für UIP Maestro BPMN-Instanz

Rufen Sie den Ausführungsverlauf pro Element für eine Instanz ab.

Datenform

Code: "InstanceElementExecutions", Data ist der Ausführungsverlauf pro Element.

Senden der UIP Maestro BPMN-Instanz

Senden einer Nachricht an Workflow-Abonnements, die diesen Prozess überwachen – nicht auf eine einzelne Instanz-ID beschränkt; Die Anbieternutzlast bestimmt, welche Instanz(en) die Nachricht erreicht.

Optionen

Option	Erforderlich	Beschreibung
-f, --folder-key <key>	ja	Ordnerschlüssel (GUID).
--inputs <value>	–	Nachrichtennutzlast als JSON-Zeichenfolge, @file -Pfad oder über Standardpilot. Schlägt fehl, wenn keine Nutzlast aufgelöst wird.

Datenform

Code: "MessageSent".

Abbruch des UIP Maestro BPMN-Instanzelements

Bricht ein Element innerhalb einer laufenden Instanz ab, ohne die gesamte Instanz abzubrechen.

Argumente

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

Optionen

Option	Beschreibung
-f, --folder-key <key>	Ordnerschlüssel (GUID). Erforderlich.
--comment <text>	Optionaler Kommentar für den Vorgang.

Datenform

Code: "ElementCanceled".

Wiederholung des Elements UIP Maestro BPMN Instanz

Versuchen Sie es mit einem fehlerhaften Element innerhalb einer Instanz erneut.

Argumente

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

Optionen

Option	Beschreibung
-f, --folder-key <key>	Ordnerschlüssel (GUID). Erforderlich.
--comment <text>	Optionaler Kommentar für den Vorgang.

Datenform

Code: "ElementRetried".

Beispiele

# 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}'

Siehe auch

• uip maestro bpmn incidents – von einer bestimmten Instanz getrennte Vorfälle
• uip maestro bpmn job – Die Auftragsansicht einer Instanzausführung
• uip maestro bpmn process – Neue Instanzen starten
• Orchestrator-Aufträge
• Maestro-Übersicht