https.requestSuitelet(options)
Method Description |
Sends an HTTPS request to a Suitelet and returns the response. This method can only return an internal Suitelet in trusted contexts for authenticated users. |
Returns |
|
Supported Script Types |
Client and server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
10 units |
Module |
|
Since |
2023.1 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
Since |
---|---|---|---|---|
|
string |
required |
The script ID of the script deployment record. |
2023.1 |
|
string |
required |
The script ID of the script record. |
2023.1 |
|
string | Object |
optional |
The POST data. This parameter is ignored if the value of the |
2023.1 |
|
Object |
optional |
The HTTPS headers. |
2023.1 |
|
string |
optional |
The HTTPS method (DELETE, GET, HEAD, POST, PUT). The default value is GET if |
2023.1 |
|
Object |
optional |
Parameters to be appended to the target URL as a query string. |
2023.1 |
Errors
Error Code |
Error Message |
Thrown If |
---|---|---|
|
— |
The |
|
— |
The authorization header is set. |
|
— |
The |
|
— |
The |
|
— |
The |
|
Missing a required argument: {param name} |
The |
|
— |
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
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
...
https.requestSuitelet({
scriptId: "custscript_myScript",
deploymentId: "custdeploy_myDeployment",
urlParams: {
address: address
}
});
...
// Add additional code