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

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

始める前に

必要なロール：web_service_admin

手順

1. 移動先 すべて > システム Web サービス > スクリプト化 REST API.
2. Scripted REST API レコードを選択します。
3. [ クエリパラメーター ] 関連リストで、[ 新規] を選択します。
4. [クエリーパラメーター名] を指定します。
5. [簡単な説明] と [例の値] を入力して、パラメーターの使用方法を説明します。
6. [Submit (送信)] を選択します。
7. オプション: [クエリパラメーター] タブでクエリパラメーターを見つけ、[ 必須] を [true] に設定して、必要に応じてこのクエリパラメーターを文書化します。
   注:

   Is required を "true" に設定した場合、スクリプト化された REST サービスでは、パラメーターの要求は強制されません。クエリパラメーターの要求を強制するには、必須パラメーターが欠落している要求を拒否するロジックをスクリプト化された REST API リソースに追加する必要があります。

次のタスク

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