workbook.loadWorkbook(options)

Method Description	Loads an existing workbook. After you load a workbook, you can execute a table and view the results.
Returns	workbook.Workbook
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	10 units
Module	N/workbook Module
Sibling Module Members	N/workbook Module Members
Since	2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.id	string	required	The ID of the existing workbook.

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/workbook Module Script Samples. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

            // Add additional code
...
var myWorkbook = workbook.load({
    id: myWorkbookId
});
...
// Add additional code 

          

Related Topics

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

General Notices