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

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Define available query parameters

# Define available query parameters {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](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

## About this task

The following procedure describes the process for manually defining query parameters for a scripted REST API service. For details about automatically generating query parameters for requests in non-production instances, see [Automatically generate API request definitions](https://servicenow-prod.fluidtopics.net/PMIDsmNMHbcgTE5adyjmIg "Use sample requests made to an API resource to generate request header associations, query parameter associations, and a request schema for that resource.").

## 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 with a resource](https://servicenow-prod.fluidtopics.net/X57ZMJkir~7SPKLhzBBJcg "Associate scripted REST API query parameters with a resource.").

*[\>]: and then