📁 Scripted REST API (Developer Documentation) Flashcards
When do Security, Content Negotiation, and Documentation sections become available in the context of ServiceNow Scripted REST API’s?
They become available after saving for the first time.
What is something important to remember about Scripted REST API Access Control checks?
A requesting user must satisfy at least one of the Access Controls, but it is not necessary to satisfy all selected Access Controls
What Access Control type do Access Controls for Scripted REST APIs have?
REST_Endpoint
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?
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.
What does the Content Negotiation section of a Scripted REST API define?
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
What does the Documentation section do in the context of Scripted REST APIs?
Helps to direct users, with links, towards ServiceNow documentation that can better explain the APIs and methods used.
What does a REST request header contain?
&
What are some commonly used ones?
REST request headers contain parameters (metadata) that defines the HTTP(S) interaction.
&
Some commonly used ones include
- Authorization
- Accept
- Content-Type
What do Query parameters do in the context of REST request headers?
Query parameters control what information developers using the API can pass in the API request URL.
What are the formatting conventions surrounding Query parameter names in Scripted REST APIs?
By convention, query parameter names are lowercase and use underscores in place of spaces.
What string do many query parameters in baseline ServiceNow Scripted REST APIs start with?
sysparm_
A REST API is a collection of REST resources.
What are REST resources?
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
Where are Scripted REST API resources found and created?
There is a Resources related list on the Scripted REST API entry.
What is something important to remember about Scripted REST API Resources in regards to Security, Content, and Documentation sections?
Resources inherit settings from the Scripted REST API but these setting can be overridden.
Request headers are defined in the Scripted REST API, but how are they associated with Scripted REST API Resources?
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.
Query parameters are defined in the Scripted REST API, but how are they associated with Scripted REST API Resources?
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.
What does the RESTAPIRequest API allow developers to do?
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.
What are the properties of the request object in the context of the RESTAPIRequest API?
- body
- pathParams
- queryParams
- queryString
- uri
- url
- headers
- getHeader()
- getSupportedResponseContentTypes()
What is a resource script?
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.
When working with the RESTAPIRequest API, what does the body object do?
It provides access to the request body.
When working with the RESTAPIRequest API, what does the pathParams object do?
Allows script access to path parameters passed in the requested URL. The available path parameters are determined by the Scripted REST Service resources.
When working with the RESTAPIRequest API, what does the queryParams object do?
Allows script access to the query parameters from the web service request.
When working with the RESTAPIRequest API, what does the queryString string contains ?
It contains the entire query added to the endpoint URI.
When working with the RESTAPIRequest API, what does the URI string contain?
It contains the request URI, excluding domain information.
When working with the RESTAPIRequest API, what does the URL string contain?.
It contains the entire request URL.
When working with the RESTAPIRequest API, what does the headers object do?
It contains all header property value pairs from the request.
What class is the getHeader() method associated with?
RESTAPIRequest
What does the getHeader() method do?
It returns a string containing the value of a specific header from the web service request.
What class is the getSupportedResponseContentTypes() method?
RESTAPIRequest
What does the getSupportedResponseContentTypes() method do?
Returns an array of string values where each string is a content type, such as application/json
What does the RESTAPIRequestBody API allow developers to do?
Allows developers to access the body content of a scripted REST API request. The request.body object is instantiated automatically.
What class is the hasNext() method associated with?
RESTAPIRequestBody
What does the hasNext() method do?
Returns true if the request body contains another entry
What class is the nextEntry() method associated with?
RESTAPIRequestBody
What does the nextEntry() method do?
Retrieves one entry from the request body as a script object.
What does the RESTAPIResponse API allow developers to do?
Allows developers to build a response to a scripted REST API request. The response object is instantiated automatically.
In the context of the RESTAPIRequestBody API, what is dataStream?
dataStream: The content of the request body as a stream.
In the context of the RESTAPIRequestBody API, what is dataString?
dataString: The content of the request body as a string.
What class is the getStreamWriter() method associated with?
RESTAPIResponse
What does the getStreamWriter() method do?
Used to write directly to the response stream.
What class is the setBody() method associated with?
RESTAPIResponse
What does the setBody() method do?
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.
What class is the setContentType() method associated with?
RESTAPIResponse
What does the setContentType() method do?
Assigns a value, such as application/json, to the Content-Type header in the web service response.
What class is the setError() method associated with?
RESTAPIResponse
What does the setError() method do?
Sets the properties of the response error object when an error is returned.
What class is the setHeader() method associated with?
RESTAPIResponse
What does the setHeader() method do?
Assigns a value to a REST service response header.
What class is the setHeaders() method associated with?
RESTAPIResponse
What does the setHeaders() method do?
Sets the headers for the web service response
What class is the setLocation() method associated with?
RESTAPIResponse
What does the setLocation() method do?
Assigns a value to the Location header in the web service response.
What class is the setStatus() method associated with?
RESTAPIResponse
What does the setStatus() method do?
Sets the status code to send in the response, such as 200 to indicated success.
What are some important things to remember about resource scripts?
- 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.
