module function · N/https
post()
https.post(options)
Sends an HTTPS POST request and returns the response.
- Implementation
- Not started
- Design
- Open for proposals suggest how it should read
A
suitescript api
1https.post({2 body: /* string | Object | Uint8Array, required */,3 url: /* string https.SecureString, required */4});
| Parameter | Type | Required | Description |
|---|---|---|---|
| options.body | string | Object | Uint8Array | required | The POST data. Important: Keep the following behaviors in mind when sending binary data in the request body: When the body is a Uint8Array , NetSuite sets Content-Type header to application/octet-stream by default. You can change it to a more suitable type for the file. NetSuite doesn't support sending files with multipart/form-data Content-Type header Uint8Array bodies are supported in SuiteScript 2.1 only. |
| options.url | string https.SecureString | required | The HTTP URL being 'posted' to. Note: NetSuite does not automatically escape special characters reserved for use in URLs. If your URL includes reserved special characters, you will need to escape them. You can use an https.SecureString to specify the options.url parameter and you can use the SecureString.replaceString(options) to escape special characters. For more information about special characters in URLs see https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding or https://developers.google.com/maps/url-encoding . For information about resolving a URL, see N/url Module . For information about getting the URL for a script, including Suitelets, see url.resolveScript(options) . |
B
mynt syntax
No Mynt syntax yet.
Nothing in the language compiles to https.post(options) today. How should it read?
C
community proposals
Competing syntax for post, from GitHub Discussions. Select two or more to compare them side by side.
Loading proposals from GitHub…
D
suggest an alternative
Write the Mynt you wish you could write.
A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.
- Clarity. Does it say what happens, without ceremony?
- Consistency. Does it read like
load,saveandRef[field]? - Expressiveness. Does it cover the cases people actually write?
- Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?