intra-mart Accel Platform IM-LogicDesigner仕様書 第13版 2019-08-01

4.2.5.1.2. REST

処理種別(タイプ)RESTは、ユーザ定義タスクとしてRESTを利用したタスクを定義します。

4.2.5.1.2.1. 入力値/返却値

処理種別(タイプ)RESTでは、入力値/返却値をそれぞれ以下のように定義します。

4.2.5.1.2.1.1. 入力値

呼び出すREST-APIへのリクエストパラメータを定義します。
入力値に定義したパラメータは、リクエスト情報のリクエストパラメータの名称、および、値と紐付きます。

呼び出すリクエスト種別がx-www-formurlencodedの場合には、パラメータにEL式を記述します。
EL式の評価結果が配列/リストの場合には複数のリクエストパラメータとしが利用されます。
呼び出すリクエスト種別がjsonの場合には、bodyパラメータをJSON形式に変換しリクエストボディとして送信します。
リクエスト種別がrawの場合には、bodyパラメータに指定したbinary型の内容がリクエストボティとして扱われます。

4.2.5.1.2.1.2. 返却値

呼び出したREST-APIの実行結果とHTTPステータスを定義します。
実行結果はHeaderとBodyが返却され、HTTPステータスはステータスコードとレスポンスフレーズが返却されます。
これらの値は指定したREST-APIの呼び出し結果が返ってきた際に、システムが自動でマッピングします。

注意

処理種別(タイプ)RESTの返却値の定義はシステムで固定です。

4.2.5.1.2.2. リクエスト

処理種別(タイプ)RESTにおいて、リクエストの定義情報の詳細は以下の通りです。

4.2.5.1.2.2.1. エンドポイント

呼び出すREST-APIのエンドポイントを定義します。
エンドポイントにはEL式を利用することが可能です。

4.2.5.1.2.2.2. メソッド

指定したエンドポイントを呼び出す際に利用するHTTPメソッドを定義します。
指定可能なHTTPメソッドは以下の通りです。
  • GET
  • POST
  • PUT
  • DELETE

4.2.5.1.2.2.3. リクエスト種別

指定したエンドポイントを呼び出す際に指定するリクエスト種別を定義します。
指定可能なリクエスト種別は以下の通りです。
  • x-www-form-urlencoded
  • multipart-formdata
  • json
  • raw
メソッドにGET、および、DELETEを指定した場合、リクエスト種別はx-www-form-urlencodedのみ定義可能です。

4.2.5.1.2.2.4. リクエストエンコーディング

指定したエンドポイントを呼び出す際に指定するエンコーディングを定義します。

4.2.5.1.2.2.5. リダイレクトの利用

指定したエンドポイントを呼び出した結果、リダイレクトレスポンスを取得した場合、リダイレクト処理を行うかどうかを定義します。

4.2.5.1.2.2.6. リクエストタイムアウト

指定したエンドポイントへの呼び出しのタイムアウトのしきい値(秒)を定義します。

4.2.5.1.2.2.7. リクエストヘッダ

指定したエンドポイントを呼び出す際に指定するリクエストヘッダの名称と値をペアで定義します。
リクエストヘッダの値にはEL式を利用することが可能です。

4.2.5.1.2.2.8. リクエストパラメータ

指定したエンドポイントを呼び出す際に指定するリクエストパラメータの名称と値をペアで定義します。
リクエストパラメータの名称は、入力値で定義した名称と紐付ける必要があります。
リクエストパラメータの値にはEL式を利用することができます。

4.2.5.1.2.3. レスポンス

処理種別(タイプ)RESTにおいて、レスポンスの定義情報の詳細は以下の通りです。

4.2.5.1.2.3.1. レスポンス種別

指定したエンドポイントが返すレスポンスの形式を定義します。
指定可能なレスポンス種別は以下の通りです。
  • json
  • text
  • raw

4.2.5.1.2.3.2. レスポンスエンコーディング

指定したエンドポイントが返すレスポンスに対して指定するエンコーディングを定義します。

4.2.5.1.2.3.3. ステータスコードの確認

リクエスト結果のステータスコードが200番台であるか確認するか否かを定義します。