1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/http Module
  6. http.ServerResponse
  7. ServerResponse.getHeader(options)

ServerResponse.getHeader(options)

Method Description

Returns the value or values of a response header. If multiple values are assigned to the header name, the values are returned as an Array.

For more information, see HTTP Header Information.

Returns

string | string[]

Supported Script Types

Server scripts

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

Governance

None

Module

N/http Module

Parent Object

http.ServerResponse

Sibling Object Members

ServerResponse Object Members

Since

2015.2
Parameters
Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

Since

options.name

string

required

The name of the header.

2015.2
Errors

Error Code

Message

Thrown If

SSS_MISSING_REQD_ARGUMENT

Missing a required argument: {param name}

The options.name parameter is not specified.
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/http Module Script Samples.

          // Add additional code 
...
serverResponse.getHeader({
    name: 'Accept-Language'
});
...
// Add additional code

Related Topics

General Notices