workbook.listPaged(options)
Method Description |
Retrieves a set of pages with metadata about workbooks. |
Returns |
PagedInfoData |
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
10 units |
Module |
|
Sibling Module Members |
|
Since |
2021.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
number |
required |
The page size. |
|
string |
optional |
The category of datasets or workbooks to retrieve metadata for. |
Errors
Error Code |
Thrown If |
---|---|
|
The value of the |
Syntax
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.listPaged({
pageSize: 2
})
...
// Add additional code