Scripted REST API URIs

Scripted REST API URIs depend on the namespace and API ID, and optionally the version, of the web service.

The API URI, excluding the instance URL, appears in the Resource path and Default resource path fields for scripted REST resource records. The Default resource path field appears only for resources with the default API version.
URIs used by Scripted REST APIs follow these formats:
In these URIs:
  • (name_space) is a read-only value. For web services in the global scope, the name space is the value of the property For web services in a scoped application, the name space is the scope name, such as x_company_appname.
  • (api_id) is the value of the API ID field on the scripted REST API record. By default this value is based on the service name.
  • (resource_path) is the relative path defined for the resource. Specifying a relative resource path allows you to have multiple resources using the same HTTP method, such as GET, in one web service. For example, an resource may specify the path /{id} when the web service has only one GET resource, or /user/{id} and /message/{id} when the web service has different resources for requesting user and message records.
  • (version) is the version of the API to access if the API uses versioning, such as v1. You can access the default version of a versioned API by using the URI without a version number.