UIP-Flow-Instanzen

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

Zusammenfassung

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

-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-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 (1–10.000).
--offset <n>	0	Anzahl der zu überspringenden Elemente (0-1000000).
--process-key <k>	–	Nach Prozessschlüssel filtern.
--package-id <id>	–	Filtern Sie nach Paket-ID.
--error-code <code>	–	Nach Fehlercode filtern.

Datenform

Code: "InstanceList", Data is an array of process-instance objects.

Abrufen der UIP-Flow-Instanz

Rufen Sie eine einzelne Instanz nach ID ab.

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

Anhalten der UIP-Flow-Instanz

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

Fortsetzen der UIP-Flow-Instanz

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

Abbruch der UIP-Flow-Instanz

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

Wiederholung der UIP-Flow-Instanz

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

UIP-Flow-Instanz migrieren

Migrieren Sie eine Instanz zu einer anderen Paketversion.

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

Datenform: Code: "InstanceMigrated".

Variablen der UIP-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.

Vorfälle mit UIP-Flow-Instanzen

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

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

UIP-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 für UIP-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.

Beispiele für die UIP-Flow-Instanz

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 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-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 is the per-element execution history.

Beispiele

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

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

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

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

Siehe auch

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