Page History

This server class

execute()

Sends the REST message.

Return:

Example:

var sm = new sn_ws.SimpleRestRequestApi(“REST_message_record”, “get”);
var response = sm.execute();

setBasicAuth(userName, userPass)

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

Parameter(s):

Return:

Example:

var sm = new sn_ws.SimpleRestRequestApi(“REST_message_record”, “get”);
sm.setBasicAuth(“username”, “password”);

setRequestUrl(requestUrl)

Sets the request URL.

Parameter(s):

Return:

Example:

var sm = new sn_ws.SimpleRestRequestApi(“REST_message_record”, “get”);
sm.setRequestUrl(“url”);

setRequestMethod(methodName)

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

Parameter(s):

Return:

Example:

var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”);
sm.setRequestMethod(“get”);

setRequestTimeout(timeout)

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

Parameter(s):

Return:

Example:

var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”);
sm.setRequestTimeout(“60000”);

setQueryParameter(name, value)

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

Parameter(s):

Return:

Example:

var sm = new sn_ws . SimpleRestRequestApi(“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):

Return:

Example:

var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”);
var 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):

Return:

Example:

var 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):

Return:

Example:

var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”);
sm.setRequestHeader(“Accept”, “Application/json”);

getRequestUrl()

Method description

Parameter(s):

Displays the request URL with parameters.

Return:

Type	Description
String	The request URl.

Example:

Code Block
language js theme Eclipse title getRequestUrl
var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”); var url = sm.getRequestUrl();

getRequestBody()

Returns the request body.

Return:

Example:

Method description

Parameter(s):

var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”);
var body = sm.getRequestBody();

getRequestHeaders()

Returns all the requested headers.

Return:

Example:

Method description

Parameter(s):

var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”);
var headers = sm.getRequestHeaders();

getRequestMethod()

Returns the requesting method

Return:

Example:

var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”);
var method = sm.getRequestMethod();