---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Define available query parameters

# Define available query parameters {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

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

## Procedure

1. Navigate to AllSystem Web ServicesScripted 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. **Optional:** From the Query Parameters tab, locate the query parameter and set Is required to "true" to document this query parameter as required.  
   Note:  
   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.
{#t_DefineAvailableQueryParameters__steps_qjh_5b4_bs}

## What to do next

After defining available query parameters, associate the parameters to a scripted REST resource. For details, see [Associate query parameters to a resource](https://servicenow-prod.fluidtopics.net/3QrT4NUl_GZIKESnEcriIQ "Associate scripted REST API query parameters to a resource.").

*[\>]: and then