Get HTTP Response Header Values in SuiteScript

The getHeader method in SuiteScript provides a way to obtain the value(s) of a response header. If multiple values are associated with a header name, this method returns them as an array. This capability is essential for developers managing HTTP requests and responses in their scripts, particularly in server-side scripting contexts.

Method Description

The getHeader function allows you to extract the value or values of a specific HTTP response header from a server response object. This method can be particularly useful when dealing with web APIs or when you need to inspect or use response data for further processing.

Returns

• Type: string | string[]
• Returns a single string value if there is one header value, or an array if there are multiple values.

Supported Script Types

• Server scripts

Governance

• None

Module

• N/http Module

Parent Object

• http.ServerResponse

Parameters

The options parameter is a JavaScript object that requires the following:

Errors

The following error may be encountered if the required parameter is not provided:

• Error Code: SSS_MISSING_REQD_ARGUMENT
  • Message: Missing a required argument: {param name}
  • Thrown If: The options.name parameter is not specified.

Syntax Example

This code sample demonstrates how to use the getHeader method in a SuiteScript:

// Assuming serverResponse is defined
const acceptLanguageHeader = serverResponse.getHeader({
    name: 'Accept-Language'
});

This function call retrieves the Accept-Language header from the server response. Ensure you include necessary additional code to manage the response appropriately.

Related Topics

• HTTP Header Information
• N/http Module
• ServerResponse Object Members

Key Takeaways

• Retrieve HTTP response header values using getHeader() in SuiteScript.
• Supports retrieval of single or multiple header values.
• Requires the header name as a mandatory parameter.