Dataset.runPaged(options)
Method Description |
Executes the dataset and returns the result set as paginated data (the same as in N/query Module). The maximum number of results per page is 1000. The minimum number of results per page is 5, except for the last page, which may include fewer than 5 results. |
Returns |
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
Governance |
10 units |
Module |
|
Parent Object |
|
Sibling Object Members |
|
Since |
2020.2 |
Parameters
The options
parameter is a JavaScript object.
Parameter |
Type |
Required / Optional |
Description |
---|---|---|---|
|
number |
required |
The size of each page in the dataset results. The maximum allowed value is 1000. The minimum allowed value is 5. The default page size is 50 results per page. |
Syntax
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
...
// Load a dataset and run it to get paged data results
var myDataset = dataset.load({
id: myDatasetId
});
var myDatasetResultSet = myDataset.runPaged({
pageSize: 15
});
log.audit({
title: 'My Paged Data Result Set: ',
details: myDatasetResultSet
});
...
// Add additional code