DTXS API DTXS Client Python DTXS Client Folders

Folders

This page shows all the commands that can be used in the Python DTXS CLI client for folder manipulation.

Create a folder

Create a new folder into a database.

CLI Arguments

Argument Description Example
config Path to the client config file ../config.json
database Name of the database Dorado
folderName The name of the new folder. DoradoFolder
parentFolderUid The UID of a parent folder. root

If you are creating a new folder that doesn't have a parent folder you need to input root into the parentFolderUid argument

Command

  python.bat {config} create-folder {database} {folderName} {parentFolderUid}

Get the contents of a folders

Retrieves information about a given folder and it's contents. This command will give you names of the given folder and the parent folder, information about any existing sub-folders of the given folder, and the information about the latest versions of documents in the given folder.

CLI Arguments

Argument Description Example
config Path to the client config file ../config.json
database Name of the database Dorado
folderUid The UID of a folder. 099ef1be-42aa-11f0-adf1-04bf1ba25820

Command

  python.bat {config} get-folder-contents {database} {folderUid}

Delete a folder

Delete the given folder.

CLI Arguments

Argument Description Example
config Path to the client config file ../config.json
database Name of the database Dorado
folderUid The UID of the folder 099ef1be-42aa-11f0-adf1-04bf1ba25820

Command

  python.bat {config} delete-folder {database} {folderUid}
(C) wai.blue | Rendered using GuideVis