パラメーター

パラメーターは、プロセス内からAPIが呼び出されたときに動的に値を追加してAPIリクエストにデータを渡すメソッドを提供します。これらはベースURL、アクションURLパス、ヘッダー、リクエスト本文で使用できます。プロセスに公開されると、適切なAPIサービスがビジネスオブジェクトとして選択されたときにオブジェクトおよびプロセスのアクションの入力として利用できます。

API定義では、共通パラメーターとアクション固有パラメーターの2種類のパラメーターを構成できます。共通パラメーターはすべてのアクションで使用され、アクションレベルで構成されたパラメーターはそのアクションでのみ利用できます。

URLパス、ヘッダー、リクエスト本文でパラメーター値を使用するには、パラメーターを角括弧で囲みます。例：

http://staff.database.com/api/[version]/employee/[id]

関連付けられたAPI定義を使用するプロセスが実行されパラメーターが展開されると、URLは次のようになります。

http://staff.database.com/api/v2/employee/290054

パラメーターを参照せずに角括弧を使用するには、テキストを二重角括弧で始める必要があります。たとえば、リクエスト本文に次の情報が含まれているとします。

{

"favourite-colours":[["緑", "赤", "青"]

}

APIが呼び出されると、HTTPリクエストに角括弧が含まれます。

{

"favourite-colours":["緑", "赤", "青"]

}

パラメーターはAPIが呼び出された時点で適用され、初期値が設定されている場合は値がAPI定義から取得されます。ただし、パラメーターが公開されていて、値がプロセスアクションの入力として入力されている場合は、その値が使用されます。

次の例では、2つの共通パラメーターがAPI定義で構成されています。両方とも初期値が設定され、プロセスに公開されています。

パラメーターはリクエストURLで参照されます。

［バージョン］パラメーターの入力値はアクションに設定されていますが、idパラメーターには設定されていません。

アクションが実行されてAPIが呼び出されると、［バージョン］パラメーター値はAPI定義から、［id］はアクション入力から取得されます。