HTTP PUT Request Syntax in SuiteScript 2.x

TL;DR Opening

This article explains how to execute an HTTP PUT request using SuiteScript 2.x, focusing on the syntax, parameters, and potential errors to be aware of in your scripting.

Method Description

The HTTP PUT request method allows you to send data to a specific URL. However, it has some important timeout limitations:

• Connection timeout: 5 seconds
• Data sending timeout: 45 seconds

Note that the PUT request is not functional in unauthenticated client-side contexts, which is crucial for ensuring secure interactions. For further information, refer to the relevant documentation on HTTP requests.

Returns

The PUT request method returns either a http.ClientResponse or http.ServerResponse.

Supported Script Types

• Client Scripts
• Server Scripts

For additional details, check out the SuiteScript 2.x Script Types.

Governance

Using the HTTP PUT method consumes 10 governance units.

Parameters

The options parameter is a JavaScript object containing several key properties:

Errors

Here are the common error codes you might encounter when performing a PUT request:

Example Syntax

Below is a code sample illustrating the syntax used for the HTTP PUT request, although it is not a complete functional example:

1// Add additional code 
2...
3var headerObj = {
4    name: 'Accept-Language',
5    value: 'en-us'
6};
7var response = http.put({
8    url: 'http://www.google.com',
9    body: 'My PUT Data',
10    headers: headerObj
11});
12...
13// Add additional code

Related Topics

• N/http Module
• SuiteScript 2.x Modules
• SuiteScript 2.x

Key Takeaways

• The HTTP PUT method is critical for sending data to specified URLs.
• Timeout settings can affect request success; understand these limitations.
• Ensure all required parameters are included to avoid common errors.