RESTful サービス アクション

RESTful Web サービスを使用して、フォームを外部アプリケーションと結合します。

TotalAgility は、単純なタイプの RESTful Web サービスのみをサポートします。したがって、複雑なデータ構造では使用しないでください。

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

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

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

    選択した RESTful サービスに応じて、[ベース URL] が表示されます。また、RESTful サービスで定義されたカスタム ヘッダーが [カスタム ヘッダー] の下に表示されます。

    ベース URL パラメータをコピーして別の RESTful サービスのベース URL パラメータに貼り付けると、ベース URL パラメータを再利用できます。

    Web サービス レファレンスをホワイトリストに登録できます。システム設定ですべて許可が選択されていない場合は、ホワイトリストに登録された Web サービス レファレンスのみを使用できます。サーバー URL とデータベース接続文字列の構成を参照してください。
  7. [URL パラメータ] ルール エディタを右クリックして、文字列型の単一変数 (フォーム変数またはグローバル変数) またはフォーム フィールドを選択するか、静的な値、変数、およびフォーム フィールドを組み合わせて URL を動的に定義します。

    URL パラメータは、戻り値に影響する、文字列型のオプション パラメータです。

  8. [メソッド] リストで、実行するアクションを選択します。(デフォルト: GET)

    [GET] または [DELETE]

    データを取得するには GET、データを削除するには DELETE を選択し、次の手順を実行します。

    • [タイプ] として [XML] または [JSON] を選択します。(デフォルト: XML)

    • Web サービス レファレンスの作成時に定義されたカスタム ヘッダーとそのデフォルト値は、[カスタム ヘッダー] の下に表示されます。カスタム ヘッダーのデフォルト値を編集するには、次の手順を実行します。

      1. 行をダブルクリックするか、カスタム ヘッダーを選択して をクリックします。

      2. [値] で動的変数を選択するか、 をクリックして静的な値を入力します。

      3. [OK] をクリックします。

    • [応答タイプ] リストで次のいずれかを選択します。

      • [変数] (デフォルト) を選択し、[値] リストでプロセス、サーバー変数、またはフォーム コントロールを選択して、出力全体を単一の変数またはフォーム フィールドにマップします。

      • [式] を選択して次の手順を実行します。

        1. をクリックします。

        2. 式から抽出する要素を定義するには、正しい [パス] を指定します。
        3. [値] リストで、プロセス、サーバー変数、またはフォーム コントロールを選択します。

        4. [追加] をクリックします。

    [POST] または [PUT]

    データを挿入するには POST、データを更新するには PUT を選択し、次の手順を実行します。

    • [タイプ] として [XML] または [JSON] を選択します。(デフォルト: XML)

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

    • Web サービス レファレンスの作成時に定義されたカスタム ヘッダーとそのデフォルト値は、[カスタム ヘッダー] の下に表示されます。カスタム ヘッダーのデフォルト値を編集するには、次の手順を実行します。

      1. 行をダブルクリックするか、カスタム ヘッダーを選択して をクリックします。

      2. [値] で動的変数またはフォーム コントロールを選択するか、 をクリックして静的な値を入力します。

      3. [OK] をクリックします。

    • [応答タイプ] リストで次のいずれかを選択します。

      • [変数] (デフォルト) を選択し、[値] リストでプロセス、サーバー変数、またはフォーム コントロールを選択して、出力全体を単一の変数またはフォーム フィールドにマップします。

      • [式] を選択して次の手順を実行します。

        1. をクリックします。

        2. 式から抽出する要素を定義するには、正しい [パス] を指定します。
        3. [値] リストで、プロセス、サーバー変数、またはフォーム コントロールを選択します。

        4. [追加] をクリックします。

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

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

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

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