📁 Scripted REST API (Developer Documentation)

Question 1

When do Security, Content Negotiation, and Documentation sections become available in the context of ServiceNow Scripted REST API’s?

Answer 1

They become available after saving for the first time.

Question 2

What is something important to remember about Scripted REST API Access Control checks?

Answer 2

A requesting user must satisfy at least one of the Access Controls, but it is not necessary to satisfy all selected Access Controls

Question 3

What Access Control type do Access Controls for Scripted REST APIs have?

Answer 3

REST_Endpoint

Question 4

What is the default Access Control applied to all new Scripted REST APIs?
& Who does this default Access Control deny access to the Scripted REST API?

Answer 4

Scripted REST External Default
Developers can remove the default and/or add Access Controls of their choice.

& The default Access Control denies access to the Scripted REST API to any user with the snc_external role.

Question 5

What does the Content Negotiation section of a Scripted REST API define?

Answer 5

The Content Negotiation section defines the supported request and response formats.

The default for the request and response is to allow:
- application/json
- application/xml
- text/xml

Question 6

What does the Documentation section do in the context of Scripted REST APIs?

Answer 6

Helps to direct users, with links, towards ServiceNow documentation that can better explain the APIs and methods used.

Question 7

What does a REST request header contain?
&
What are some commonly used ones?

Answer 7

REST request headers contain parameters (metadata) that defines the HTTP(S) interaction.
&
Some commonly used ones include
- Authorization
- Accept
- Content-Type

Question 8

What do Query parameters do in the context of REST request headers?

Answer 8

Query parameters control what information developers using the API can pass in the API request URL.

Question 9

What are the formatting conventions surrounding Query parameter names in Scripted REST APIs?

Answer 9

By convention, query parameter names are lowercase and use underscores in place of spaces.

Question 10

What string do many query parameters in baseline ServiceNow Scripted REST APIs start with?

Answer 10

sysparm_

Question 11

A REST API is a collection of REST resources.
What are REST resources?

Answer 11

REST resources are unique data representations that have at least one URI
Resources are typically a set of related information, such as a record, changes to a record, or calculations based on records. An HTTP method defines each resource
GET, POST, PUT, PATCH, DELETE

Question 12

Where are Scripted REST API resources found and created?

Answer 12

There is a Resources related list on the Scripted REST API entry.

Question 13

What is something important to remember about Scripted REST API Resources in regards to Security, Content, and Documentation sections?

Answer 13

Resources inherit settings from the Scripted REST API but these setting can be overridden.

Question 14

Request headers are defined in the Scripted REST API, but how are they associated with Scripted REST API Resources?

Answer 14

They are associated with resources in the resource definitions.
To associate a request header, scroll to the Request Header Associations related list. Click the New button. Use the API request header field Search button to select a request header to associate with the resource.

Question 15

Query parameters are defined in the Scripted REST API, but how are they associated with Scripted REST API Resources?

Answer 15

To associate a query parameter, scroll to the Query Parameter Associations related list. Click the new button. Use the API query parameter field Search button to select a query parameter to associate with the resource.

Question 16

What does the RESTAPIRequest API allow developers to do?

Answer 16

The RESTAPIRequest API allows developers to access data from the request. The request object is automatically instantiated from the RESTAPIRequest class and passed to the process function in the Scripted REST API script.

Question 17

What are the properties of the request object in the context of the RESTAPIRequest API?

Answer 17

• body
• pathParams
• queryParams
• queryString
• uri
• url
• headers
• getHeader()
• getSupportedResponseContentTypes()

Question 18

What is a resource script?

Answer 18

A server-side JavaScript that creates and populates properties on the response object.
The response object is returned to the application that invoked the resource.

Question 19

When working with the RESTAPIRequest API, what does the body object do?

Answer 19

It provides access to the request body.

Question 20

When working with the RESTAPIRequest API, what does the pathParams object do?

Answer 20

Allows script access to path parameters passed in the requested URL. The available path parameters are determined by the Scripted REST Service resources.

