API リソース応答構造の定義

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：2分

    • スキーマと関連する応答ヘッダーを REST 応答に追加して、応答で想定されるデータ構造を定義します。

    始める前に

    関連する REST API で使用するには、少なくとも 1 つの REST API リソースと少なくとも 1 つのスキーマが既に定義されている必要があります。使用する応答ヘッダーも定義する必要があります。詳細については、「REST API 応答ヘッダーの定義」を参照してください。

    必要なロール：web_service_admin

    手順

    1. 次のいずれかの方法で、新しい REST 応答レコードに移動します。
      スクリプト化された REST API レコード内を移動する場合、REST 応答レコードのほとんどのフィールドは事前に入力されています。
      オプション手順
      スクリプト化された REST API レコード内を移動する
      1. 移動先 すべて > システム Web サービス > スクリプト化 REST API.
      2. スクリプト化された REST API レコードを選択します。
      3. [ リソース] 関連リストで、リソースを選択します。
      4. [ 応答スキーマ ] タブで、[ 新規] を選択します。
      REST 応答レコードに直接移動する
      1. 移動先 すべて > フィルター 「 sys_ws_response_spec.form」と入力します。
      2. [ API ] フィールドで、API を選択します。
      3. [ API リソース ] フィールドで、応答形式を指定する API リソースを選択します。
      4. [ HTTP メソッド ] フィールドで、応答形式を指定するメソッド (GET など) を選択します。
      5. [バージョン] フィールドで、API リソースバージョンを選択します。
    2. [HTTP ステータス] フィールドに、REST 応答仕様が適用される HTTP ステータスを入力します (例:200)。
      たとえば、「200」と入力して ABC ステータスを返します。
    3. [ スキーマ] フィールドで、リソースの選択した HTTP ステータス、バージョン、およびメソッドの構造と形式を定義するスキーマを検索または入力します。
    4. オプション: API に関連付けられた関連する応答ヘッダーを追加します。
      1. [応答ヘッダーのロック解除 (Unlock Response Headers)] アイコン を選択します。
      2. API に関連付けられた関連する応答ヘッダーを検索または入力します。
    5. [ 説明] フィールドで、想定される REST 応答の形式を要約します。
    6. [送信] を選択します。

    タスクの結果

    応答本文構造の定義に使用したスキーマは、REST API エクスプローラーのエクスポート可能な OpenAPI 仕様に含まれています。OpenAPI 仕様のエクスポートの詳細については、「 OpenAPI 仕様にエクスポート」を参照してください。