Dms

This chapter lists and describes all operations that the web service makes available to the users. The LogicalDOC Web Service descriptor can be obtained simply invoking this URL: http://localhost:8080/logicaldoc/services/Dms?wsdl.

It contains all the services provided in the previous versions of the LogicalDOC web service plugin, but all this services are deprecated.

Mandatory input parameters are in bold and italic.

Log In

operation: login
input
username	string	username used to log in
password	string	password used to log in
output
	string	The newly created session identifier(sid)

This operation allows to start a new user session.

Log Out

operation: logout
input
sid	string	session identifier

This operation allows to close a user session.

Check In

operation: checkin
input
sid	string	session identifier
id	long	document identifier
filename	string	name of the file to check in
description	string	file's description
type	string	document's version type (can be one of 'release' or 'subversion')
content	binary	file content
output
	string	'ok' if all goes right or 'document not checked out'

This operation allows to upload a new version of an already checked out document.

Check Out

operation: checkout
input
sid	string	session identifier
id	long	document identifier
output
	string	'ok' if all goes right

This operation allows to mark a document as check out.

Create Document

operation: createDocument
input
sid	string	session identifier
folder	long	folder identifier
docTitle	string	document's title
source	string	document's source
sourceDate	string	document's source date
sourceAuthor	string	document's source author
sourceType	string	document's source type
coverage	string	document's coverage
language	string	document's language
tags	string	document's tags
versionDesc	string	document's version description
filename	string	document's title
content	binary	file content
templateName	string	template's name
templateFields	ExtendedAttribute	template's fields as names-values pairs
sourceId	string	document's source identifier
object	string	document's object
recipient	string	document's recipient
customId	string	document's custom ID
output
	string	newly created document ID

This operation allows to create a new document. The user can completely customize the document through many optional fields.

Update

operation: update
input
sid	string	session identifier
folder	long	folder identifier
doctitle	string	document's title
source	string	document's source
sourceDate	string	document's source date
sourceAuthor	string	document's source author
sourceType	string	document's source type
coverage	string	document's coverage
language	string	document's language
tags	string	document's tags
sourceId	string	document's source identifier
templateName	string	template's name
templateFields	ExtendedAttribute	template's fields as names-values pairs
object	string	document's object
recipient	string	document's recipient
output
	string	newly created document ID

This operation allows to update an existing document. The user can completely customize the document through many optional fields.

Create Folder

operation: createFolder
input
sid	string	session identifier
name	string	folder name
parent	int	parent folder identifier
output
	string	newly created folder ID

This operation allows to create a new folder with a given name and under a specific folder. It also assigns the same folder permissions of the parent folder.

Index Document

operation: indexDocument
input
sid	string	session identifier
id	long	document identifier

This operation allows to request the indexing of a particular document. If the document is already indexed, it will be re-indexed.

Rename Folder

operation: renameFolder
input
sid	string	session identifier
folder	long	folder's identifier
name	string	new folder's name
output
	string	the renamed folder ID

This operation allows to rename an existing folder. All nested documents will be marked to be reintexed.

Delete Document

operation: deleteDocument
input
sid	string	session identifier
id	long	document identifier
output
	string	'ok' if all goes right

This operation allows to delete an existing document with the given identifier.

Delete Folder

operation: deleteFolder
input
sid	string	session identifier
id	long	folder identifier
output
	string	'ok' if all goes right

This operation allows to delete an existing folder (with the given identifier) and all it's contained elements.

Download Document

operation: downloadDocument
input
sid	string	session identifier
id	long	folder identifier
version	string	document's version
output
	binary	requested document's binary

This operation allows to download a document with the given identifier. The document content is sent as attachment identified by 'document'.

Download Document Info

operation: downloadDocumentInfo
input
sid	string	session identifier
id	long	document identifier
output
	DocumentInfo	requested document's information

This operation allows to retrieve the meta-data of a document with a given identifier.

Download Folder Content

operation: downloadFolderContent
input
sid	string	session identifier
id	long	folder identifier
output
	FolderContent	requested folder's information

This operation allows to retrieve the meta-data of a folder with a given identifier.

Search

operation: search
input
sid	string	session identifier
query	string	query
indexLanguage	string	index language(if 'null' all indexes are considered)
queryLanguage	string	language in which the query is expressed
maxHits	int	max number of hits to be returned
templateName	string	template's name
templateFields	string array	template's fields names
output
	SearchResult	search hits

This operation allows to retrieve all documents that are been found through the given query.