REST API 応答ヘッダーの定義
REST API で 1 つ以上の REST API 応答ヘッダーを定義します。
始める前に
必要なロール:web_service_admin
手順
-
次のいずれかの方法で REST 応答ヘッダーを作成します。
オプション 手順 REST API からの応答ヘッダーの作成 - 移動先 .
- スクリプト化された REST API レコードを選択します。
- [ 応答ヘッダー ] 関連リストで、[ 新規] を選択します。
応答ヘッダーを作成して REST API に関連付ける 移動先 「 sys_ws_response_header.form」と入力します。 - フィルターナビゲーターに 「sys_ws_response_header.form 」と入力します。
- [ API ] フィールドで、応答ヘッダーに関連付ける API を選択または入力します。
- [ ヘッダー名 ] フィールドに、新しいヘッダーの名前を追加します。
- [ サンプル値] フィールドに、有効なヘッダー値の例を入力します。
- [送信] を選択します。
- 定義する応答ヘッダーごとにこれらの手順を繰り返します。
タスクの結果
追加した応答ヘッダーは、REST API エクスプローラーのエクスポート可能な OpenAPI 仕様に、「文字列スキーマ定義 」 タイプで含まれています。OpenAPI 仕様のエクスポートの詳細については、「 OpenAPI 仕様にエクスポート」を参照してください。