Define available query parameters to control what values a requesting user can pass
in the request URI.
Antes de Iniciar
Role required: web_service_admin
Procedimento
-
Navigate to .
-
Select a scripted REST API record.
-
In the Query Parameters related list, select New.
-
Specify the Query parameter name.
-
Enter a Short description and Example
value to explain how to use the parameter.
-
Select Submit.
- Opcional:
From the Query Parameters tab, locate the query parameter and set Is required to "true" to document this query parameter as required.
Nota: 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.
O que Fazer Depois
After defining available query parameters, associate the parameters to a scripted
REST resource. For details, see Associate query parameters to a resource.