リクエスト本文の指定

POSTまたはPUTメソッドを使用するRESTリクエストに必要なリクエスト本文を指定します。

次のプロシージャを使用して、メインHTTP URLまたはオプションのポーリングURLおよび終了URLでリクエスト本文を構成できます。

リクエスト本文の追加

現在、リクエスト本文でサポートされている形式はJSONのみです。

リクエスト本文を作成するには:

「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「リクエスト」を選択してRESTタスクのリクエスト本文を作成します。

投票または終了URLのリクエスト本文を作成するには、「完了基準の指定」ページに移動し、「待機なしRESTコールのポーリングおよび終了条件を構成します」チェック・ボックスを選択します。「Polling」または「Termination」タブで、「Request」を選択します。

「リクエスト」タブが表示されない場合は、適切なHTTPメソッドを選択したことを確認します。
エディタに、リクエスト本文を入力します。
- ペイロード全体を入力するかコピーして貼り付けることができます。
- ペイロード内の既存のパラメータを構文${}を使用して参照できます。例:
```
{
    "modelType": "USER_PROJECT",
    "modelVersion": "20200901",
    "parentRef": {},
    "name": "${PROJECT_NAME}",
    "identifier": "${PROJECT_NAME}",
    "description": "Creating my project",
    "objectVersion": 0,
    "objectStatus": 8,
    "registryMetadata": {
        "registryVersion": 0
    }
}
```
ノート

エディタの組込みバリデータによって、リクエスト本文が検証されます。赤いドットが付いた「x」がエディタの横に表示されている場合、そのアイコンにカーソルを合せると、そのコード行のエラーが表示されます。
タスク・パラメータをリクエスト本文全体に割り当てるには、「タスク・パラメータとして公開」をクリックします。リクエスト本文のパラメータ化を参照してください。

パラメータ化されたリクエスト本文の本文を編集するには、パラメータの値を編集します。

リクエスト本文のパラメータ化

リクエスト本文内でパラメータを使用することに加え、リクエスト本文全体をパラメータ化できます。

リクエスト本文の追加を参照してください。

リクエスト本文をエディタで作成した後、タスク・パラメータをボディ全体に割り当てることができます。

リクエスト本文全体をパラメータ化するには:

「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「リクエスト」を選択します。

ポーリングまたは終了URLのリクエスト本文をパラメータ化するには、「完了基準の指定」ページに移動します。「Polling」または「Termination」タブで、「Request」を選択します。
「タスク・パラメータとして公開」をクリックします。
リクエスト本文をまだ入力していない場合は、データ統合によってダイアログに警告メッセージが表示されます。最初にリクエスト本文を入力してから、本文全体にパラメータを割り当てます。
「パラメータの追加」パネルで、「識別子」フィールドにパラメータの名前を入力するか、デフォルト値を使用します。

パラメータ名はRESTタスク内で一意である必要があります。タスク内のパラメータの現在のリストを確認する方法は、RESTタスク内のすべてのパラメータの表示を参照してください。
(オプション)他のユーザーにパラメータの目的がわかるように、説明を入力します。
パラメータのデータ型はJSONです。変更することはできません。
「値」フィールドに、このタスク・パラメータのデフォルトJSONを設定します。
「追加」をクリックします。
パラメータ名がエディタの上部に追加されます。

パラメータ化されたリクエスト本文の本文を編集するには、パラメータの値を編集します。

リクエストボディパラメータの値の編集

リクエスト本文のタスク・パラメータのデフォルト値を変更できます。

パラメータ化されたリクエスト本文を編集するには:

POSTまたはPUTメソッドの「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「リクエスト」を選択します。

ポーリングまたは終了URLのパラメータ化されたリクエスト本文を編集するには、「完了基準の指定」ページに移動します。「Polling」または「Termination」タブで、「Request」を選択します。
「パラメータの編集」をクリックします。
「パラメータの編集」パネルでは、「値」フィールドのみを編集できます。データ型または説明を変更することはできません。
説明を編集するには、RESTタスク・パラメータの編集を参照してください。
「保存」をクリックします。

リクエスト本文パラメータの削除

パラメータを削除すると、パラメータとRESTタスクのリクエスト本文との関連付けのみが削除されます。

リクエスト本文全体からパラメータの割当てを解除するには:

POSTまたはPUTメソッドの「REST API詳細の構成」ページの「実行詳細の定義」ステップで、「リクエスト」を選択します。

ポーリングまたは終了URLのリクエスト本文からパラメータの割当てを解除するには、「完了基準の指定」ページに移動します。「Polling」または「Termination」タブで、「Request」を選択します。
「パラメータの削除」をクリックします。
「パラメータの削除」ダイアログで、「削除」をクリックします。

パラメータは、リクエスト本文から割り当て解除されます。パラメータに割り当てられていたリクエスト本文が、デフォルトのリクエスト本文になります。

ノート

パラメータはRESTタスクから削除されません。パラメータを削除するには、RESTタスク・パラメータの削除を参照してください。

Oracle Cloud Infrastructureドキュメント

リクエスト本文の指定