dataset.describe(options)

Note:

The content in this help topic applies to SuiteScript 2.x.

Method Description	Retrieves information about a dataset, including name, description, and a list of columns and formulas with their labels and types.
Returns	Object[]
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.id	string	required	The ID of the dataset to describe.

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.

            // Add additional code
...
var myDescribes = dataset.describe({
    id: 'custdataset_myDataset'
});
...
// Add additional code 

          

Related Topics

N/dataset Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices