Automatically generate API request definitions

Use sample requests made to an API resource to generate request header associations, query parameter associations, and a request schema for that resource.

Before you begin

An instance admin must set the system property glide.rest.sampling.enabled to true. To limit the likelihood of performance problems, only enable automatic generation of API request definitions in non-production instances.

Role required: web_service_admin

Procedure

1. Create a scripted REST API request sampling configuration in one of the following ways.

   Option	Procedure
   Navigate through a scripted REST API record	Navigate to All > System Web Services > Scripted REST Services > Scripted REST APIs. Select a scripted REST API record. In the Resources related list, select a resource. In the Request Sampling Configuration tab, select New.
   Navigate directly to a new scripted REST API request sampling configuration	Navigate to All > System Web Services > Scripted Web Services > Scripted REST Sampling Configurations. Select New. In the Rest resource field, select or enter the scripted REST resource to automatically generate request definitions for.

2. In the Max samples field, enter the number of sample requests to analyze for automatic definition generation.
   You must enter a number from 1 through 1000.
3. Select Submit.

   Requests made to the resource are sampled for analysis, up to the number of samples you set in step 5. After the maximum number of samples is reached, the request sampling configuration state is set to analyzed and REST request staging schemas are available for review.

   You can select Complete Sampling from the request sampling configuration record to end sampling before the maximum number of samples has been reached.

4. After sampling ends, return to the request sampling configuration you created by selecting its number from the Request Sampling Configuration tab of the scripted REST resource.
5. Select a record from the REST Request Staging Schemas list to review and edit the automatically generated request definitions in the Headers, Body, and Query parameters fields.
   Body structure is only generated for PUT and POST HTTP methods.
6. Select Commit to add the definitions to the scripted REST API resource and its associated scripted REST API service.

Result

• The committed REST request staging schema and the samples requests are deleted.
• Headers field content is used to create the resource's request header associations. The associated request headers are added to the relevant REST service's Request Headers tab.
• Body field content is used to create the resource's request schema. The resource's request schema is added to the relevant REST service's Schemas tab.
• Query parameters field content is used to create the resource's query parameter associations. The associated query parameters are added to the relevant REST service's Query Parameters tab.
• All committed request definitions that you added are included in the exportable OpenAPI specification in the REST API Explorer. For more information about exporting OpenAPI specifications, see Export to OpenAPI specification.