Show Lists

The Show Lists command allows you to return a list of Lists in your realm. This command returns the list id and name of each list in the realm, sorted alphabetically by list name. To return the list description, use the Output Format argument. To return results for a single, specific list, use the List Name argument.

Show Lists requires the following arguments: Command, Realm, and Password.

api_web?r=myrealm&p=mypass&c=show_lists

The command is ‘show_lists’, the realm is ‘myrealm’ and the password is ‘mypass’.

Example

Using all commands and arguments (please note the command is wrapped for display purposes only):

api_web?r=myrealm&p=mypass&c=show_lists&list_name=mylist&version=8.4.0&output_format=csv&headers=1

Successful results return:

"List Number","List Name","List Description","Folder ID" "1","mylist","test list","2"

If a Description is not defined for a list, it will appear blank or empty in the results.

Results

The Show Lists command outputs either the results of the search or a FAILURE message.

Success

The Show Lists command does not explicitly return a Success code. Instead, it outputs the list id and name in plain text format. Use the output_format argument to return the following data in an alternate format.

"List Number","List Name","List Description","Folder ID"

Failure

A Show Lists command will fail for several reasons. The result format is:

FAILURE: [Reason]

Arguments

The Show Lists command supports the following arguments:

Name	Req?	Description	Argument
Command	Yes	Defines the command to use.	cmd=show_lists c=show_lists
Realm	Yes	Name of the realm to run the command. This is required, and the command will fail if the realm and password do not match.	realm=[realm_name] r=[realm_name]
Password	Yes	Authentication code for API access. This is required, and the command will fail if the realm and password do not match.	pwd=[password] p=[password]
List Name		Name of the specific list to display.	list_name=[list_name]
Version		Version of API to use. Data may be added to newer versions of the API. To alleviate issues for users who have already coded file parsing, new columns are only displayed if the version is included	version=[version_number] 8.4.0 = folder_id
Output Format		To specify the format of the list output, use one of two arguments. If no argument is included, the default output is space-delimited plain text string, which may not include all data columns.	csv=1 or output_format=[csv,csv_tab, csv_pipe,xml]
Header		To define the data with a label, use the Header argument. This can only be used in conjunction with the output format, and does not affect XML.	headers=[0,1] DEFAULT==0