Page History

This server class allows operating with the REST API methods and parameters.

Tip
Change the REST_message_record text from the examples below to the record name of your REST message.

Tip
To know more about the sws object, please refer to the SimpleWS article.

SimpleRestRequestApi

SimpleRestRequest()

Initialises an empty SimpleRestRequestApi objectSimpleRestRequest object. When using such object, specify the method and the endpoint manually.

SimpleRestRequestApi

SimpleRestRequest(requestName, methodName)

Creates an instance of the SimpleRestRequestApi object SimpleRestRequest object using information from the REST message record. You need to have a REST record before using this constructor.

Name	Type	Mandatory	Default Value
requestName	String	Y	N
methodName	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	SimpleRestRequestApi

const sm = new sws.restRequestV1('REST_message_record', 'get')

execute()

Sends the REST message.

Return:

Type	Description
SimpleRestResponse	Response to the message sent by the execute() method.

Example:

Code Block

language	js
theme	Eclipse
title	execute

const sm = sws.restRequestV1('slack_platform', 'send_message');
      sm.setRequestBody(json_m);
      sm.execute();

setBasicAuth(userName, userPass)

Sets the username for web-service auth if the basic auth type was chosen.

Parameter(s):

Name	Type	Mandatory	Default Value
userName	String	Y	N
userPass	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setBasicAuth

const sm = new sws.restRequestV1('REST_message_record', 'get');
      sm.setBasicAuth('username', 'password');

setRequestUrl(requestUrl)

Sets the request URL.

Parameter(s):

Name	Type	Mandatory	Default Value
requestUrl	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setRequestUrl

const sm = new sws.restRequestV1('REST_message_record', 'get');
      sm.setRequestUrl(“url”);

setRequestMethod(methodName)

Sets the requesting method (GET, POST, PURGE, etc). Accepts the requesting method name.

Parameter(s):

Name	Type	Mandatory	Default Value
methodName	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setRequestMethod

const sm = new sws.restRequestV1('REST_message_record', 'get');
      sm.setRequestMethod('get');

setRequestTimeout(timeout)

Sets the response timeout until the request is out of time.

Parameter(s):

Name	Type	Mandatory	Default Value
timeout	Integer	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setRequestTimeout

const sm = new sws.restRequestV1('REST_message_record', 'get');
      sm.setRequestTimeout('60000');

setQueryParameter(name, value)

Adds a parameter into the end of the request URL generated as "name=value",

Parameter(s):

Name	Type	Mandatory	Default Value
name	String	Y	N
value	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setQueryParameter

const sm = new sws.restRequestV1('REST_message_record', 'get');
      sm.setQueryParameter('sysparm_query', 'active=true^ORDERBYDESCcategory');

setRequestBody(body)

Sets the request body when used PUT or POST methods.

Parameter(s):

Name	Type	Mandatory	Default Value
body	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setRequestBody

const sm = new sws.restRequestV1('REST_message_record', 'get');
let body = '<Message body content>';
      sm.setRequestBody(body);

setStringParameter(name, value)

Sets the request variable with the name specified from the record to the value specified.

Parameter(s):

Name	Type	Mandatory	Default Value
name	String	Y	N
value	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setStringParameter

const sm = new sws.RestRequest('<REST_request_record>','get'); 
      sm.setStringParameter('s','NOW');

setRequestHeader(name, value)

Sets the HTTP header in the request for the value specified.

Parameter(s):

Name	Type	Mandatory	Default Value
name	String	Y	N
value	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	setRequestHeader

const sm = new sws.restRequestV1('REST_message_record', 'get');
      sm.setRequestHeader('Accept', 'Application/json');

getRequestUrl()

Displays the request URL with parameters.

Return:

Type	Description
String	The request URl.

Example:

Code Block

language	js
theme	Eclipse
title	getRequestUrl

const sm = new sws.restRequestV1('REST_message_record', 'get');
const url = sm.getRequestUrl();

getRequestBody()

Returns the request body.

Return:

Type	Description
String	The request body.

Example:

Code Block

language	js
theme	Eclipse
title	getRequestBody

const sm = new sws.restRequestV1('REST_message_record', 'get');
let body = sm.getRequestBody();

getRequestHeaders()

Returns all the requested headers.

Return:

Type	Description
Array	The requested headers.

Example:

Code Block

language	js
theme	Eclipse
title	getRequestHeaders

const sm = new sws.restRequestV1('REST_message_record', 'get');
const headers = sm.getRequestHeaders();

getRequestMethod()

Returns the requesting method

Return:

Type	Description
String	The method name.

Example:

Code Block

language	js
theme	Eclipse
title	getRequestMethod

const sm = new sws.restRequestV1('REST_message_record', 'get');
const method = sm.getRequestMethod();

Table of Contents

absoluteUrl	true
class	fixedPosition

Page tree

Versions Compared

Old Version 21

New Version 22

Key

SimpleRestRequest()

SimpleRestRequest(requestName, methodName)

execute()

setBasicAuth(userName, userPass)

setRequestUrl(requestUrl)

setRequestMethod(methodName)

setRequestTimeout(timeout)

setQueryParameter(name, value)

setRequestBody(body)

setStringParameter(name, value)

setRequestHeader(name, value)

getRequestUrl()

getRequestBody()

getRequestHeaders()

getRequestMethod()