http://wiki.logicaldoc.com/wiki/index.php?action=history&feed=atom&title=Dms 2026-04-04T04:31:48Z Revision history for this page on the wiki MediaWiki 1.43.1 http://wiki.logicaldoc.com/wiki/index.php?title=Dms&diff=1224&oldid=prev 2010-07-19T10:55:00Z

<p></p> <p><b>New page</b></p><div>{| cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; style=&quot;clear: {{{clear|right}}}; margin-bottom: .5em; float: right; padding: .5em 0 .8em 1.4em; background: none; width: {{{width|{{{1|auto}}}}}};&quot; {{#if:{{{limit|}}}|class=&quot;toclimit-{{{limit}}}&quot;}}<br /> | __TOC__<br /> |}<br /> <br /> 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: &#039;&#039;http://localhost:8080/logicaldoc/services/Dms?wsdl&#039;&#039;. <br /> &lt;br&gt;<br /> <br /> &#039;&#039;&#039;It contains all the services provided in the previous versions of the LogicalDOC web service plugin, but all this services are deprecated.&#039;&#039;&#039;<br /> <br /> Mandatory input parameters are in &#039;&#039;&#039;bold&#039;&#039;&#039; and &#039;&#039;italic&#039;&#039;. <br /> <br /> == Log In ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: login&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;username&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;username used to log in&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;password&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;password used to log in&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | The newly created session identifier(sid)<br /> |}<br /> <br /> This operation allows to start a new user session. <br /> <br /> == Log Out ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: logout&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |}<br /> <br /> This operation allows to close a user session. <br /> <br /> == Check In ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: checkin&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;id&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;document identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;filename&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;name of the file to check in&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;description&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | file&#039;s description<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;type&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s version type (can be one of &#039;release&#039; or &#039;subversion&#039;)<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;content&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;binary&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;file content&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | &#039;ok&#039; if all goes right or &#039;document not checked out&#039;<br /> |}<br /> <br /> This operation allows to upload a new version of an already checked out document. <br /> <br /> == Check Out ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: checkout&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;id&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;document identifier&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | &#039;ok&#039; if all goes right<br /> |}<br /> <br /> This operation allows to mark a document as check out. <br /> <br /> == Create Document ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: createDocument&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;folder&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;folder identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;docTitle&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s title<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;source&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;sourceDate&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source date<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;sourceAuthor&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source author<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;sourceType&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source type<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;coverage&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s coverage<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;language&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s language<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;tags&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s tags<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;versionDesc&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s version description<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;filename&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s title<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;content&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;binary&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;file content&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;templateName&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | template&#039;s name<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;templateFields&lt;/div&gt; <br /> | &lt;center&gt;ExtendedAttribute&lt;/center&gt; <br /> | template&#039;s fields as names-values pairs<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;sourceId&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source identifier<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;object&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s object<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;recipient&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s recipient<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;customId&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s custom ID<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | newly created document ID<br /> |}<br /> <br /> This operation allows to create a new document. The user can completely customize the document through many optional fields. <br /> <br /> == Update ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: update&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;folder&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;folder identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;doctitle&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s title<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;source&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;sourceDate&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source date<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;sourceAuthor&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source author<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;sourceType&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source type<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;coverage&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s coverage<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;language&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s language<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;tags&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s tags<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;sourceId&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s source identifier<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;templateName&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | template&#039;s name<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;templateFields&lt;/div&gt; <br /> | &lt;center&gt;ExtendedAttribute&lt;/center&gt; <br /> | template&#039;s fields as names-values pairs<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;object&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s object<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;recipient&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s recipient<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | newly created document ID<br /> |}<br /> <br /> This operation allows to update an existing document. The user can completely customize the document through many optional fields. <br /> <br /> == Create Folder ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: createFolder&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;name&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;folder name&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;parent&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;int&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;parent folder identifier&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | newly created folder ID<br /> |}<br /> <br /> 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. <br /> <br /> == Index Document ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: indexDocument&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;id&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;document identifier&#039;&#039;&#039;&#039;&#039;<br /> |}<br /> <br /> This operation allows to request the indexing of a particular document. If the document is already indexed, it will be re-indexed. <br /> <br /> == Rename Folder ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: renameFolder&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;folder&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;folder&#039;s identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;name&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;new folder&#039;s name&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | the renamed folder ID<br /> |}<br /> <br /> This operation allows to rename an existing folder. All nested documents will be marked to be reintexed. <br /> <br /> == Delete Document ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: deleteDocument&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;id&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;document identifier&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | &#039;ok&#039; if all goes right<br /> |}<br /> <br /> This operation allows to delete an existing document with the given identifier. <br /> <br /> == Delete Folder ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: deleteFolder&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;id&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;folder identifier&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | &#039;ok&#039; if all goes right<br /> |}<br /> <br /> This operation allows to delete an existing folder (with the given identifier) and all it&#039;s contained elements. <br /> <br /> == Download Document ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: downloadDocument&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;id&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;folder identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;version&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | document&#039;s version<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;binary&lt;/center&gt; <br /> | requested document&#039;s binary<br /> |}<br /> <br /> This operation allows to download a document with the given identifier. The document content is sent as attachment identified by &#039;document&#039;. <br /> <br /> == Download Document Info ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: downloadDocumentInfo&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;id&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;document identifier&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;DocumentInfo&lt;/center&gt; <br /> | requested document&#039;s information<br /> |}<br /> <br /> This operation allows to retrieve the meta-data of a document with a given identifier. <br /> <br /> == Download Folder Content ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: downloadFolderContent&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;id&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;long&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;folder identifier&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;FolderContent&lt;/center&gt; <br /> | requested folder&#039;s information<br /> |}<br /> <br /> This operation allows to retrieve the meta-data of a folder with a given identifier. <br /> <br /> == Search ==<br /> <br /> {| width=&quot;50%&quot; cellspacing=&quot;0&quot; cellpadding=&quot;4&quot; border=&quot;1&quot; class=&quot;prettytable&quot;<br /> |- style=&quot;background-color: rgb(238, 238, 238);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;&#039;&#039;operation: search&#039;&#039;&#039;&#039;&#039;<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;input&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;sid&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;session identifier&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;&#039;&#039;&#039;&#039;&#039;query&#039;&#039;&#039;&#039;&#039;&lt;/div&gt; <br /> | &lt;center&gt;&#039;&#039;&#039;&#039;&#039;string&#039;&#039;&#039;&#039;&#039;&lt;/center&gt; <br /> | &#039;&#039;&#039;&#039;&#039;query&#039;&#039;&#039;&#039;&#039;<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;indexLanguage&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | index language(if &#039;null&#039; all indexes are considered)<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;queryLanguage&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | language in which the query is expressed<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;maxHits&lt;/div&gt; <br /> | &lt;center&gt;int&lt;/center&gt; <br /> | max number of hits to be returned<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;templateName&lt;/div&gt; <br /> | &lt;center&gt;string&lt;/center&gt; <br /> | template&#039;s name<br /> |-<br /> | &lt;div align=&quot;right&quot;&gt;templateFields&lt;/div&gt; <br /> | &lt;center&gt;string array&lt;/center&gt; <br /> | template&#039;s fields names<br /> |- style=&quot;background-color: rgb(255, 248, 198);&quot;<br /> | colspan=&quot;3&quot; | &#039;&#039;&#039;output&#039;&#039;&#039;<br /> |-<br /> | <br /> | &lt;center&gt;SearchResult&lt;/center&gt; <br /> | search hits<br /> |}<br /> <br /> This operation allows to retrieve all documents that are been found through the given query.<br /> <br /> &lt;br&gt;</div>

Mcaruso82