View source for Dms

{| cellspacing="0" cellpadding="0" style="clear: {{{clear|right}}}; margin-bottom: .5em; float: right; padding: .5em 0 .8em 1.4em; background: none; width: {{{width|{{{1|auto}}}}}};" {{#if:{{{limit|}}}|class="toclimit-{{{limit}}}"}}
| __TOC__
|}

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''. 
<br>

'''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  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: login'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''username'''''</div> 
| <center>'''''string'''''</center> 
| '''''username used to log in'''''
|-
| <div align="right">'''''password'''''</div> 
| <center>'''''string'''''</center> 
| '''''password used to log in'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| The newly created session identifier(sid)
|}

This operation allows to start a new user session. 

== Log Out  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: logout'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|}

This operation allows to close a user session. 

== Check In  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: checkin'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''id'''''</div> 
| <center>'''''long'''''</center> 
| '''''document identifier'''''
|-
| <div align="right">'''''filename'''''</div> 
| <center>'''''string'''''</center> 
| '''''name of the file to check in'''''
|-
| <div align="right">description</div> 
| <center>string</center> 
| file's description
|-
| <div align="right">type</div> 
| <center>string</center> 
| document's version type (can be one of 'release' or 'subversion')
|-
| <div align="right">'''''content'''''</div> 
| <center>'''''binary'''''</center> 
| '''''file content'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| '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  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: checkout'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''id'''''</div> 
| <center>'''''long'''''</center> 
| '''''document identifier'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| 'ok' if all goes right
|}

This operation allows to mark a document as check out. 

== Create Document  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: createDocument'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''folder'''''</div> 
| <center>'''''long'''''</center> 
| '''''folder identifier'''''
|-
| <div align="right">docTitle</div> 
| <center>string</center> 
| document's title
|-
| <div align="right">source</div> 
| <center>string</center> 
| document's source
|-
| <div align="right">sourceDate</div> 
| <center>string</center> 
| document's source date
|-
| <div align="right">sourceAuthor</div> 
| <center>string</center> 
| document's source author
|-
| <div align="right">sourceType</div> 
| <center>string</center> 
| document's source type
|-
| <div align="right">coverage</div> 
| <center>string</center> 
| document's coverage
|-
| <div align="right">language</div> 
| <center>string</center> 
| document's language
|-
| <div align="right">tags</div> 
| <center>string</center> 
| document's tags
|-
| <div align="right">versionDesc</div> 
| <center>string</center> 
| document's version description
|-
| <div align="right">filename</div> 
| <center>string</center> 
| document's title
|-
| <div align="right">'''''content'''''</div> 
| <center>'''''binary'''''</center> 
| '''''file content'''''
|-
| <div align="right">templateName</div> 
| <center>string</center> 
| template's name
|-
| <div align="right">templateFields</div> 
| <center>ExtendedAttribute</center> 
| template's fields as names-values pairs
|-
| <div align="right">sourceId</div> 
| <center>string</center> 
| document's source identifier
|-
| <div align="right">object</div> 
| <center>string</center> 
| document's object
|-
| <div align="right">recipient</div> 
| <center>string</center> 
| document's recipient
|-
| <div align="right">customId</div> 
| <center>string</center> 
| document's custom ID
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| newly created document ID
|}

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

== Update  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: update'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''folder'''''</div> 
| <center>'''''long'''''</center> 
| '''''folder identifier'''''
|-
| <div align="right">doctitle</div> 
| <center>string</center> 
| document's title
|-
| <div align="right">source</div> 
| <center>string</center> 
| document's source
|-
| <div align="right">sourceDate</div> 
| <center>string</center> 
| document's source date
|-
| <div align="right">sourceAuthor</div> 
| <center>string</center> 
| document's source author
|-
| <div align="right">sourceType</div> 
| <center>string</center> 
| document's source type
|-
| <div align="right">coverage</div> 
| <center>string</center> 
| document's coverage
|-
| <div align="right">language</div> 
| <center>string</center> 
| document's language
|-
| <div align="right">tags</div> 
| <center>string</center> 
| document's tags
|-
| <div align="right">sourceId</div> 
| <center>string</center> 
| document's source identifier
|-
| <div align="right">templateName</div> 
| <center>string</center> 
| template's name
|-
| <div align="right">templateFields</div> 
| <center>ExtendedAttribute</center> 
| template's fields as names-values pairs
|-
| <div align="right">object</div> 
| <center>string</center> 
| document's object
|-
| <div align="right">recipient</div> 
| <center>string</center> 
| document's recipient
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| 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  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: createFolder'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''name'''''</div> 
| <center>'''''string'''''</center> 
| '''''folder name'''''
|-
| <div align="right">'''''parent'''''</div> 
| <center>'''''int'''''</center> 
| '''''parent folder identifier'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| 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  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: indexDocument'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''id'''''</div> 
| <center>'''''long'''''</center> 
| '''''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  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: renameFolder'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''folder'''''</div> 
| <center>'''''long'''''</center> 
| '''''folder's identifier'''''
|-
| <div align="right">'''''name'''''</div> 
| <center>'''''string'''''</center> 
| '''''new folder's name'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| the renamed folder ID
|}

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

== Delete Document  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: deleteDocument'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''id'''''</div> 
| <center>'''''long'''''</center> 
| '''''document identifier'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| 'ok' if all goes right
|}

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

== Delete Folder  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: deleteFolder'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''id'''''</div> 
| <center>'''''long'''''</center> 
| '''''folder identifier'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>string</center> 
| '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  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: downloadDocument'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''id'''''</div> 
| <center>'''''long'''''</center> 
| '''''folder identifier'''''
|-
| <div align="right">version</div> 
| <center>string</center> 
| document's version
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>binary</center> 
| 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  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: downloadDocumentInfo'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''id'''''</div> 
| <center>'''''long'''''</center> 
| '''''document identifier'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>DocumentInfo</center> 
| requested document's information
|}

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

== Download Folder Content  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: downloadFolderContent'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''id'''''</div> 
| <center>'''''long'''''</center> 
| '''''folder identifier'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>FolderContent</center> 
| requested folder's information
|}

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

== Search  ==

{| width="50%" cellspacing="0" cellpadding="4" border="1" class="prettytable"
|- style="background-color: rgb(238, 238, 238);"
| colspan="3" | '''''operation: search'''''
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''input'''
|-
| <div align="right">'''''sid'''''</div> 
| <center>'''''string'''''</center> 
| '''''session identifier'''''
|-
| <div align="right">'''''query'''''</div> 
| <center>'''''string'''''</center> 
| '''''query'''''
|-
| <div align="right">indexLanguage</div> 
| <center>string</center> 
| index language(if 'null' all indexes are considered)
|-
| <div align="right">queryLanguage</div> 
| <center>string</center> 
| language in which the query is expressed
|-
| <div align="right">maxHits</div> 
| <center>int</center> 
| max number of hits to be returned
|-
| <div align="right">templateName</div> 
| <center>string</center> 
| template's name
|-
| <div align="right">templateFields</div> 
| <center>string array</center> 
| template's fields names
|- style="background-color: rgb(255, 248, 198);"
| colspan="3" | '''output'''
|-
| 
| <center>SearchResult</center> 
| search hits
|}

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

<br>