REST API
ワークフロー基盤は、
様々な REST API 連携をサポートしています。
ユーザや組織を更新する
System Settings API
System Settings API は、ワークフロー基盤全体を管理するためのAPI群です。このAPIを利用することで、ユーザ情報の参照や更新、組織情報の編集といったシステムレベルの設定を外部から操作できます。
Microsoft Entra ID や HENNGE One といったID管理システムと連携し、ユーザ情報や組織情報を同期させることが可能です。また、独自のサードパーティ製アプリを開発し、基盤設定を自動化する際にも活用されます。
APIエンドポイント例:
/API/UGA/Quser/add新規にユーザを追加します。
/API/User/RoleMembership/list指定したロールに所属するユーザの一覧を取得します。
/API/Admin/SystemAuthority/addToQuserユーザにシステム管理権限を付与します。
利用条件:
データ参照系 (GET) API：全てのエディションで利用可能です。
データ更新系 (POST) API：Professional エディションで利用可能です。
APIの認証には、外部システムからの呼び出しに際して、高いセキュリティを確保するOAuth2認証（RFC 6749/6750準拠）が基本となります。
案件データ（プロセスデータ）を参照する
Workflow API
Workflow API は、ワークフロー基盤上で稼働する「ワークフローアプリ」やそのワークフローアプリ上に流れる「プロセス」を管理するためのAPI群です。このAPIを通じて、過去の案件データを集計・分析したり、進行中の案件データを外部システムから参照・更新したりすることができます。 Power BI、Tableau、Microsoft SharePoint といったBIツールや文書管理システムと連携させることで、業務データの可視化や分析を高度化できます。
また、「マイタスクの案件を処理するモバイルアプリ」や「過去の業務データを集約するツール」などを独自に開発することも可能になります。その他、選択肢マスタの参照や、特定のワークフローアプリに対する特権ユーザの設定など、幅広い操作に対応しています。
APIエンドポイント例:
/API/OR/ProcessInstance/listプロセス案件の詳細リストを取得します。
/API/Admin/ProcessAuthority/addToQrole指定したロールにWFアプリの特権を付与します。
/API/PMM/ProcessModel/{processModelInfoId}/stop指定したWFアプリを停止させます。
利用条件:
データ参照系 (GET) API：全てのエディションで利用可能です。
データ更新系 (POST) API：Professional エディションで利用可能です。
案件（プロセス）を進める
ワークフロー図（BPMN）に特定のイベントやタスクを配置することで、外部システムから「プロセス」（案件）をコントロールすることができます。これにより、Googleフォーム、kintone、Salesforce といった他クラウドから、新規プロセス（新規案件）を開始したり進行中のプロセス（案件）を次の工程に進めたりできます。
これらのBPMN要素を利用する際は、認証のためにAPIキーが必要となります。
HTTPリクエストを受け取るBPMN要素の概要
メッセージ開始イベント (HTTP)
外部からのHTTPリクエストを受け、新規にプロセスを開始します。リクエストの各パラメータ値が、指定された業務データ項目に格納されます。
/System/Event/MessageStart/{processModelInfoId}/{nodeId}/start?key={apiKey}
メッセージ開始イベント (Webhook)
外部からのHTTPリクエストを受け、新規にプロセスを開始します。リクエストボディのJSONが、そのまま1つの文字型データ項目に格納されます。
/System/Event/MessageStartHttp/{processModelInfoId}/{nodeId}/{apiKey}/start
受信タスク (HTTP)
待機中のプロセスがHTTPリクエストを受け、次の工程に進められます。リクエストの各パラメータ値は、指定された業務データ項目に格納されます。
/System/ReceiveTask/HttpPost/{processModelInfoId}/{nodeId}/receive?key={apiKey}
受信タスク (Webhook)
待機中のプロセスがHTTPリクエストを受け、次の工程に進められます。リクエストボディのJSONが、そのまま1つの文字型データ項目に格納されます。
/System/ReceiveTask/Http/{processModelInfoId}/{nodeId}/{processInstanceId}/{apiKey}/receiveQuestetra BPM Suite の機能