SimpleRequest

This class allows to perform access scripted REST API request details in scripts.

body

The body of the request.

Name	Type	Mandatory
body	Array	Y

Example:

body

[
   'sys_id' => '1234567890',
   'name' => 'incident'
]

getHeader

Returns the value of the header specified.

Name	Type	Mandatory
getHeader	String	Y

Example:

getHeader

const acceptHeader = request.getHeader('accept');

headers

This method allows defining all request headers and their values.

Name	Type	Mandatory
headers	Array	Y

Example:

headers

[
   'content-type' => 'Application/json'
]

queryParams

The query parameters from the request.

Field	Type
queryParams	Array

Example:

Source request URL: https://instance.simpleone.ru/api/now/table/myTable?active=false&name=now
[
   'active' => false
   'name' => 'now'
]

queryString

The entire query added to the endpoint URL

Field	Type	Mandatory
queryString	Array	Y

Example:

Source request URL: https://instance.simpleone.ru/api/now/table/myTable?active=false&name=now
[
   active=false&name=now
]

uri

The request URI with the domain information excluded.

Field	Type	Mandatory
uri	String	Y

Example:

URI

const query = request.uri; //"api/now/table/myTable"	
Source request URL: https://instance.simpleone.ru/api/now/table/myTable?active=false&name=now.

url

The entire request URL.

Field	Type
url	String

Example:

URL

const query = request.url; //"https://instance.simpleone.ru/api/now/table/myTable?active=false&name=now"
Source request URL: https://instance.simpleone.ru/api/now/table/myTable?active=false&name=now.

Page tree

SimpleRequest

body

headers

queryParams

queryString

uri

url