Questetra 自らの API をたたいて処理を自動化する方法

Questetra のプロセスの途中で Questetra の API をたたいて処理をさせるケースになります

新年あけましておめでとうございます。本年もどうぞよろしくお願い致します。

さて、これまで様々なシステム連携についてブログ記事を書いてきましたが、今年もそういった記事を多めに書いていくかと思います。個人的にシステム連携ネタが好きなのですが、選択肢が広がるからかと思っています。
※ちなみにこれまでの記事はこちら

今回は Questetra のプロセスから Questetra 自身の API をたたく方法を紹介します。

1: ユースケース
2: Questetra の API のおおまかな分類
3: 設定詳細について
4: まとめ

1: ユースケース

私の知る範囲では、これまでに以下のようなケースで活用されたことがあります。

ユーザ追加／削除申請の承認後に、Questetra のユーザアカウントの追加／削除処理を行う
（ユーザを追加・編集・削除する API）
利用ユーザのパスワードを定期的に変更させるために、定期的にタスクをまわしてその変更内容を Questetra のユーザ設定に反映する
（ユーザを追加・編集・削除する API）
ある特定の期間だけ承認するユーザが変更されるよう Questetra の組織設定を変更して、期日になったら戻す
（ユーザの組織への所属を追加・削除する API）
稟議決裁等の承認フローで、申請ユーザの組織情報を取得して承認すべきユーザを演算で決定して、そのユーザに承認タスクをまわす
（ユーザ・組織・ロールの設定を参照する API）
ある工程管理を行うプロセスのデータを参照して、進捗率および遅延度の計算を行い、その結果を元のプロセスに書き込む
（業務フローの処理結果を取得する API、タスク実行する API）

2: Questetra の API のおおまかな分類

Questetra の API を大きく分けると

A. 業務フローの中に部品として置いて準備するもの：プロセスの途中で http リクエスト等の送受信等を行う
B. 上記とは異なるもの：Questetra の持つユーザやプロセスのデータの参照や更新を行う

となります。
後者は REST API で、前者のうちの1つである「メッセージ送信中間イベント(HTTP)」でたたくことができます。
ただし、同じ Questetra 環境内からであっても、後者の API をたたく場合には認証を通す必要があります。
また、取得したデータを元に計算等する場合には「スクリプトタスク」でそのレスポンスを解析する形となります。

※「メッセージ送信中間イベント(HTTP)」については、以下を参照ください。
M225: 業務データを組み込んだHTTPリクエストが、自動的に送信されるように設定する
※「スクリプトタスク」については、以下を参照ください。
M230: 業務データの複雑なデータ加工が自動実行されるように設定する（ECMAスクリプト）

3: 設定詳細について

今回は、Basic 認証でユーザを追加する API にアクセスするケースについて説明します（「スクリプトタスク」によるレスポンス解析が必要のないカンタンなケースとします）。

※Basic 認証で API アクセスさせる場合には以下2点に留意ください。

「システム設定」→左メニューの「接続アプリケーション」→「Basic 認証による API アクセス」で「Basic 認証による API アクセスを有効にする」のチェックをつけて、アクセス可能にしておく
API パスワードは、「アカウント設定」→左メニューの「パスワード」→「API パスワード」より確認する

以下は、ユーザ追加の申請が上長承認された後、ユーザアカウントを自動的に追加するプロセスモデルのサンプルです。

ユーザ追加の API 仕様については、こちらの API のリファレンス内に記載があります。
以下は該当部分のコピーです。
※ここの記載の通り、ユーザ追加処理をするにはユーザ管理権限のあるユーザでの認証が必要になります。当然といえば当然ですが。

上記の API 仕様を踏まえて、「メッセージ送信中間イベント(HTTP)」の設定は、以下のような形になります。

たたく API の URL を、アクセス URL に指定（同じ Questetra 環境であれば以下のような「${var[applicationRoot]}」といった変数でも指定可能）。
Basic 認証のためのユーザ名とパスワードを指定（前述の API パスワードを指定）。
たたく API のパラメータを、送信パラメータに指定。