---
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 an API resource request structure

# Define an API resource request structure {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read  
Add a schema to a REST request record to define the request's expected data structure.{#add-schema-rest-api-request__patch-rn-ap1-1}

## Before you begin

You must define at least one REST API resource and at least one schema in the REST API before defining the request structure.

Role required: web_service_admin

## About this task

The following procedure describes the process for manually adding a request schema to a resource. For details about automatically generating request schema definitions 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 a new REST Request record in one of the following ways.  
   If you navigate through a scripted REST API record, most fields in the REST Request record are pre-populated.

   | Option | Procedure |
   | Navigate through a scripted REST API record | 1. Navigate to AllSystem Web ServicesScripted REST APIs. 2. Select a scripted REST API record. 3. In the Resources related list, select a resource. 4. In the Request Schema tab, select New. |
   | Navigate directly to a new REST Request record | 1. Navigate to AllFilter and enter <kbd class="ph userinput">sys_ws_request_spec.form</kbd>. 2. In the API field, select an API. 3. In the API resource field, select the API resource whose request schema you want to specify. 4. In the Version field, select the API resource version. 5. In the Http method field, select the method whose request schema you want to specify (for example, PUT). {#add-schema-rest-api-request__ol_nth_hrc_l3c} |
   |-|-|

   {#add-schema-rest-api-request__choicetable_ehs_g3d_j3c}
2. In the Schema field, find or enter the schema you want to define the structure and format of the resource's request body.
3. In the Description field, summarize the expected format of the REST request.
4. Select Submit.

## Result

The schema you used to define the request body structure is included in the exportable OpenAPI specification in the REST API Explorer. For more information about exporting OpenAPI specifications, see [Export to OpenAPI specification](https://servicenow-prod.fluidtopics.net/VM1BPwWaXiyDxp0N9N0zPg "Export a REST API as an OpenAPI specification to import it into another web services tool.").

*[\>]: and then