Create a scripted REST API resource

Create a scripted REST API resource to define the HTTP method, the processing script, and to override settings from the parent service.

Before you begin

There must be a scripted REST API defined before you can create resources.

Role required: web_service_admin

About this task

By default, any new Scripted REST API resource you create contains an ACL that prohibits users with the snc_external role from making requests to the API.

Procedure

1. Navigate to All > System Web Services > Scripted REST APIs.
2. Select a scripted REST API record.
3. In the Resources related list, click New.
4. Enter a Name.
   The resource name affects the URI for sending requests to the API.
5. Select the HTTP method this resource implements, such as GET.
6. In the Script field, define how the operation parses and responds to requests.
7. Optional: Override settings from the parent REST API as needed, such as by specifying different security settings or valid content types.
8. Optional: On the Documentation tab, provide a Short description explaining how to access the resource.
   This information appears when exploring this resource using the REST API Explorer.
9. Click Submit.

What to do next

After creating the resource, you can associate headers and query parameters. For details, see Define scripted REST API headers and Define available query parameters.