uip Maestro Flow-Instanz

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

uip maestro flow instance überprüft und steuert einzelne Prozessinstanzen – eine Ausführung eines veröffentlichten Flow-Prozesses. Der Befehlsname ist Singular (instance), obwohl der Seitenleisteneintrag instances lautet.

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

Diese Seite hat ihre Implementierung mit uip maestro bpmn instance – die gleichen Fehler und Korrekturen gelten für beide Seiten.

Zusammenfassung

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

-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

Liste der UIP Maestro Flow-Instanzen

Listen Sie Instanzen in einem Ordner auf, die auf Flow-Prozesse (processType=Flow) beschränkt sind.

Optionen

Option	Standard	Beschreibung
-l, --limit <n>	DEFAULT_PAGE_SIZE	Anzahl der zurückzugebenden Elemente. Begrenzt auf 1-500 – strenger als die übliche Konvention von 1-10.000 für diese CLI, da die Instanzen von API nach Cursor und nicht verschoben werden.
--next-page <cursor>	–	Cursor vom Pagination.NextPage einer vorherigen Antwort. Diese API unterstützt --offset überhaupt nicht – ein --offset ungleich Null schlägt schnell mit einem Fehler fehl, der Sie auffordert, stattdessen --next-page zu verwenden.
--process-key <k>	–	Filtern Sie nach Prozessschlüssel (GUID). Verwenden Sie für die gepunktete Paketkennung --package-id.
--package-id <id>	–	Filtern Sie nach Paket-ID.
--error-code <code>	–	Nach Fehlercode filtern.
--status <status>	–	Filtern Sie nach Instanzstatus. Wiederholbar (OR-Semantik). Werte: Canceling, Cancelled, Completed, Faulted, Paused, Pausing, Pending, Resuming, Retrying, Running, Upgrading.
--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.

Abrufen der UIP Maestro Flow-Instanz

Rufen Sie eine einzelne Instanz nach ID ab.

Datenform: Code: "InstanceGet", Data ist das Prozessinstanzobjekt.

Anhalten der UIP Maestro Flow-Instanz

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

Fortsetzen der UIP Maestro Flow-Instanz

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

Abbruch der UIP Maestro Flow-Instanz

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

Wiederholung der UIP Maestro Flow-Instanz

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

UIP Maestro Flow-Instanz migrieren

Migrieren Sie eine Instanz zu einer anderen Paketversion.

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

Datenform: Code: "InstanceMigrated".

Variablen des UIP Maestro Flow-Instanz

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 Flow-Instanz

Patchen (teilweise aktualisieren) Sie Variablen für eine Instanz.

Optionen

Option	Beschreibung
--inputs <value>	Patch-Variablen-Nutzlast als JSON-Zeichenfolge, ein @file -Pfad oder über Standardpilot.

Datenform

Code: "InstanceVariablesSet".

Variablen der UIP-Maestro-Flow-Instanz

Rufen Sie alle Variablen für eine Instanz ab, einschließlich der Unterprozessvariablen (im Gegensatz zu variables, die auf den Prozess der obersten Ebene beschränkt sind, es sei denn, --parent-element-id wird übergeben).

Datenform

Code: "InstanceVariablesAll".

Globale Variablen der UIP Maestro Flow-Instanz

Rufen Sie die globalen Variablen einer Instanz ab (freigegeben für den gesamten Prozess, nicht auf ein Element beschränkt).

Datenform

Code: "InstanceGlobalVariables".

Abbruch des Elements UIP Maestro Flow Instance

Bricht ein bestimmtes Element innerhalb einer laufenden Instanz ab, nicht die gesamte Instanz.

Argumente

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

Optionen

• --comment <text> – Optionaler Kommentar, der mit dem Vorgang aufgezeichnet wurde.

Datenform

Code: "ElementCanceled".

Wiederholung des Elements UIP Maestro Flow Instance

Ein bestimmtes fehlerhaftes Element innerhalb einer Instanz wiederholen, anstatt die gesamte Instanz zu wiederholen.

Argumente

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

Optionen

• --comment <text> – Optionaler Kommentar, der mit dem Vorgang aufgezeichnet wurde.

Datenform

Code: "ElementRetried".

Senden der UIP Maestro Flow-Instanz

Senden Sie eine Nachricht an Workflow-Abonnements, die auf diesen Ordner warten – Wird verwendet, um ein externes Ereignis in einen laufenden Flow zu liefern (z. B. eine Webhook-Nutzlast, auf die der Prozess wartet).

Optionen

Option	Beschreibung
-f, --folder-key <key>	(erforderlich) Ordnerschlüssel (GUID).
--inputs <value>	Nachrichtennutzlast als JSON-Zeichenfolge, ein @file -Pfad oder über Stdin.

Datenform

Code: "MessageSent".

Vorfälle mit UIP Maestro Flow-Instanzen

Rufen Sie Vorfälle für eine bestimmte Instanz ab.

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

UIP Maestro Flow-Instanz-Asset

Rufen Sie die Flow-Definition (das .flow -Asset) ab, die an das Release dieser Instanz angehängt ist – nützlich beim Debuggen, um das genaue Diagramm anzuzeigen, das die Instanz ausgeführt hat.

Datenform: Code: "InstanceAsset", Data ist die Flow-JSON.

Cursor in Maestro Flow-Instanzen

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 Flow Instance Goto

Verschieben eines Ausführungscursors von einem Element zu einem anderen. Nützlich zur Wiederherstellung einer fehlerhaften Instanz durch Überspringen oder Wiederholen bestimmter Knoten.

Argumente

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

uip maestro flow instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Node_1","targetElementId":"Node_3"}]' \
  --folder-key c3d4e5f6-…

Die CLI überprüft die JSON-Analysen und jeder Eintrag hat beide IDs, bevor die API aufgerufen wird.

Datenform

Code: "InstanceGoto".

Elementausführungen für UIP Maestro Flow-Instanzen

Rufen Sie den Ausführungsverlauf pro Element für eine Instanz ab (was lief, wann und mit welchem Ergebnis).

Datenform

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

Beispiele

# Paginate through instances for a specific process
uip maestro flow instance list --folder-key <k> --process-key "InvoiceFlow.flow.Flow:1.0.0" --limit 50

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

# Skip a faulted node by moving the cursor forward, then retry
uip maestro flow instance cursors <id> --folder-key <k>
uip maestro flow instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro flow instance retry   <id> --folder-key <k>

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

Siehe auch

• uip maestro flow incident – Lesen Sie Vorfälle, die von einer bestimmten Instanz getrennt sind
• uip maestro flow job – Die Auftragsansicht einer Instanzausführung
• uip maestro flow process – Neue Instanzen starten
• Orchestrator-Aufträge
• Flow-Übersicht