1. SuiteCloud Platform
  2. SuiteCloud SDK
  3. SuiteCloud CLI
  4. SuiteCloud CLI for Node.js
  5. SuiteCloud CLI for Node.js Reference
  6. object:list

object:list

Lists the SDF custom objects deployed in an account.

Syntax

            object:list [--appid QualifiedAppID] [--scriptid ScriptID] [--type CustomObjectType1 CustomObjectType2

Options

Option

Required / Optional

Description

--appid

Optional

Specifies the application ID of the SuiteApp.

The application ID is a fully qualified name with the notation: <publisherid>.<projectid>. For example, com.netsuite.mysuiteapp or org.mycompany.helloworld are valid app IDs.

If specified, only SDF custom objects with that application ID are listed. Otherwise, only SDF custom objects with no application ID are listed.

For information about the SuiteApp application ID, see SuiteApp Application ID.

-i or --interactive

Optional

Runs the command in interactive mode.

--scriptid

Optional

Specifies the script ID of the SDF custom objects you want to list. To specify multiple IDs, enter the IDs separated by spaces. Enter All to import all SDF custom objects of the specified type.

If you specify this option with the --type option, the list of SDF custom objects is also checked against the criteria set by the --type option.

--type

Optional

Lists the SDF custom objects that are associated with the specified custom NetSuite types. To specify multiple types, enter the types separated by spaces.

If you specify this option and the --scriptid option, the criteria set by the --scriptid option is also applied.

If neither the --scriptid nor the --type options are specified, all SDF custom objects are listed.

-h or --help

Optional

Prints the help for this command.

Interactive Example

The following command lists the SDF custom objects in a specific folder using the interactive mode:

            suitecloud object:list -i

Before you run the command, the following questions are prompted:

            Do you want to list objects from a specific SuiteApp? > Yes No
Enter the application ID. > org.mycompany.helloworldapp
Do you want to list all object types? Yes > No
Select the object types you want to list. (*) Advanced PDF Template ( ) Center (*) Center Category
Do you want to enter a script ID to filter your list? > Yes No
Enter the full or partial script ID. > 9

Non-interactive Example

The following command lists the SDF custom objects in your current account:

            suitecloud object:list --appid org.mycompany.helloworldapp --type advancedpdftemplate centercategory

Output Example

When you run the command, it produces an output that is similar to the following:

            The following objects were found in your account:
advancedpdftemplate:custtmpl_myfile
advancedpdftemplate:custtmpl_2
centercategory:custcentercategory_myfile
centercategory:custcentercategory_2

Related Topics

General Notices