Web Services API Sample
Application Overview
APIDemo is a small demo application which demonstrates how
to use FileHold Web Services API. The APIDemo should not be considered
as a fully working client application therefore it is not advisable to
use or include the code in production systems. It is also not an extensive
tutorial on how to use FileHold API in various functional scenarios. Its
main purpose is to demonstrate the most simplistic authentication scenario
(local users only) and provide a taste of the FileHold programming environment
and its relative simplicity for our customers’ IT personnel.
The APIDemo demonstrates the use of FileHold API in the
context of the desktop client mode connection to the FileHold Server as
apposed to the web client mode. APIDemo allows to perform two simple operations:
- Add (PUT) a single file to the FileHold Library -
This operation will create a new Cabinet – Drawer – Folder
structure in the FileHold Document Library and will upload the file
to that folder. The names of the new objects (Cabinet, Drawer and Folder)
contain date and time to ensure that the generated names are unique.
- Retrieve (GET) a single file from the FileHold Library
- This operation will first execute a full text search on the FileHold
document repository using a single word, provided as a command line
parameter, as the search clause. The results found are then shown and
the first matching file (by name) is downloaded (regardless of the number
of results) to a location specified by another command line parameter.
The demo supports only single words as search clauses and exact matches
while searching, therefore the file name should not contain any spaces.
The APIDemo does not address user rights and privileges, therefore, please
make sure that you have necessary access rights to operate on the local
file system and that you have a valid account in FileHold with system
administration rights. FileHold default “sysadm” account could
be used for testing.
|
