dataset.listPaged(options)

Method Description	Retrieves metadata about datasets.
Returns	PagedInfoData
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	10 units
Module	N/dataset Module
Sibling Module Members	N/dataset 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 get a paginated listing for.

Errors

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

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

            // Add additional code
...
var allDatasets = dataset.listPaged({
    pageSize: 50
});

log.debug({
    title: 'List of datasets: ',
    details: allDatasets
});
...
// Add additional code 

          

Related Topics

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

General Notices