Question 21

When working with the RESTAPIRequest API, what does the queryParams object do?

Answer 21

Allows script access to the query parameters from the web service request.

Question 22

When working with the RESTAPIRequest API, what does the queryString string contains ?

Answer 22

It contains the entire query added to the endpoint URI.

Question 23

When working with the RESTAPIRequest API, what does the URI string contain?

Answer 23

It contains the request URI, excluding domain information.

Question 24

When working with the RESTAPIRequest API, what does the URL string contain?.

Answer 24

It contains the entire request URL.

Question 25

When working with the RESTAPIRequest API, what does the headers object do?

Answer 25

It contains all header property value pairs from the request.

Question 26

What class is the getHeader() method associated with?

Answer 26

RESTAPIRequest

Question 27

What does the getHeader() method do?

Answer 27

It returns a string containing the value of a specific header from the web service request.

Question 28

What class is the getSupportedResponseContentTypes() method?

Answer 28

RESTAPIRequest

Question 29

What does the getSupportedResponseContentTypes() method do?

Answer 29

Returns an array of string values where each string is a content type, such as application/json

Question 30

What does the RESTAPIRequestBody API allow developers to do?

Answer 30

Allows developers to access the body content of a scripted REST API request. The request.body object is instantiated automatically.

Question 31

What class is the hasNext() method associated with?

Answer 31

RESTAPIRequestBody

Question 32

What does the hasNext() method do?

Answer 32

Returns true if the request body contains another entry

Question 33

What class is the nextEntry() method associated with?

Answer 33

RESTAPIRequestBody

Question 34

What does the nextEntry() method do?

Answer 34

Retrieves one entry from the request body as a script object.

Question 35

What does the RESTAPIResponse API allow developers to do?

Answer 35

Allows developers to build a response to a scripted REST API request. The response object is instantiated automatically.

Question 36

In the context of the RESTAPIRequestBody API, what is dataStream?

Answer 36

dataStream: The content of the request body as a stream.

Question 37

In the context of the RESTAPIRequestBody API, what is dataString?

Answer 37

dataString: The content of the request body as a string.

Question 38

What class is the getStreamWriter() method associated with?

Answer 38

RESTAPIResponse

Question 39

What does the getStreamWriter() method do?

Answer 39

Used to write directly to the response stream.

Question 40

What class is the setBody() method associated with?

Answer 40

RESTAPIResponse

Question 41

What does the setBody() method do?

Answer 41

Creates the response body, as a javascript object. The body content is automatically serialized to JSON or XML depending on the value of the Accept header, passed in the request.

Question 42

What class is the setContentType() method associated with?

Answer 42

RESTAPIResponse

Question 43

What does the setContentType() method do?

Answer 43

Assigns a value, such as application/json, to the Content-Type header in the web service response.

Question 44

What class is the setError() method associated with?

Answer 44

RESTAPIResponse

Question 45

What does the setError() method do?

Answer 45

Sets the properties of the response error object when an error is returned.

Question 46

What class is the setHeader() method associated with?

Answer 46

RESTAPIResponse

Question 47

What does the setHeader() method do?

Answer 47

Assigns a value to a REST service response header.

Question 48

What class is the setHeaders() method associated with?

Answer 48

RESTAPIResponse

Question 49

What does the setHeaders() method do?

Answer 49

Sets the headers for the web service response

Question 50

What class is the setLocation() method associated with?

Answer 50

RESTAPIResponse

Question 51

What does the setLocation() method do?

Answer 51

Assigns a value to the Location header in the web service response.

Question 52

What class is the setStatus() method associated with?

Answer 52

RESTAPIResponse

Question 53

What does the setStatus() method do?

Answer 53

Sets the status code to send in the response, such as 200 to indicated success.

Question 54

What are some important things to remember about resource scripts?

Answer 54

- The *process* function is self-invoking - The *request* and *response* objects are automatically instantiated - Access controls apply to Scripted REST APIs. The user making the request through the APIs authentication must have access to the requested information.