Associate a request header with a resource

Define which request headers are expected for each resource within a scripted REST API.

Before you begin

A REST API resource and a request header must already be defined within the scripted REST API.

Role required: web_service_admin

About this task

The following procedure describes the process for manually associating a REST API request header with a resource. For details about automatically generating request header definitions in non-production instances, see Automatically generate API request definitions.

Procedure

1. Create a Scripted REST Header Association record in one of the following ways

<table id=“choicetable_fv4_myc_j3c”><thead><tr><th align=“left” id=“d317164e67”>

Option

</th><th align=“left” id=“d317164e70”>

Procedure

</th></tr></thead><tbody><tr><td id=“d317164e76”>

Navigate through a scripted REST API record

</td><td>

1. Navigate to All > System Web Services > Scripted REST APIs.

2. Select a scripted REST API record.

3. In the Resources related list, select a resource.

4. In the Request Header Associations tab, select New.

</td></tr><tr><td id=“d317164e121”>

Navigate directly to a new Scripted REST Header Association record

</td><td>

Navigate to All > Filter and enter sys_ws_header_map.form.

</td></tr></tbody> </table>2. In the API request header field, select or enter the request header to associate with the resource.

1. In the API resource field, select or enter the API resource the request header should be associated with.

   If you navigated to a new Scripted REST Header Association record through a scripted REST API record, API resource is pre-populated.

2. Select Submit.

Result

The request headers that you added are included in the exportable OpenAPI specification in the REST API Explorer with a “type: string” schema definition. For more information about exporting OpenAPI specifications, see Export to OpenAPI specification.

Parent Topic:Create a scripted REST API