uip maestro bpmn instances

Syntax and options for `uip maestro bpmn instance`, which inspects and steers individual Maestro BPMN process instances.

uip maestro bpmn instance inspects and steers individual process instances — one execution of a published Maestro BPMN process. The command name is singular (instance) even though the sidebar entry says instances. Every verb here is registered under the bpmn branch — there is no bare 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 instance list

List instances in a folder, scoped to processType=ProcessOrchestration. Filters are applied server-side. Results page by cursor, not offset — read Pagination.NextPage from a response and pass it back via --next-page.

Optionen

Option	Standard	Beschreibung
-l, --limit <n>	DEFAULT_PAGE_SIZE	Number of items to return (1-500).
--next-page <cursor>	–	Cursor from a previous response's Pagination.NextPage.
--offset <n>	–	Not supported by this API. --offset 0 is silently accepted as a no-op (equivalent to no cursor); any other value fails with an error telling you to use --next-page instead.
--process-key <guid>	–	Filter by process key — must be a GUID. For the dotted package identifier (e.g. InvoiceOrchestration:1.0.0) that uip or processes list prints as ProcessKey, use --package-id instead.
--package-id <id>	–	Filter by package ID (the dotted package identifier).
--error-code <code>	–	Nach Fehlercode filtern.
--status <status>	–	Filter by instance status. Repeatable, OR-semantics. An invalid value fails fast listing the accepted set.
--from-date <iso-8601>	–	Only include instances started at or after this timestamp, e.g. 2026-01-01T00:00:00Z.
--to-date <iso-8601>	–	Only include instances started at or before this timestamp.

Datenform

Code: "InstanceList", Data is an array of process-instance objects, plus a Pagination block (returned, limit, hasMore, nextPage).

uip maestro bpmn instance get

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

uip maestro bpmn instance pause

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

uip maestro bpmn instance resume

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

uip maestro bpmn instance cancel

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

uip maestro bpmn instance retry

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

uip maestro bpmn instance migrate

Migrieren Sie eine Instanz zu einer anderen Paketversion.

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

Datenform: Code: "InstanceMigrated".

uip maestro bpmn instance variables

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.

uip maestro bpmn instance variables-set

Patch (update) variables for a running instance.

Optionen

Option	Beschreibung
--inputs <value>	Patch-variables payload as a JSON string, @file path, or piped via stdin. Required (the command fails if no payload resolves).

Datenform

Code: "InstanceVariablesSet".

uip maestro bpmn instance variables-all

Get every variable for an instance, including subprocess variables.

Datenform: Code: "InstanceVariablesAll".

uip maestro bpmn instance global-variables

Get an instance's global variables.

Datenform: Code: "InstanceGlobalVariables".

uip maestro bpmn instance incidents

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

uip maestro bpmn instance 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.

uip maestro bpmn instance cursors

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 instance 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".

uip maestro bpmn instance element-executions

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

Datenform

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

uip maestro bpmn instance message send

Send a message to workflow subscriptions listening on this process — not scoped to a single instance ID; the vendor payload determines which instance(s) the message reaches.

Optionen

Option	Erforderlich	Beschreibung
-f, --folder-key <key>	ja	Ordnerschlüssel (GUID).
--inputs <value>	–	Message payload as a JSON string, @file path, or piped via stdin. Fails if no payload resolves.

Datenform

Code: "MessageSent".

uip maestro bpmn instance element cancel

Cancel one element within a running instance, without canceling the whole instance.

Argumente

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

Optionen

Option	Beschreibung
-f, --folder-key <key>	Folder key (GUID). Required.
--comment <text>	Optional comment for the operation.

Datenform

Code: "ElementCanceled".

uip maestro bpmn instance element retry

Retry one faulted element within an instance.

Argumente

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

Optionen

Option	Beschreibung
-f, --folder-key <key>	Folder key (GUID). Required.
--comment <text>	Optional comment for the operation.

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