1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/https Module
  6. https.requestRestlet(options)

https.requestRestlet(options)

Method Description

Sends an HTTPS request to a RESTlet and returns the response. Authentication headers are automatically added.

The RESTlet will run with the same privileges as the calling script.

Returns

https.ClientResponse

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

10 units

Module

N/https Module

Since

2020.2
Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.body

string | Object

required, if options.method =POST or PUT.

The PUT/POST data. This is ignored if the options.method is not POST or PUT.

2020.2

options.deploymentId

string

required

The script ID of the script deployment record.

2020.2

options.scriptId

string | number

required

The internal ID or script ID of the script record. Specify internal ID as a number. Specify script ID as a string.

2020.2

options.headers

Object

required, if options.method =POST or PUT.

The HTTPS headers.

Must contain at least a Content-Type header for options.method =POST or PUT.

2020.2

options.method

string

optional

The HTTPS method (DELETE, GET, HEAD, POST, PUT). The default value is GET if options.body is not specified, and POST if options.body is specified.

2020.2

options.urlParams

Object

optional

The parameters to be appended to the target URL as a query string.

2020.2
Errors

Error Code

Message

Thrown If

INVALID_SCRIPT_DEPLOYMENT_ID_1

—

If the options.deploymentId parameter does not reference a valid deployment for the script.

SSS_AUTHORIZATION_HEADER_NOT_ALLOWED

—

The authorization header is set.

SSS_INVALID_HEADER

—

The options.headers parameter is in an invalid format or contains an invalid header.

SSS_INVALID_SCRIPT_ID_1

—

The options.scriptId parameter does not reference a RESTlet script.

SSS_INVALID_URL_PARAMS

—

The options.urlParams parameter is in an invalid format.

SSS_MISSING_REQD_ARGUMENT

Missing a required argument: {param name}

The options.body, options.deploymentId, or options.scriptId parameter is not specified.

SSS_REQUEST_LOOP_DETECTED

—

The script executes a recursive function that has exceeded the limit for the number of times a script can call itself using an HTTPS request.
Syntax
Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/https Module Script Samples.

          // Add additional code 
...
var myRestletHeaders = {
    myHeaderType: 'Test',
    myHeaderStuff: 'This is my header',
    myHeaderId: 7
};
var myUrlParameters = {
    myFirstParameter: 'firstparam',
    mySecondParameter: 'secondparam'
}
var myRestletResponse = https.requestRestlet({
    body: 'My Restlet body',
    deploymentId: 'deploy1',
    headers: myRestletHeaders,
    method: 'GET',
    scriptId: 99,
    urlParams: myUrlParameters
});
 Add additional code

Related Topics

General Notices