Server Response Redirect Method in SuiteScript

The server response redirect method allows developers to set a redirect URL that resolves to various NetSuite resources. This functionality is particularly useful for directing users to specific pages, such as a new sales order for a particular entity.

Method Details

• Returns: void
• Supported Script Types: Server scripts
• Governance: None
• Module: N/http Module
• Parent Object: http.ServerResponse

Parameters

The options parameter must be a JavaScript object containing the following properties:

• MEDIA_ITEM: Internal ID of a file in the File Cabinet
• RECORD: Use the appropriate record.Type
• RESTLET: Script ID of the RESTlet
• SUITELET: Script ID of the Suitelet
• TASK_LINK: Valid Task ID
  |
  | options.type | http.RedirectType | Required | Specifies the type of resource to redirect to.
  |
  | options.editMode | boolean | Optional | If redirecting to a record, this indicates whether the URL should be in edit mode (true) or view mode (false, default).
  |
  | options.id | number | string | Optional | For SUITELET or RESTLET, this is the deployment ID; for RECORD, the internal ID of the specific record instance.
  |
  | options.parameters | Object | Optional | Additional URL parameters as name:value pairs.

Errors

The method may throw the following errors:

• SSS_INVALID_RECORD_TYPE: Indicates an invalid or unavailable record type.
• SSS_INVALID_SCRIPT_ID_1: Signifies an invalid script ID for Suitelets or RESTlets.
• SSS_INVALID_TASK_ID: Indicates an invalid Task ID for task link redirection.
• SSS_INVALID_URL_CATEGORY: Thrown when an unsupported options.type is specified.
• SSS_MISSING_REQD_ARGUMENT: Indicates when required parameters are missing.

Syntax Example

Here is a sample of how to use this method:

1// Example of redirecting to a sales order  
2myServerResponseObj.sendRedirect({  
3    type: http.RedirectType.RECORD,  
4    identifier: record.Type.SALES_ORDER,  
5    parameters: {entity: 8}  
6});  

Additional Resources

For further details on related topics, refer to:

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

Understanding the server response redirect method is essential for enhancing user navigation within the SuiteScript environment and facilitating dynamic interactions with NetSuite resources.