Versions Compared

Old Version 16

changes.mady.by.user Igor Shakhbazyan

Saved on

compared with

New Version Current

changes.mady.by.user Igor Shakhbazyan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Merged branch "feedback" into parent

This class allows to perform access scripted Methods of this class allow getting access to the Scripted REST API request details in within your scripts. 

body

The body of the request.

Note

Objects of this type cannot be instantiated and created automatically. They are accessible within the API action script body by the request variable. 

For more information, please refer to the Configuring Scripted REST API article.

getBody()

This method allows returning the request body.


Return:

TypeDescription
ObjectThe body of the request. 

Name

TypeMandatoryDefault value bodySimpleApiRequest objectYN


Example:

Code Block
languagejs
themeEclipse
titlebodygetBody
linenumberstrue
const bodyValue = {(function(request, response) {
    // Send JSON-formatted request to
    "sys_id": "156950788916212912",
    "name": "LDAP Property"
};
getHeader
// https://your-instance-url.simpleone.ru/v1/c_simple/api_module_path/api_action_path

    const requestBody = request.getBody(); // {"key":"value"}
})(SimpleApiRequest, SimpleApiResponse)

getHeader(header)

Returns the value of the header specified.


Parameters:

NameTypeMandatoryDefault value
getHeaderheaderStringYN


Return:

TypeDescription
StringThis method returns the specified header value.

Re

 For more clarity, check the example below

Example:

Code Block
languagejs
themeEclipse
titlegetHeader
linenumberstrue
const acceptHeader(function(request, response) {
    // Send JSON-formatted request to
    // https://your-instance-url.simpleone.ru/v1/c_simple/api_module_path/api_action_path

    const contentType = request.getHeader("accept");
headers
'content-type'); // application/json
})(SimpleApiRequest, SimpleApiResponse)


getHeaders()

This method allows defining all request headers and their values.

Name


Return:

TypeDescription
MandatoryheadersSimpleRequest objectY
Array of strings This method returns array of strings containing all request headers.


Example:

Code Block
languagejs
themeEclipse
titleheadersgetHeaders
linenumberstrue
const headerValue = {
   content-type: "application/json"
};

queryParams

(function(request, response) {
    // Send Request to 
    // https://your-instance-url.simpleone.ru/v1/c_simple/api_module_path/api_action_path

    const allHeaders = request.getHeaders(); // {"accept-encoding":["gzip, deflate, br"],"postman-token":...}
})(SimpleApiRequest, SimpleApiResponse)


getQueryParams()

This method returns the The query parameters from the request.

Field


Return:

Mandatory
TypeDescriptionDefault value
queryParamsSimpleRequest objectYN
Array This method returns array of values containing query parameters. 


Example:

Code Block
languagejs
themeEclipse
titlequeryParamsgetQueryParams
linenumberstrue
(function(request, response) {
    // Source request URL:Send Request to 
    // https://your-instance-url.simpleone.ru/apiv1/now/table/myTable?active=false&name=now
const queryParams = {c_simple/api_module_path/api_action_path?param_1=value_1

    "active": false,
    "name": "now"
};

queryString

const queryParamsObject = request.getQueryParams(); // {"param_1":"value_1"}
})(SimpleApiRequest, SimpleApiResponse)


getQueryString()

This method returns the The entire query added to the endpoint URL.

Field


Return:

TypeMandatoryDefault value
queryStringSimpleApiRequest objectYN

Example:

Description
StringThis method return a query string.


Example:

Code Block
languagejs
themeEclipse
titlegetQueryParams
(function(request, response) {
    // Send Request to 
    //
Code Block
// Source request URL: https://your-instance-url.simpleone.ru/apiv1/now/table/myTable?active=false&name=now
const queryValue = {
   "query": "active=false&name=now"
};

uri

c_simple/api_module_path/api_action_path?param_1=value_1

    const queryParamsString = request.getQueryString(); // param_1=value_1
})(SimpleApiRequest, SimpleApiResponse)


getUri()

This method returns the The request URI with the domain information excluded.

Field


Return:

Type
Mandatory
Description
Default valueuri
String
YN
or NullThis method returns the request URI. If no path has been passed after the domain name, then the method returns 'null'


Example:

Code Block
languagexmljs
themeEclipse
titleURIgetUri
linenumberstrue
(function(request, response) {
    // Source request URL: Send Request to 
    // https://your-instance-url.simpleone.ru/apiv1/now/table/myTable?active=false&name=now
const queryc_simple/api_module_path/api_action_path?param_1=value_1

    const URI = request.uri;getUri(); // /v1/"api/now/table/myTable"

url

c_simple/api_module_path/api_action_path
})(SimpleApiRequest, SimpleApiResponse)


Code Block
languagejs
themeEclipse
titlegetUri
linenumberstrue
(function(request, response) {
    // Send Request to 
    // https://your-instance-url.simpleone.ru/

    const URI = request.getUri(); // null
})(SimpleApiRequest, SimpleApiResponse)


getUrl()

This method returns the The entire request URL.

Field


Return:

Type
Mandatory
Description
Default valueurl
String
YN
This method returns the request URL.


Example:

Code Block
languagexmljs
themeEclipse
titleURLgetUrl
linenumberstrue
(function(request, response) {
    // Source request URL:Send Request to 
    // https://your-instance-url.simpleone.ru/v1/api/now/table/myTable?active=false&name=now
const queryc_simple/api_module_path/api_action_path?param_1=value_1

    const URL = request.urlgetUrl(); //"https http://your-instance-url.simpleone.ru/apiv1/now/table/myTable?active=false&name=now"c_simple/api_module_path/api_action_path
})(SimpleApiRequest, SimpleApiResponse)


Table of Contents
absoluteUrltrue
classfixedPosition