利用可能なクエリパラメーターを定義

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

    • 利用可能なクエリパラメーターを定義して、要求ユーザーが要求 URI で渡すことができる値を制御します。

    始める前に

    必要なロール：web_service_admin

    このタスクについて

    次の手順では、スクリプト化された REST API サービスのクエリパラメーターを手動で定義するプロセスについて説明します。非本番インスタンスでの要求のクエリパラメーターの自動生成の詳細については、「 API 要求定義の自動生成」を参照してください。

    手順

    1. 移動先 すべて > システム Web サービス > スクリプト化 REST API.
    2. スクリプト化された REST API レコードを選択します。
    3. [ クエリパラメーター ] 関連リストで、[ 新規] を選択します。
    4. クエリパラメーター名を指定します。
    5. パラメーターの使用方法を説明する簡単な 説明 と サンプル値 を入力します。
    6. [送信] を選択します。
    7. オプション: [クエリパラメーター] タブでクエリパラメーターを見つけ、[ 必須] を「true」に設定して、必要に応じてこのクエリパラメーターを文書化します。
      注:
      [ 必須] を「true」に設定すると、スクリプト化された REST サービスはパラメーターを強制しません。クエリパラメーターを強制的に要求するには、必須パラメーターがない要求を拒否するロジックをスクリプト化された REST API リソースに追加する必要があります。

    次のタスク

    使用可能なクエリパラメーターを定義したら、スクリプト化された REST リソースにパラメーターを関連付けます。詳細については、「クエリパラメーターをリソースに関連付ける」を参照してください。