REST API テスト・ツールの使用

REST API ツールを使用するには、リソース・タイプを選択し、メソッド名をクリックし、適切なパラメーターを受け渡します。 メソッドを呼び出すと、その結果として、要求と応答が即時に表示されます。

1. Rule Execution Server コンソールに管理者としてサインインし、「REST API」タブをクリックしてテスト・ツールを表示します。
2. 「REST API」タブで、メソッド呼び出しの対象となるリソースのタブ (/ruleapps、/rulesets、/libraries、/xoms、/decisiontraces、および /utilities) をクリックします。

   Rule Execution Server REST リソースには、 RuleApp、ルール・セット、 XOM ライブラリー、 XOM リソース、意思決定ウェアハウス・トレース、およびユーティリティーがあります。

3. GET、POST、PUT、または DELETE メソッド・パスのいずれかの任意の場所をクリックします。

   このアクションにより、要求エレメントと応答エレメント (要求本体、「URL 照会パラメーター」、および「HTTP ヘッダー・パラメーター」など) を表示するパネルが開きます。

4. オプション: 「パラメーター詳細の表示」をクリックして、 使用可能なパラメーターとその説明のリストを参照してください。

   要求と応答で使用されるフォーマットの詳細と例については、REST API リファレンス・マニュアルも参照することができます。

5. オプション: 該当する場合、要求の本体を入力します。

   一部のメソッドは、要求本体を取りません。

   表 1. 要求本体

   メソッド	入力フォーマット	リソース
   POST および PUT メソッド	要求本体を必要とするメソッドの場合、要求本体は、以下のいずれかの形式を使用します。 オブジェクトの XML または JSON 記述 バイナリー・ファイル (これがあるとパラメーターは必須になります)。ファイルを選択するまで、警告アイコンが表示されます。 プレーン・テキスト・フィールド内の値 (プロパティー値など)	RuleApp およびルール・セットのリソースには、以下の 2 つの方法のいずれかで、有効なルール・セット・アーカイブを受け渡す必要があります。 既存のルール・セットを Base64 でエンコードし、結果のコードを XML または JSON コードに追加します。 要求本体の <archive></archive> XML タグのペアまたは JSON "archive" タグで指定されたバイトコードをそのまま使用します。 このバイトコードは、ルールもルール・フローもパラメーターも含まずに、有効なルール・セット・アーカイブを構成します。 この空のルール・セット・アーカイブを後で実際のルール・セット・アーカイブで更新することができます。

6. 適切なパラメーター・ボックスを選択して、次にドロップダウン・メニューから値を追加します。
   注: ツールチップは、必須パラメーターまたは読み取り専用パラメーターを示しています。 このパラメーターは編集できません。チェック・ボックスが自動的に選択されていて、これをクリアすることはできません。 必須パラメーターにデフォルト値が事前に定義されていない場合は、警告アイコンが表示され、「メソッドの呼び出し」ボタンは、値が指定されるまで使用不可の状態になります。 読み取り専用パラメーターは必須です。

   次の表を使用して、要求をパラメーター化します。

   表 2. パラメーター

   メソッド	パラメーター	パラメーター・テンプレート
   すべて	Accept パラメーターには事前定義値が 2 つあります。 他の値を手動で入力しようとすると、HTTP 状況コード 406 受け入れ不可能 (HTTP Status 406 Not Acceptable) の警告が表示されます。 一部のメソッドでは、パラメーターの事前定義値にユーザー固有のカスタム値を追加できる場合があります。	呼び出し URL 内の中括弧 ({}) に囲まれて表示されるパラメーター・テンプレートはプレースホルダーです。 これらは必須なため、値を指定する必要があります。
   GET	一部の GET メソッドでは、パラメーターがすべてオプションであるためにパラメーターが選択されていません。 この場合、「メソッド呼び出し (Call method)」 を直接クリックできます。

7. 「メソッドの呼び出し」をクリックします。

   パネルが開き、要求とその応答が表示されます。