RESTful Web サービスを使用して、フォームを外部アプリケーションと結合します。RESTful Web サービスには、Open API 定義と非 Open API REST サービスを含めることができます。フォームに Open API 定義を持つ REST サービスを使用して、メソッド/パラメータを確認し、サービスを正常に実行できます。

1. フォーム モデリング バーで、[アクション] をクリックし、[新規] をクリックします。

   [新しいアクション] ダイアログ ボックスが表示されます。

2. [タイプ] リストで、[RESTful サービス] を選択します。
3. デフォルトの [名前] (RESTfulService1) を意味のある名前に変更します。
4. この項目は任意です。アクションの [説明] を入力します。
5. この項目は任意です。[複数言語] を選択して、言語ごとに固有のアクションを個別に構成します。複数言語の設定アクションを参照してください。
6. Web サービスには、Open API 定義と非 Open API REST サービスを持つすべての REST サービス定義が一覧表示されます。[Web サービス] リストで、次のいずれかを実行します。

   アクション用に事前構成された RESTful Web サービス参照を選択します。

   選択した RESTful サービスに応じて、事前構成された [ベース URL] が表示されます。また、RESTful サービスで定義されたカスタム ヘッダーが [カスタム ヘッダー] の下に表示されます。 ベース URL パラメータをコピーして別の RESTful サービスのベース URL パラメータに貼り付けると、ベース URL パラメータを再利用できます。 Web サービス レファレンスをホワイトリストに登録できます。システム設定で「すべて許可」が選択されていない場合は、ホワイトリストに登録された Web サービス レファレンスのみを使用できます。サーバー URL とデータベース接続文字列の構成を参照してください。 [URL パラメータ] ルール エディタを右クリックして、文字列型の単一変数 (フォーム変数またはグローバル変数) またはフォーム フィールドを選択するか、静的な値、変数、およびフォーム フィールドを組み合わせて URL を動的に定義します。 URL パラメータは、戻り値に影響する、文字列型のオプション パラメータです。 データを取得、削除、挿入、または更新するための RESTful サービス アクションを構成します。

   事前構成された RESTful Open API Web サービスを選択します。「Web サービス参照の作成」を参照してください。

   [パラメータ] の [構成] リンクが使用可能になります。[構成] をクリックします。 [RESTful サービス アクションの構成] に、RESTful サービスの詳細が表示されます。 選択した RESTful サービスの統合に事前設定された [ベース URL] が表示されます。 [クラス] リストでクラスを選択します。 選択したクラスで使用可能なメソッドが [メソッド] リストに表示されます。 [メソッド] を選択して、インライン値/フォーム コントロール/変数 (フォームまたはグローバル) をパラメータにマッピング可能なパラメータとパラメータ タイプを表示します。 [OK] をクリックします。 また、RESTful サービスで定義されたカスタム ヘッダーが [カスタム ヘッダー] の下に表示されます。

7. データを取得、削除、挿入、または更新するための RESTful サービス アクションを構成します。[メソッド] リストで、実行するアクションを選択します。(デフォルト: GET)

   • データを取得または削除するための RESTful サービス アクションを構成する。

     1. [メソッド] リストで、GET を選択してデータを取得するか、DELETE を選択してデータを削除します (デフォルト: GET)

     2. 情報を取得する要求により、JSON または XML 形式のいずれかで応答が返されます。応答を XML 形式または JSON 形式のどちらで返すかを指定するには、[タイプ] を [XML] あるいは [JSON] として選択します。(デフォルト: XML)

     3. Web サービス参照の作成時に定義したカスタム ヘッダーとそのデフォルト値は、[カスタム ヘッダー] の下に表示されます。カスタム ヘッダーのデフォルト値を編集するには、行をダブルクリックするか、カスタム ヘッダーを選択して、 をクリックします。次に、動的変数を選択するか、 をクリックして静的な値を入力し、[OK] をクリックします。

     4. RESTful サービスから受信した応答を変数に保存するか、式として保存するかを指定するには、[応答タイプ] リストで次のいずれかを選択します。

        [変数] (デフォルト)	[値] リストでプロセス、サーバー変数、またはフォーム コントロールを選択して、出力全体を単一の変数またはフォーム フィールドにマッピングします。 応答が JSON の場合は、データ オブジェクト変数をマッピングして戻り値を保持できます。 アクションを実行すると、RESTful サービスから返された JSON 文字列を使用して、基になるデータ モデルに基づいて変数にデータが入力されます。 データ オブジェクト変数を使用しているフォームをデバッグする場合、表示される値は JSON 文字列となります。
        式	次の操作を実行します。  をクリックします。 式から抽出する要素を定義するには、正しい [パス] を指定します。 [値] リストで、プロセス、サーバー変数、またはフォーム コントロールを選択します。 [追加] をクリックします。

   • データを挿入または更新するように RESTful サービス アクションを構成する。

     1. [メソッド] リストで、[POST] を選択してデータを挿入し、[PUT] を選択してデータを更新します。

     2. [XML] に [タイプ] または [JSON] を選択して、応答を XML 形式または JSON 形式のどちらで返すかを指定します。(デフォルト: XML)

     3. [リクエスト] ルール エディタを右クリックして、プロセス、サーバー変数、またはフォーム コントロールを選択します。

     4. Web サービス参照の作成時に定義したカスタム ヘッダーとそのデフォルト値は、[カスタム ヘッダー] の下に表示されます。カスタム ヘッダーのデフォルト値を編集するには、行をダブルクリックするか、カスタム ヘッダーを選択して、 をクリックします。次に、動的変数を選択するか、 をクリックして静的な値を入力し、[OK] をクリックします。

     5. RESTful サービスから受信した応答を変数に保存するか、式として保存するかを指定するには、[応答タイプ] リストで次のいずれかを選択します。

        [変数] (デフォルト)	[値] リストでプロセス、サーバー変数、またはフォーム コントロールを選択して、出力全体を単一の変数またはフォーム フィールドにマッピングします。 戻り値の型が JSON の場合、固定テキストやその他の変数とともに、1 つ以上のデータ オブジェクト変数を要求プロパティにマッピングできます。この要求は、サービスに渡される前に 1 つの要求として結合される複数のオブジェクトを受け入れます。 データ オブジェクト変数を応答変数としてマッピングすることもできます。アクションを実行すると、要求のコンテンツが結合されて RESTful サービスに渡され、サービスからの応答を使用して、変数に返される JSON が基になるモデルに基づいて入力されます。 フォームのデバッグ時に、データ オブジェクト変数の値を表示できます。
        式	次の操作を実行します。  をクリックします。 式から抽出する要素を定義するには、正しい [パス] を指定します。 [値] リストで、プロセス、サーバー変数、またはフォーム コントロールを選択します。 [追加] をクリックします。

8. エラーが見つかった場合にジョブの一時停止を許可するには、[エラーで停止] を選択します。(デフォルト: オフ。エラーが発生してもジョブを完了することを意味します。)
9. [エラー コード] を表示するには、グローバル変数、フォーム変数、またはフォーム コントロールを選択するか、静的な値を指定します。
10. [追加] をクリックします。

    新たに作成されたアクションがテーブルに追加されます。

11. このアクションをトリガーするため、アクションにコントロールを関連付けます。フォーム コントロール イベント用のアクションの構成を参照してください。または、フォーム イベントに対してこのアクションを呼び出すには、アクションをフォームに関連付けます。フォームへのアクションの関連付けを参照してください。

    このアクションがトリガーされると、RESTful Web サービスが実行され、出力およびステータス コードが構成したとおりに処理されます。