UIP Maestro の BPMN インスタンス

「uip Maestro BPMN インスタンス」の構文とオプション - 個々の Maestro BPMN プロセス インスタンスを検査して操作します。

uip maestro bpmn instance は、個々の プロセス インスタンス (パブリッシュ済みの Maestro BPMN プロセスの 1 回の実行) を検査して操作します。サイドバーのエントリには instancesと書かれていますが、コマンド名は単数形 (instance) です。ここでのすべての動詞は bpmn 分岐に登録されています — 裸の 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 インスタンスのリスト

フォルダー内のインスタンスを processType=ProcessOrchestrationにスコープして一覧表示します。フィルターはサーバー側で適用されます。オフセットではなくカーソルによる結果ページ — 応答から Pagination.NextPage を読み取って、 --next-pageを介して返します。

オプション

オプション	既定 (Default)	説明
-l, --limit <n>	DEFAULT_PAGE_SIZE	返すアイテムの数 (1 から 500)。
--next-page <cursor>	—	前の応答の Pagination.NextPageからのカーソルです。
--offset <n>	—	この API ではサポートされていません。 --offset 0 は no-op (カーソルなしに相当) としてサイレントに受け入れられます。それ以外の値は、代わりに を使用するように知らせるエラーが発生し --next-page 失敗します。
--process-key <guid>	—	プロセス キーでフィルター処理 — GUID である必要があります。ドットで区切られたパッケージ識別子 (例:ProcessKeyとして出力されるuip or processes list InvoiceOrchestration:1.0.0) は、代わりに --package-id を使用してください。
--package-id <id>	—	パッケージ ID (ドットで区切られたパッケージ識別子) でフィルター処理します。
--error-code <code>	—	エラー コードでフィルター処理します。
--status <status>	—	インスタンスのステータスでフィルター処理する反復可能な OR セマンティクス。無効な値は、受け入れられたセットのリストが表示されてすぐに失敗します。
--from-date <iso-8601>	—	このタイムスタンプ以降に開始されたインスタンスのみを含めます。例:2026-01-01T00:00:00Zです。
--to-date <iso-8601>	—	このタイムスタンプ以前に開始されたインスタンスのみを含めます。

データシェイプ

Code: "InstanceList"は、プロセス インスタンス オブジェクトの配列に DataPagination ブロック (returned、 limit、 hasMore、 nextPage) を加えたものです。

UIP Maestro BPMN インスタンスの取得

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

UIP Maestro の BPMN インスタンスの一時停止

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

UIP Maestro BPMN インスタンスの再開

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

UIP Maestro BPMN インスタンスのキャンセル

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

UIP Maestro の BPMN インスタンスのリトライ

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

UIP Maestro BPMN インスタンスの移行

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

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

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

UIP Maestro の BPMN インスタンス変数

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

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

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

UIP Maestro BPMN インスタンス variables-set

実行中のインスタンスの変数にパッチを適用 (更新) します。

オプション

オプション	説明
--inputs <value>	Patch-variables ペイロードは、JSON 文字列、 @file パスとして、または stdin を介してパイプされます。必須 (ペイロードが解決されない場合、コマンドは失敗します)。

データシェイプ

Code: "InstanceVariablesSet" です。

UIP Maestro BPMN インスタンス変数 - すべて

インスタンスのすべての変数 (サブプロセス変数を含む) を取得します。

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

uip maestro bpmn インスタンス global-variables

インスタンスのグローバル変数を取得します。

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

UIP Maestro BPMN インスタンスのインシデント

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

UIP Maestro の BPMN インスタンス アセット

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

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

UIP Maestro: BPMN インスタンスのカーソル

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

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

UIP Maestro BPMN インスタンスの [移動]

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

引数

• <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 インスタンス element-executions

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

データシェイプ

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

UIP Maestro BPMN インスタンスのメッセージ 送信

このプロセスをリッスンするワークフロー サブスクリプションにメッセージを送信します。単一のインスタンス ID にスコープは設定されません。ベンダーのペイロードによって、メッセージが到達するインスタンスが決まります。

オプション

オプション	Required	説明
-f, --folder-key <key>	○	フォルダー キー (GUID)。
--inputs <value>	—	JSON 文字列、 @file パス、または stdin を介してパイプされるメッセージ ペイロード。ペイロードが解決されない場合は失敗します。

データシェイプ

Code: "MessageSent" です。

UIP Maestro BPMN インスタンスの要素のキャンセル

実行中のインスタンス内の 1 つの要素をキャンセルし、インスタンス全体をキャンセルする。

引数

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

オプション

オプション	説明
-f, --folder-key <key>	フォルダー キー (GUID)。必須。
--comment <text>	操作の任意のコメントです。

データシェイプ

Code: "ElementCanceled" です。

UIP Maestro の BPMN インスタンスの要素のリトライ

インスタンス内でエラーが発生した要素を 1 つリトライします。

引数

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

オプション

オプション	説明
-f, --folder-key <key>	フォルダー キー (GUID)。必須。
--comment <text>	操作の任意のコメントです。

データシェイプ

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 の概要