List (ls)

usage: adr.bat ls [-h] [--full] [--long] [--guid] [--header] [--no-header]
                  [--type {item,session,dataset,template,category,group}] [--query query_string]
                  adr_server_url

List items, sessions, datasets and templates in the ADR server.

positional arguments:
adr_server_url        ADR server URL. Example: http://nexus:cei@127.0.0.1:8000

options:
-h, --help            show this help message and exit
--full                Increase the level of output detail
--long                One item per line
--guid                Include the GUID in the output
--header              Include headers in the output
--no-header           Do not include headers in the output
--type {item,session,dataset,template,category,group}
                      Select the object type to list. Default: item
--query query_string  Specify a query string using URI syntax.  Default: no filter

This tool selects a collection of objects and prints the details of the objects to stdout.

Argument/OptionDescription
Arguments
adr_server_urlSpecifies the hostname, port, username and password of the ADR server to list items from. For example: http://nexus:cei@127.0.0.1:8000 specifies a server running on the local machine (127.0.0.1) on port 8000. The username is nexus and the password is cei.
Options
-h, --helpDisplays the usage message and exits.
--fullDisplays additional information not included in a simple listing. This option implies --long.
--longDisplays a single item on each line.

  • --header

  • --no-header

If --header is specified, some query details are printed at the start of the operation. The --no-header option suppresses the query details (the default).
--guidDisplays the GUID for each object, as well as other selected information.
--verboseDisplays additional status and progress information during the operation.
--type {item,template,dataset,category,group}Specifies the type of objects to list.
--query query_stringUses the query string to select the specific objects of the specified type (--type {option}) to perform the operation on. See Query Expressions for the syntax.