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.

すべてのサブコマンドには uip login が必要であり、 グローバルオプションが適用されます。終了コードは 標準コントラクトに従います。

概要

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>は、すべてのサブコマンドで必要です。

共通オプション

• -f, --folder-key <key> (必須) — フォルダー キー (GUID)。
• --comment <text> (操作コマンドのみ) — 操作で記録されたオプションのコメント。省略すると空の文字列として送信されます。

サブコマンド

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.

オプション

オプション	既定 (Default)	説明
-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>	—	エラー コードでフィルター処理します。
--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.

データシェイプ

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

uip maestro bpmn instance get

1 つのインスタンスを ID で取得します。データ シェイプ: Code: "InstanceGet"、 Data はプロセス インスタンス オブジェクトです。

uip maestro bpmn instance pause

実行中のインスタンスを一時停止します。データシェイプ: Code: "InstancePaused".

uip maestro bpmn instance resume

一時停止したインスタンスを再開します。データシェイプ: Code: "InstanceResumed".

uip maestro bpmn instance cancel

実行中のインスタンスをキャンセルします。データシェイプ: Code: "InstanceCanceled".

uip maestro bpmn instance retry

エラーが発生したインスタンスをリトライします。データシェイプ: Code: "InstanceRetried".

uip maestro bpmn instance migrate

インスタンスを別のパッケージ バージョンに移行します。

引数: <instance-id>、 <new-version> (対象のパッケージ バージョン)。

データシェイプ: Code: "InstanceMigrated".

uip maestro bpmn instance variables

インスタンスの変数を取得します。

オプション: --parent-element-id <id> — 親要素で変数をフィルタリングします。

データ・シェイプ: Code: "InstanceVariables"、 Data はインスタンス変数ペイロードを運びます。

uip maestro bpmn instance variables-set

Patch (update) variables for a running instance.

オプション

オプション	説明
--inputs <value>	Patch-variables payload as a JSON string, @file path, or piped via stdin. Required (the command fails if no payload resolves).

データシェイプ

Code: "InstanceVariablesSet" です。

uip maestro bpmn instance variables-all

Get every variable for an instance, including subprocess variables.

データシェイプ: Code: "InstanceVariablesAll".

uip maestro bpmn instance global-variables

Get an instance's global variables.

データシェイプ: Code: "InstanceGlobalVariables".

uip maestro bpmn instance incidents

データ形状: Code: "InstanceIncidents"、 Data はインシデントオブジェクトの配列です。

uip maestro bpmn instance asset

このインスタンスのリリースに添付された BPMN アセットを取得します。

データシェイプ: Code: "InstanceAsset"、 Data は BPMN アセットペイロードです。

uip maestro bpmn instance cursors

現在の実行カーソル位置 (インスタンスが一時停止している要素) を取得する。

データシェイプ: Code: "InstanceCursors"、現在のカーソル位置を一覧表示 Data 。

uip maestro bpmn instance goto

実行カーソルをある要素から別の要素に移動します。

引数

• <instance-id> (必須)
• <transitions> (必須) — それぞれに sourceElementId と targetElementIdを持つトランジションの JSON 配列です。

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

データシェイプ

Code: "InstanceGoto" です。

uip maestro bpmn instance element-executions

インスタンスの要素ごとの実行履歴を取得します。

データシェイプ

Code: "InstanceElementExecutions"、 Data 要素ごとの実行履歴です。

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.

オプション

オプション	Required	説明
-f, --folder-key <key>	○	フォルダー キー (GUID)。
--inputs <value>	—	Message payload as a JSON string, @file path, or piped via stdin. Fails if no payload resolves.

データシェイプ

Code: "MessageSent" です。

uip maestro bpmn instance element cancel

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

引数

• <instance-id> (必須)
• <element-id> (必須)

オプション

オプション	説明
-f, --folder-key <key>	Folder key (GUID). Required.
--comment <text>	Optional comment for the operation.

データシェイプ

Code: "ElementCanceled" です。

uip maestro bpmn instance element retry

Retry one faulted element within an instance.

引数

• <instance-id> (必須)
• <element-id> (必須)

オプション

オプション	説明
-f, --folder-key <key>	Folder key (GUID). Required.
--comment <text>	Optional comment for the operation.

データシェイプ

Code: "ElementRetried" です。

例

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

参照

• uip maestro bpmn incidents — 特定のインスタンスから切り離されたインシデント
• uip maestro bpmn job — インスタンス実行のジョブビュー
• uip maestro bpmn process — 新しいインスタンスを開始する
• Orchestrator のジョブ
• Maestro の概要