workbook.listPaged(options)

Method Description

Retrieves a set of pages with metadata about workbooks.

Returns

PagedInfoData

Supported Script Types

Server scripts

Governance

10 units

Module

N/workbook Module

Sibling Module Members

N/workbook Module Members

Since

2021.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
`options.pageSize`	number	required	The page size.
`options.category`	string	optional	The category of datasets or workbooks to retrieve metadata for.

Parameter

Type

Required / Optional

Description

options.pageSize

number

required

The page size.

options.category

string

optional

The category of datasets or workbooks to retrieve metadata for.

Error Code	Thrown If
`INVALID_OWNER_CATEGORY`	The value of the `options.category` parameter is not included in the workbook.OwnerCategory enum.

Error Code

Thrown If

INVALID_OWNER_CATEGORY

The value of the options.category parameter is not included in the workbook.OwnerCategory enum.

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.listPaged({
   pageSize: 2
})

...
// Add additional code