1.3. サポート対象の KIE Server REST API エンドポイント

KIe Server REST API は、Red Hat Process Automation Manager で以下のタイプのリソースにエンドポイントを提供します。

  • KIE Server および KIE コンテナー
  • KIE セッションアセット (ランタイムコマンド用)
  • DMN アセット
  • プラニングソルバー
  • プロセス
  • プロセスイメージ
  • プロセスおよびタスクフォーム
  • タスク
  • ケース
  • ドキュメント
  • ジョブ
  • プロセス、タスク、およびケースのクエリー
  • カスタムクエリー

KIE Server REST API のベース URL は http://SERVER:PORT/kie-server/services/rest/ です。ユーザーロール kie-server では、すべての要求で HTTP の Basic 認証またはトークンベースの認証が必要です。

KIE Server REST API エンドポイントの完全一覧と説明については、以下の関連資料を参照してください。

  • jBPM ドキュメントページ (静的) の Execution Server REST API

  • http://SERVER:PORT/kie-server/docs (動的。稼働中の KIE Server が必要) ページの KIE Server REST API 用 Swagger UI

    注記

    デフォルトでは、org.kie.swagger.server.ext.disabled=false システムプロパティーが指定されており、KIE Server の Swagger Web インターフェースが有効になっています。KIE Server で Swagger Web インターフェースを無効にするには、このシステムプロパティーを true に設定してください。

エンドポイント要件

KIe Server REST API エンドポイントには以下の要件があることに注意してください。

  • プロセスイメージ: API がプロセスイメージにアクセスするには、システムプロパティー <storesvgonsave enabled="true"/> が $SERVER_HOME/standalone/deployments/business-central.war/org.kie.workbench.KIEWebapp/profiles/jbpm.xml で Red Hat Process Automation Manager プロジェクト用に設定されている必要があります。このプロパティーは、デフォルトで true に設定されます。API がプロセスイメージを使用していない場合には、ファイルで true に設定し、KIE Server を再起動します。このプロパティーの設定により SVG イメージが保存されるので、KIE Server REST API が取得できるようになります。

  • カスタムクエリー: KIE Server REST API でのカスタムクエリーのなかには、クエリー結果を具体的なオブジェクトにマッピングするためのクエリー mapper 定義が必要なものもあります。独自のクエリ結果マッパーか、Red Hat Process Automation Manager で提供されているマッパーのいずれかを実装することができます。Red Hat Process Automation Manager のクエリマッパーは、テーブルをエントリーにマッピングする、Hibernate などの他のオブジェクト関係マッピング (ORM) プロバイダーと同様のものです。たとえば、org.jbpm.kie.services.impl.query.mapper.ProcessInstanceQueryMapper を使用することが可能です。これはプロセスインスタンスデータを返すためのカスタムクエリーエンドポイントで ProcessInstances としても登録されています。

    ProcessInstances マッパーパラメーターでの POST エンドポイントの例: 

    http://localhost:8080/kie-server/services/rest/server/queries/definitions/jbpmProcessInstances?mapper=ProcessInstances

    Red Hat Process Automation Manager で利用可能なクエリーマッパーの一覧については、Red Hat カスタマーポータル から Red Hat Process Automation Manager 7.8 Source Distribution をダウンロードして展開し 、～/jbpm-$VERSION/jbpm-services/jbpm-kie-services/src/main/java/org/jbpm/kie/services/impl/query/mapper に移動します。