Define available query parameters

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

Before you begin

Role required: web_service_admin


  1. Navigate to System Web Services > Scripted REST APIs.
  2. Select a scripted REST API record.
  3. In the Query Parameters related list, click New.
  4. Specify the Query parameter name.
  5. (Optional) Select Is required to make this parameter mandatory for all requests to associated scripted REST resources.
  6. Enter a Short description and Example value to explain how to use the parameter.
  7. Click Submit.

What to do next

After defining available query parameters, associate the parameters with a scripted REST resource.