Rest Api Explorer

Path-based Access Control Levels (ACLs) enable you to define access control rules for scripted REST API endpoints using their resource path. This can be done independently of the ACL references on the operation record. Path-based ACLs enable more flexible security configurations, especially for read-only APIs and guest user experiences.

Add a schema to a REST request record to define the request's expected data structure.

Add a schema and relevant response headers to a REST response to define the response's expected data structure.

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

Associate scripted REST API query parameters with a resource.

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

The scripted REST API feature allows application developers to build custom web service APIs.

REST (REpresentational State Transfer) is a simple stateless architecture that provides standards between computer systems on the web, making it easier for them to communicate with each other.

Mutliple examples are available demonstrating how to create and use scripted REST APIs.

Controls which content types are allowed in scripted REST API requests and responses.

Create rate limit rules to limit the number of inbound REST API requests processed per hour.

You can debug in-bound REST queries by reviewing the session debug log.

Define one or more REST API response headers in a REST API.

Specify the expected data structure for requests or responses within a REST API by defining a schema.

You can explore the REST API for a table directly from that table. Explore the API using the REST API Explorer to quickly construct and test REST requests for that table.

Export a REST API as an OpenAPI specification to import it into another web services tool.

Update the incident record using either a PUT or PATCH function.

To prevent excessive inbound REST API requests, set rules that limit the number of inbound REST API requests processed per hour. You can create rules to limit requests for specific users, users with specific roles, or all users.

Investigate rate limit violations to determine which rate limit rules are being exceeded and which users are exceeding those rate limits.

To determine if you have set a rate limit rule appropriately, monitor the counts and violations for inbound REST API requests that are restricted by the rule.

You can specify the maximum file size allowed in a scripted REST API request payload.

When you define a cross-origin resource sharing (CORS) rule, the value you enter in the Domain field must meet certain requirements. Each CORS rule supports a single wildcard to match incoming Origin headers.

REST messages sent to an instance return a specific HTTP response code.

This example shows how to authenticate an inbound REST request using OAuth.

This example demonstrates how to send an image attachment to a requesting user as a binary stream.

These examples demonstrate how to send a JSON response using streaming and using default object serialization.

These examples demonstrate how to create various resource scripts for a scripted REST API.

Reset a rate limit rule to reset the rate limit count to zero (0) and delete any violations for the current hour.

You can include session debug logs in a REST response body by passing the X-WantSessionDebugMessages header in the request.

Follow these guidelines when designing and implementing scripted REST APIs.

Add a new version to a versioned scripted REST API to define new API behavior without impacting older versions.

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

Create a scripted REST API to define web service endpoints.

You can define a CORS rule to control which domains can access REST API endpoints and other web resources.

Define available query parameters to control what values a requesting user can pass in the request URI.

Define scripted REST API request headers to control which headers the API accepts.

Using OAuth, you can pass a user ID and password once, and then use a token for subsequent REST requests instead of submitting credentials with each request.

Enable versioning for a scripted REST API to provide multiple versions of the API while maintaining compatibility with existing integrations.

View available REST API resources using the REST API Explorer.

Use a POST request to create a new record.

Delete the incident using a DELETE request.

Use a GET request to view a record.

Use a GET request to view existing incident records.

By default, API resources/endpoints inherit security settings from the parent API. Define custom Access Control Levels (ACLs) for a specific resource/endpoint to override the inherited settings.

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.

In this tutorial you will use the REST API Explorer to test the ServiceNow REST APIs.

Path-based Access Control Levels (ACLs) enable you to define access control rules for scripted REST API endpoints using their resource path. This can be done independently of the ACL references on the operation record. Path-based ACLs enable more flexible security configurations, especially for read-only APIs and guest user experiences.

Path-based Access Control Levels (ACLs) enable you to define access control rules for scripted REST API endpoints using their resource path. This can be done independently of the ACL references on the operation record. Path-based ACLs enable more flexible security configurations, especially for read-only APIs and guest user experiences.