DTXS API DTXS Client Python DTXS Client Documents

Documents

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

Upload a document

Upload a document to a given database

CLI Arguments

Argument Description Example
config Path to the client config file ../config.json
database Name of the database. Dorado
filePath Path to the file to upload 'D:/Dorado/table.xls'

Command

  python.bat {config} upload-document {database} {filePath}

Get a document

Retrieve the latest information of a document.

CLI Arguments

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

Command

  python.bat {config} get-document {database} {folderUid} {documentUid}

List all documents

Retrieve the latest information of all documents in a given database.

CLI Arguments

Argument Description Example
config Path to the client config file ../config.json
database Name of the database. Dorado

Command

  python.bat {config} list-documents {database}

Delete a document

Delete a given document.

CLI Arguments

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

Command

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