Create a scripted REST API

Create a scripted REST API to define web service endpoints.

Before you begin

Role required: web_service_admin

About this task

By default, scripted REST APIs contain 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. Click New.
3. Enter a Name for the service.
   The API ID is set automatically based on the Name. You can modify the API ID if needed.
4. Click Submit.

What to do next

After you create the API, configure the service as needed such as by creating resources, assigning ACLs, or specifying supported request and response formats.

• 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.
• Define a REST API response header
  Define one or more REST API response headers in a REST API.
• Define a scripted REST API request header
  Define scripted REST API request headers to control which headers the API accepts.
• Associate a request header with a resource
  Define which request headers are expected for each resource within a scripted REST API.
• Define a REST API schema
  Specify the expected data structure for requests or responses within a REST API by defining a schema.
• Define an API resource request structure
  Add a schema to a REST request record to define the request's expected data structure.
• Define an API resource response structure
  Add a schema and relevant response headers to a REST response to define the response's expected data structure.
• Define available query parameters
  Define available query parameters to control what values a requesting user can pass in the request URI.
• Associate query parameters with a resource
  Associate scripted REST API query parameters with a resource.
• 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.
• Configure a scripted REST API to require an ACL
  Requests to scripted REST APIs respect platform ACLs, and the requesting user must meet any table ACL requirements to access instance data. Additionally, you can configure the scripted REST API to require a specific ACL.
• Enable versioning for a scripted REST API
  Enable versioning for a scripted REST API to provide multiple versions of the API while maintaining compatibility with existing integrations.
• Control request and response content type
  Controls which content types are allowed in scripted REST API requests and responses.
• Controlling maximum request size
  You can specify the maximum file size allowed in a scripted REST API request payload.