Define available query parameters

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 1 minute de lecture

    • Define available query parameters to control what values a requesting user can pass in the request URI.

    Avant de commencer

    Role required: web_service_admin

    Procédure

    1. Navigate to All > System Web Services > Scripted REST APIs.
    2. Select a scripted REST API record.
    3. In the Query Parameters related list, select New.
    4. Specify the Query parameter name.
    5. Enter a Short description and Example value to explain how to use the parameter.
    6. Select Submit.
    7. Facultatif : From the Query Parameters tab, locate the query parameter and set Is required to "true" to document this query parameter as required.
      Remarque :
      If you set Is required to "true", the scripted REST service doesn't enforce requiring the parameter. To enforce requiring a query parameter, you must add logic to the scripted REST API resource that rejects requests that are missing the required parameters.

    Que faire ensuite

    After defining available query parameters, associate the parameters to a scripted REST resource. For details, see Associate query parameters to a resource.