intra-mart Accel Platform IM-LogicDesigner ユーザ操作ガイド 第12版 2024-04-01

intra-mart Accel Platform IM-LogicDesigner ユーザ操作ガイド 第12版 2024-04-01

目次 ≪  6.5. ユーザ定義編集 - SQL 6.7. ユーザ定義編集 - Database Fetch  ≫

6.6. ユーザ定義編集 - REST

6.6.1. ユーザ定義編集 - RESTの詳細

ユーザ定義編集 - RESTでは、REST APIを利用して処理内容を定義します。
定義内容はREST APIを送信する際のリクエスト情報と、REST APIの結果を受信する際のレスポンス情報の、大きくふたつに分かれています。
設定内容の詳細は以下の通りです。
../../../../_images/ud_edit_rest_detail.png

6.6.1.1. リクエスト情報

<画面項目>

項目 説明
エンドポイント
呼び出しを行うREST APIのエンドポイントを定義します。
エンドポイントの定義はEL式を用いた表現が可能です。
この項目は必須項目です。
メソッド
「エンドポイント」項目で指定したエンドポイントを呼び出す際に利用するHTTPメソッドを選択します。
指定可能なメソッドは以下の通りです。
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
この項目は必須項目です。
リクエスト種別
「エンドポイント」項目で指定したエンドポイントを呼び出す際に指定するリクエスト種別を選択します。
指定可能なリクエスト種別の詳細は以下の通りです。
  • x-www-form-urlencoded

    リクエストをx-www-form-urlencoded形式で送信します。
    パラメータはkey=value形式で送信されます。
    リクエストのパラメータは自動的にURLエンコードされるため、明示的にエンコードを行う必要はありません。
  • application/json

    リクエストをjson形式で送信します。
    application/jsonリクエスト種別を利用する場合、必ず入力値にbodyパラメータを定義する必要があります。
    IM-LogicDesignerは入力値に定義されたbodyパラメータをJSONに変換し、リクエストボディに含めて送信を行います。
  • form-data

    リクエストをmultipart/form-data形式で送信します。
    パラメータはkey=value形式で送信されます。
    リクエストのパラメータは自動的にURLエンコードされるため、明示的にエンコードを行う必要はありません。
  • raw

    上記（x-www-form-urlencoded, application/json, form-data）以外の形式で送信したい場合に選択します。
    rawリクエスト種別を利用する場合は、必ず入力値にbodyパラメータを定義する必要があります。
    IM-LogicDesignerは入力値に定義されたbodyパラメータをそのままリクエストボディに含めて送信を行います。
    また、rawリクエスト種別を利用する場合は、「リクエストヘッダ」項目に明示的なContent-Typeの指定を行ってください。
この項目は必須項目です。
リクエストエンコーディング
「エンドポイント」項目で指定したエンドポイントを呼び出す際に指定するエンコーディングを定義します。
この項目は「リクエスト種別」項目でraw以外を選択した場合のみ必須項目です。
リダイレクトを利用する（チェックボックス）
チェックボックスにチェックをいれることで、「エンドポイント」項目で指定したエンドポイントを呼び出した結果がリダイレクトレスポンスだった場合、リダイレクト処理を行います。
リクエストタイムアウト[秒]
「エンドポイント」項目で指定したエンドポイントへ呼び出しを行った際の、タイムアウトのしきい値を秒単位で定義します。
この項目は必須項目です。
リクエストヘッダ
「エンドポイント」項目で指定したエンドポイントを呼び出す際に指定するリクエストヘッダのヘッダ名とヘッダ値を定義します。
リクエストヘッダの定義はEL式を用いた表現が可能です。
リクエストヘッダ - 「追加」リンク
リクエストヘッダ行を追加します。
リクエストヘッダ - 「削除」リンク
対象となるリクエストヘッダ行を削除します。
リクエストパラメータ
「エンドポイント」項目で指定したエンドポイントを呼び出す際に指定するリクエストパラメータのパラメータ名とパラメータ値を定義します。
リクエストパラメータの定義はEL式を用いた表現が可能です。
この項目は「リクエスト種別」項目で、x-www-form-urlencoded、または、form-dataを選択した場合のみ利用可能です。
リクエストパラメータ - 「追加」リンク
リクエストパラメータ行を追加します。
リクエストパラメータ - 「削除」リンク
対象となるリクエストパラメータ行を削除します。

6.6.1.2. レスポンス情報

<画面項目>

項目 説明
レスポンス種別
REST APIが返すレスポンスの形式を選択します。
指定可能なレスポンス種別の詳細は以下の通りです。
  • json

    REST APIのレスポンスをJSONとして受け取ります。
    IM-LogicDesignerは、レスポンスのbodyパラメータをobjectとして取り出し、JSONとして解釈します。
    取り出した結果は文字コードが加味されます。
  • text

    REST APIのレスポンスをテキストとして受け取ります。
    IM-LogicDesignerは、レスポンスのbody値をstringとして取り出し、HTMLとして解釈します。
    取り出した結果は文字コードが加味されます。
  • raw

    REST APIのレスポンスをRaw-Dataとして受け取ります。
    IM-LogicDesignerは、レスポンスのbody値をバイナリとして取り出します。
この項目は必須項目です。
レスポンスエンコーディング
REST APIが返すレスポンスに対して指定するエンコーディングを定義します。
この項目は必須項目です。
ステータスコードの確認（チェックボックス）
チェックボックスをオンにすると、ステータスコードが200番台ではなかった場合をエラーと判断し、ユーザ定義の処理を中断します。

目次 ≪  6.5. ユーザ定義編集 - SQL 6.7. ユーザ定義編集 - Database Fetch  ≫

Copyright © 2016 NTT DATA INTRAMART CORPORATION

⇄ Sidebar ↑Top