REST APIジョブが外部クライアントから受け取ったリクエスト本文を確認する方法はありますか

質問

REST APIジョブが外部クライアントから受け取ったリクエスト本文を確認する方法はありますか。
JSON形式のデータをPOSTメソッドでリクエストすることを想定しています。

回答

以下、レスポンス本文としてリクエスト本文を確認する方法があります。

なお、必要箇所以外の作業手順は割愛しておりますのであらかじめご了承ください。

■APIプロジェクトに設定するスクリプトを準備する。

1. XML型のスクリプト変数を作成し、入力・出力変数として設定する。
   
2. XMLファイル書き込み処理を配置する。
   書き込み先ファイルを指定する。
3. プロセスフローとデータフローを引く。
   ・StartからEndまでデータフローを引く。
   ・StartからXMLファイル書き込み処理までプロセスフローとデータフローを引く。
   ・XMLファイル書き込み処理からEndまでプロセスフローを引く。
   

■APIプロジェクトのリソース(POST)を設定する。

1. 準備したスクリプトを指定する。
2. リクエスト設定 - リクエスト本文のパラメーターを追加する。
   JSON形式でスクリプト変数に格納する。
   
3. レスポンス設定 - レスポンス本文のパラメーターを追加する。
   JSON形式でスクリプト変数に格納する。
   

■REST APIジョブを作成する。

上記、APIプロジェクトを指定する。

■外部クライアントからJSON形式のデータをリクエストする。

例として、Postmanを使用してリクエスト本文にJSON形式のデータを設定したリクエストを送信すると、画面下部のレスポンス本文にリクエスト本文が返却されます。

なお、こちらの方法の場合、API呼び出しで何らかのエラーが発生したり、スクリプトの実行が失敗した場合にはレスポンスが変わり、リクエスト本文は返却されませんのであらかじめご留意ください。

関連FAQ

・REST APIジョブで受領したJSON形式のリクエスト本文をCSVファイルに出力したい