IBM BPM 標準 REST API

IBM® BPM Standard には、プロセスおよびタスクを処理するための一連の REST API が用意されています。

REST API の Swagger 定義は IBM BPM Standard に含まれています。ご使用の IBM BPM Standard インストール済み環境に、Swagger UI をホストする Web サーバーが存在する場合は、以下の形式の URL から REST API の Swagger 定義にアクセスできます。

https://host_name:port_number/bpm/explorer

ここで、host_name は Web サーバーの名前であり、port_number は Web サーバーが使用するポート番号です。例えば、localhost:9080/bpm/explorer となります。 Web サーバーの構成について詳しくは、Web サーバーと連動する IBM BPM のカスタマイズを参照してください。

以下の REST API 呼び出しを使用して Swagger 定義を取得することもできます。

GET /bpm/docs

この呼び出しは、Swagger 定義を保持する JSON オブジェクトを返します。

重要: クロスサイト・リクエスト・フォージェリー攻撃を予防するために、IBM BPM Standard REST API 操作では、要求ごとに HTTP ヘッダー BPMCSRFToken を設定することが必要です。詳しくは、クロスサイト・リクエスト・フォージェリーの予防を参照してください。

要確認: IBM BPM on Cloud の場合、IBM BPM Standard REST API の URL 構造は https://hostname.bpm.ibmcloud.com/bpm/system です。ここで、system の値は開発システムについては dev、テスト・システムについては test、実動 (ランタイム) システムについては run です。

以下のセクションは、各 API カテゴリーで使用できる REST API のリストを示します。

プロセス
タスク

プロセス

GET /processes: プロセス・インスタンスのリストを取得します。
POST /processes: プロセス・インスタンスを開始します。
GET /processes/{process-id}: プロセス・インスタンスを取得します。
DELETE /processes/{process-id}: プロセス・インスタンスを削除します。

タスク

GET /user-tasks: ユーザー・タスクのリストを取得します。
GET /user-tasks//{task-id}: ユーザー・タスクを取得します。
POST /user-tasks//{task-id}/claim: ユーザー・タスクを要求します。
POST /user-tasks//{task-id}/complete: ユーザー・タスクを要求します。