Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This server class
| Tip |
|---|
Change the REST_message_record text from the examples below to the record name of your REST message. |
execute()
Sends the REST message.
Return:
| Type | Description |
|---|---|
| SimpleRestResponse | Response to the message sent by the execute() method. |
Example:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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. Method description
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| userName | String | Y | N |
| userPass | String | Y | N |
Return:
| Type | Description |
|---|---|
Example:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
var sm = new sn_ws.SimpleRestRequestApi(“REST_message_record”, “get”);
sm.setBasicAuth(“username”, “password”); |
setRequestUrl(requestUrl)
Sets the request URL.Method description
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| requestUrl | String | Y | N |
Return:
| Type | Description |
|---|---|
Example:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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.Method description
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| methodName | String | Y | N |
Return:
| Type | Description |
|---|---|
Example:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
var sm = new sn_ws . SimpleRestRequestApi(“REST_message_record”, “get”);
sm.setRequestMethod(“get”); |
Method description
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
Return:
| Type | Description |
|---|---|
Example:
| Code Block |
|---|
Method description
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
Return:
| Type | Description |
|---|---|
Example:
| Code Block |
|---|
| Table of Contents | ||||
|---|---|---|---|---|
|