# logical_doc_rest_api

LogicalDocRestApi - JavaScript client for logical_doc_rest_api
This is the interactive documentation of the REST APIs exposed by LogicalDOC. You can find more information about LogicalDOC at https://www.logicaldoc.com or on Twitter @logicaldoc.<br/>                Note: The access path to the API is protected with basic authentication, to be able to run the samples you must log in using the credentials of a Logicaldoc user, or passing to the request the session ID (SID) as a cookie (cookie name: `ldoc-sid`).<br/><br/>             Here is an example to list the children folders: <br/>             <pre>curl -u admin:admin -H ''Accept: application/json'' http://localhost:8080/services/rest/folder/listChildren?folderId=4</pre>             <br/><br/>             RESTful Guide with curl: https://wiki.logicaldoc.com/wiki/RESTful_Guide_with_curl             <br/><br/>             Practical examples of use are available for various programming languages at: http://wiki.logicaldoc.com/wiki/Bindings_And_Samples             <br/><br/>             SDK Clients for a number of programming languages(Java, Javascript, Python, PHP, C# and more) can be downloaded at: https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api                  <br/><br/>             **Find out more about LogicalDOC** https://www.logicaldoc.com
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 8.4.2
- Package version: 8.4.2
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install logical_doc_rest_api --save
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing 
into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your logical_doc_rest_api from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('logical_doc_rest_api')` in javascript files from the directory you ran the last 
command above from.

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/logical_doc_rest_api
then install it via:

```shell
    npm install YOUR_USERNAME/logical_doc_rest_api --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually 
use this library):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var LogicalDocRestApi = require('logical_doc_rest_api');

var defaultClient = LogicalDocRestApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new LogicalDocRestApi.AuthorApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSid(callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://localhost:8080/services/rest*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*LogicalDocRestApi.AuthorApi* | [**getSid**](docs/AuthorApi.md#getSid) | **GET** /auth/getSid | 
*LogicalDocRestApi.AuthorApi* | [**login**](docs/AuthorApi.md#login) | **GET** /auth/login | 
*LogicalDocRestApi.AuthorApi* | [**loginPost**](docs/AuthorApi.md#loginPost) | **POST** /auth/login | 
*LogicalDocRestApi.AuthorApi* | [**logout**](docs/AuthorApi.md#logout) | **DELETE** /auth/logout | 
*LogicalDocRestApi.BookmarkApi* | [**bookmarkDocument**](docs/BookmarkApi.md#bookmarkDocument) | **GET** /bookmark/bookmarkDocument | 
*LogicalDocRestApi.BookmarkApi* | [**bookmarkFolder**](docs/BookmarkApi.md#bookmarkFolder) | **GET** /bookmark/bookmarkFolder | 
*LogicalDocRestApi.BookmarkApi* | [**deleteBookmark**](docs/BookmarkApi.md#deleteBookmark) | **DELETE** /bookmark/deleteBookmark | 
*LogicalDocRestApi.BookmarkApi* | [**getBookmarks**](docs/BookmarkApi.md#getBookmarks) | **GET** /bookmark/getBookmarks | 
*LogicalDocRestApi.BookmarkApi* | [**saveBookmark**](docs/BookmarkApi.md#saveBookmark) | **POST** /bookmark/saveBookmark | 
*LogicalDocRestApi.BookmarkApi* | [**unbookmarkDocument**](docs/BookmarkApi.md#unbookmarkDocument) | **DELETE** /bookmark/unbookmarkDocument | 
*LogicalDocRestApi.BookmarkApi* | [**unbookmarkFolder**](docs/BookmarkApi.md#unbookmarkFolder) | **DELETE** /bookmark/unbookmarkFolder | 
*LogicalDocRestApi.DocumentApi* | [**addNote**](docs/DocumentApi.md#addNote) | **POST** /document/addNote | Adds a new note for the given document
*LogicalDocRestApi.DocumentApi* | [**callDelete**](docs/DocumentApi.md#callDelete) | **DELETE** /document/delete | Deletes a document
*LogicalDocRestApi.DocumentApi* | [**checkin**](docs/DocumentApi.md#checkin) | **POST** /document/checkin | Check-in an existing document
*LogicalDocRestApi.DocumentApi* | [**checkout**](docs/DocumentApi.md#checkout) | **POST** /document/checkout | Checkout a document
*LogicalDocRestApi.DocumentApi* | [**createAlias**](docs/DocumentApi.md#createAlias) | **POST** /document/createAlias | Creates a new document alias
*LogicalDocRestApi.DocumentApi* | [**createDocument**](docs/DocumentApi.md#createDocument) | **POST** /document/create | Creates a new document
*LogicalDocRestApi.DocumentApi* | [**createDownloadTicket**](docs/DocumentApi.md#createDownloadTicket) | **POST** /document/createDownloadTicket | Creates a new download ticket
*LogicalDocRestApi.DocumentApi* | [**createPdf**](docs/DocumentApi.md#createPdf) | **PUT** /document/createPdf | Creates the PDF conversion of the given document; if the PDF conversion was already created, nothing will happen
*LogicalDocRestApi.DocumentApi* | [**createThumbnail**](docs/DocumentApi.md#createThumbnail) | **PUT** /document/createThumbnail | Creates the thumbail of the given document; if the thumbnail was already created, nothing will happen
*LogicalDocRestApi.DocumentApi* | [**deleteLink**](docs/DocumentApi.md#deleteLink) | **DELETE** /document/deleteLink | Removes an existing link
*LogicalDocRestApi.DocumentApi* | [**deleteNote**](docs/DocumentApi.md#deleteNote) | **DELETE** /document/deleteNote | Deletes a note
*LogicalDocRestApi.DocumentApi* | [**deleteVersion**](docs/DocumentApi.md#deleteVersion) | **DELETE** /document/deleteVersion | Delete the version of a document
*LogicalDocRestApi.DocumentApi* | [**getAliases**](docs/DocumentApi.md#getAliases) | **GET** /document/getAliases | Gets the aliases
*LogicalDocRestApi.DocumentApi* | [**getContent**](docs/DocumentApi.md#getContent) | **GET** /document/getContent | Gets the document content
*LogicalDocRestApi.DocumentApi* | [**getDocument**](docs/DocumentApi.md#getDocument) | **GET** /document/getDocument | Gets document metadata
*LogicalDocRestApi.DocumentApi* | [**getDocumentByCustomId**](docs/DocumentApi.md#getDocumentByCustomId) | **GET** /document/getDocumentByCustomId | Gets document metadata by custom ID
*LogicalDocRestApi.DocumentApi* | [**getDocuments**](docs/DocumentApi.md#getDocuments) | **GET** /document/getDocuments | Gets the metadata of a collection of document
*LogicalDocRestApi.DocumentApi* | [**getExtractedText**](docs/DocumentApi.md#getExtractedText) | **GET** /document/getExtractedText | Gets the extracted text of a document
*LogicalDocRestApi.DocumentApi* | [**getLinks**](docs/DocumentApi.md#getLinks) | **GET** /document/getLinks | Gets the links of a document
*LogicalDocRestApi.DocumentApi* | [**getNotes**](docs/DocumentApi.md#getNotes) | **GET** /document/getNotes | Gets all the notes of a document
*LogicalDocRestApi.DocumentApi* | [**getRatings**](docs/DocumentApi.md#getRatings) | **GET** /document/getRatings | Retrieves the different ratings of a focuments
*LogicalDocRestApi.DocumentApi* | [**getRecentDocuments**](docs/DocumentApi.md#getRecentDocuments) | **GET** /document/getRecentDocuments | Gets the last modified documents
*LogicalDocRestApi.DocumentApi* | [**getResource**](docs/DocumentApi.md#getResource) | **GET** /document/getResource | Gets the content of a resource
*LogicalDocRestApi.DocumentApi* | [**getVersionContent**](docs/DocumentApi.md#getVersionContent) | **GET** /document/getVersionContent | Gets the document content by version
*LogicalDocRestApi.DocumentApi* | [**getVersions**](docs/DocumentApi.md#getVersions) | **GET** /document/getVersions | Gets the versions
*LogicalDocRestApi.DocumentApi* | [**isReadable**](docs/DocumentApi.md#isReadable) | **GET** /document/isReadable | Tests if a document is readable
*LogicalDocRestApi.DocumentApi* | [**link**](docs/DocumentApi.md#link) | **POST** /document/link | Creates a link between two documents
*LogicalDocRestApi.DocumentApi* | [**list**](docs/DocumentApi.md#list) | **GET** /document/list | Lists documents by folder
*LogicalDocRestApi.DocumentApi* | [**listDocuments**](docs/DocumentApi.md#listDocuments) | **GET** /document/listDocuments | Lists documents by folder and filename
*LogicalDocRestApi.DocumentApi* | [**lock**](docs/DocumentApi.md#lock) | **PUT** /document/lock | Locks a document
*LogicalDocRestApi.DocumentApi* | [**move**](docs/DocumentApi.md#move) | **PUT** /document/move | Moves an existing document with the given identifier
*LogicalDocRestApi.DocumentApi* | [**promoteVersion**](docs/DocumentApi.md#promoteVersion) | **PUT** /document/promoteVersion | Promotes an old version to the current default one
*LogicalDocRestApi.DocumentApi* | [**rateDocument**](docs/DocumentApi.md#rateDocument) | **PUT** /document/rateDocument | Add/Update the user's vote for a document
*LogicalDocRestApi.DocumentApi* | [**reindex**](docs/DocumentApi.md#reindex) | **POST** /document/reindex | Re-indexes a document
*LogicalDocRestApi.DocumentApi* | [**rename**](docs/DocumentApi.md#rename) | **PUT** /document/rename | Renames the title of an existing document with the given identifier
*LogicalDocRestApi.DocumentApi* | [**replaceFile**](docs/DocumentApi.md#replaceFile) | **POST** /document/replaceFile | Replace the file of a version
*LogicalDocRestApi.DocumentApi* | [**restore**](docs/DocumentApi.md#restore) | **PUT** /document/restore | Restores a deleted document
*LogicalDocRestApi.DocumentApi* | [**saveNote**](docs/DocumentApi.md#saveNote) | **POST** /document/saveNote | Adds a new note
*LogicalDocRestApi.DocumentApi* | [**sendEmail**](docs/DocumentApi.md#sendEmail) | **POST** /document/sendEmail | Sends documents by email
*LogicalDocRestApi.DocumentApi* | [**setPassword**](docs/DocumentApi.md#setPassword) | **POST** /document/setPassword | Password protect a document
*LogicalDocRestApi.DocumentApi* | [**unlock**](docs/DocumentApi.md#unlock) | **PUT** /document/unlock | Unlocks the document
*LogicalDocRestApi.DocumentApi* | [**unprotect**](docs/DocumentApi.md#unprotect) | **POST** /document/unprotect | Temporarily removes password protection
*LogicalDocRestApi.DocumentApi* | [**unsetPassword**](docs/DocumentApi.md#unsetPassword) | **POST** /document/unsetPassword | Removes password protection
*LogicalDocRestApi.DocumentApi* | [**update**](docs/DocumentApi.md#update) | **PUT** /document/update | Updates an existing document
*LogicalDocRestApi.DocumentApi* | [**upload**](docs/DocumentApi.md#upload) | **POST** /document/upload | Uploads a document
*LogicalDocRestApi.DocumentApi* | [**uploadResource**](docs/DocumentApi.md#uploadResource) | **POST** /document/uploadResource | Uploads a new resource of the document
*LogicalDocRestApi.DocumentMetadataApi* | [**deleteAttributeSet**](docs/DocumentMetadataApi.md#deleteAttributeSet) | **DELETE** /documentMetadata/deleteAttributeSet | Deletes an attribute set
*LogicalDocRestApi.DocumentMetadataApi* | [**deleteTemplate**](docs/DocumentMetadataApi.md#deleteTemplate) | **DELETE** /documentMetadata/deleteTemplate | Deletes a template
*LogicalDocRestApi.DocumentMetadataApi* | [**getAttributeOptions**](docs/DocumentMetadataApi.md#getAttributeOptions) | **GET** /documentMetadata/getAttributeOptions | Retrieves the options for the given attribute
*LogicalDocRestApi.DocumentMetadataApi* | [**getAttributeSet**](docs/DocumentMetadataApi.md#getAttributeSet) | **GET** /documentMetadata/getAttributeSet | Gets an attribute set by name
*LogicalDocRestApi.DocumentMetadataApi* | [**getAttributeSetById**](docs/DocumentMetadataApi.md#getAttributeSetById) | **GET** /documentMetadata/getAttributeSetById | Gets attribute set's metadata
*LogicalDocRestApi.DocumentMetadataApi* | [**getTemplate**](docs/DocumentMetadataApi.md#getTemplate) | **GET** /documentMetadata/getTemplate | Gets template's metadata
*LogicalDocRestApi.DocumentMetadataApi* | [**getTemplateById**](docs/DocumentMetadataApi.md#getTemplateById) | **GET** /documentMetadata/getTemplateById | Gets template's metadata
*LogicalDocRestApi.DocumentMetadataApi* | [**listAttributeSets**](docs/DocumentMetadataApi.md#listAttributeSets) | **GET** /documentMetadata/listAttributeSets | Lists the attribute sets
*LogicalDocRestApi.DocumentMetadataApi* | [**listTemplates**](docs/DocumentMetadataApi.md#listTemplates) | **GET** /documentMetadata/listTemplates | Lists all the templates
*LogicalDocRestApi.DocumentMetadataApi* | [**setAttributeOptions**](docs/DocumentMetadataApi.md#setAttributeOptions) | **PUT** /documentMetadata/setAttributeOptions | Save attribute options
*LogicalDocRestApi.DocumentMetadataApi* | [**storeAttributeSet**](docs/DocumentMetadataApi.md#storeAttributeSet) | **POST** /documentMetadata/storeAttributeSet | Create/Update an attribute set
*LogicalDocRestApi.DocumentMetadataApi* | [**storeTemplate**](docs/DocumentMetadataApi.md#storeTemplate) | **POST** /documentMetadata/storeTemplate | Create/Update a template
*LogicalDocRestApi.FolderApi* | [**copy**](docs/FolderApi.md#copy) | **POST** /folder/copy | Copies a folder
*LogicalDocRestApi.FolderApi* | [**createAliasFolder**](docs/FolderApi.md#createAliasFolder) | **POST** /folder/createAlias | Creates a new folder alias
*LogicalDocRestApi.FolderApi* | [**createFolder**](docs/FolderApi.md#createFolder) | **POST** /folder/createFolder | Creates a subfolder
*LogicalDocRestApi.FolderApi* | [**createFolderByModel**](docs/FolderApi.md#createFolderByModel) | **POST** /folder/create | Creates a new folder
*LogicalDocRestApi.FolderApi* | [**createPath**](docs/FolderApi.md#createPath) | **POST** /folder/createPath | Creates a path
*LogicalDocRestApi.FolderApi* | [**createSimple**](docs/FolderApi.md#createSimple) | **POST** /folder/createSimple | Creates folders from path
*LogicalDocRestApi.FolderApi* | [**createSimpleForm**](docs/FolderApi.md#createSimpleForm) | **POST** /folder/createSimpleForm | Creates folders from path
*LogicalDocRestApi.FolderApi* | [**createSimpleJSON**](docs/FolderApi.md#createSimpleJSON) | **POST** /folder/createSimpleJSON | Creates folders from path
*LogicalDocRestApi.FolderApi* | [**deleteFolder**](docs/FolderApi.md#deleteFolder) | **DELETE** /folder/delete | Deletes a folder
*LogicalDocRestApi.FolderApi* | [**findByPath**](docs/FolderApi.md#findByPath) | **GET** /folder/findByPath | Gets a folder
*LogicalDocRestApi.FolderApi* | [**getDefaultWorkspace**](docs/FolderApi.md#getDefaultWorkspace) | **GET** /folder/getDefaultWorkspace | Gets the Default workspace
*LogicalDocRestApi.FolderApi* | [**getFolder**](docs/FolderApi.md#getFolder) | **GET** /folder/getFolder | Gets a folder
*LogicalDocRestApi.FolderApi* | [**getGrantedGroups**](docs/FolderApi.md#getGrantedGroups) | **GET** /folder/getGrantedGroups | Retrieves the list of granted groups for the given folder
*LogicalDocRestApi.FolderApi* | [**getGrantedUsers**](docs/FolderApi.md#getGrantedUsers) | **GET** /folder/getGrantedUsers | Retrieves the list of granted users for the given folder
*LogicalDocRestApi.FolderApi* | [**getPath**](docs/FolderApi.md#getPath) | **GET** /folder/getPath | Gets a path of folders
*LogicalDocRestApi.FolderApi* | [**getPathString**](docs/FolderApi.md#getPathString) | **GET** /folder/getPathString | Gets a path
*LogicalDocRestApi.FolderApi* | [**getRootFolder**](docs/FolderApi.md#getRootFolder) | **GET** /folder/getRootFolder | Gets the root folder
*LogicalDocRestApi.FolderApi* | [**grantGroup**](docs/FolderApi.md#grantGroup) | **PUT** /folder/grantGroup | Grants group permission to the folder
*LogicalDocRestApi.FolderApi* | [**grantUser**](docs/FolderApi.md#grantUser) | **PUT** /folder/grantUser | Grants user permission to the folder
*LogicalDocRestApi.FolderApi* | [**isGranted**](docs/FolderApi.md#isGranted) | **GET** /folder/isGranted | Tests user permission on a folder
*LogicalDocRestApi.FolderApi* | [**isReadableFolder**](docs/FolderApi.md#isReadableFolder) | **GET** /folder/isReadable | Tests if a folder is readable
*LogicalDocRestApi.FolderApi* | [**isWritable**](docs/FolderApi.md#isWritable) | **GET** /folder/isWritable | Tests if a folder is writable
*LogicalDocRestApi.FolderApi* | [**listChildren**](docs/FolderApi.md#listChildren) | **GET** /folder/listChildren | Lists the child folders
*LogicalDocRestApi.FolderApi* | [**listWorkspaces**](docs/FolderApi.md#listWorkspaces) | **GET** /folder/listWorkspaces | Retrieves the list of all workspaces
*LogicalDocRestApi.FolderApi* | [**moveFolder**](docs/FolderApi.md#moveFolder) | **PUT** /folder/move | Moves a folder
*LogicalDocRestApi.FolderApi* | [**renameFolder**](docs/FolderApi.md#renameFolder) | **PUT** /folder/rename | Renames a folder
*LogicalDocRestApi.FolderApi* | [**updateFolder**](docs/FolderApi.md#updateFolder) | **POST** /folder/update | Updates a folder
*LogicalDocRestApi.SearchApi* | [**find**](docs/SearchApi.md#find) | **POST** /search/find | Search documents
*LogicalDocRestApi.SearchApi* | [**findByFilename**](docs/SearchApi.md#findByFilename) | **GET** /search/findByFilename | Search documents by Filename
*LogicalDocRestApi.SearchApi* | [**findFolders**](docs/SearchApi.md#findFolders) | **GET** /search/findFolders | Search folders by name
*LogicalDocRestApi.SystemApi* | [**getInfo**](docs/SystemApi.md#getInfo) | **GET** /system/getInfo | Get system information
*LogicalDocRestApi.SystemApi* | [**getLanguages**](docs/SystemApi.md#getLanguages) | **GET** /system/getLanguages | Get enabled languages
*LogicalDocRestApi.SystemApi* | [**getStatistics**](docs/SystemApi.md#getStatistics) | **GET** /system/getStatistics | Get system statistics
*LogicalDocRestApi.TagApi* | [**addDocumentTags**](docs/TagApi.md#addDocumentTags) | **POST** /tag/addDocumentTags | Appends new tags to a document
*LogicalDocRestApi.TagApi* | [**addFolderTags**](docs/TagApi.md#addFolderTags) | **POST** /tag/addFolderTags | Appends new tags to a folder
*LogicalDocRestApi.TagApi* | [**findDocumentsByTag**](docs/TagApi.md#findDocumentsByTag) | **GET** /tag/findDocumentsByTag | Finds authorized documents for the current user having a specified tag.
*LogicalDocRestApi.TagApi* | [**findFoldersByTag**](docs/TagApi.md#findFoldersByTag) | **GET** /tag/findFoldersByTag | Finds authorized folders for the current user having a specified tag.
*LogicalDocRestApi.TagApi* | [**getDocumentTags**](docs/TagApi.md#getDocumentTags) | **GET** /tag/getDocumentTags | Gets all the tags of a document
*LogicalDocRestApi.TagApi* | [**getFolderTags**](docs/TagApi.md#getFolderTags) | **GET** /tag/getFolderTags | Gets all the tags of a folder
*LogicalDocRestApi.TagApi* | [**getTagCloud**](docs/TagApi.md#getTagCloud) | **GET** /tag/getTagCloud | Retrieves all tag clouds in the repository
*LogicalDocRestApi.TagApi* | [**getTags**](docs/TagApi.md#getTags) | **GET** /tag/getTags | Gets all the tags used in the sysem
*LogicalDocRestApi.TagApi* | [**getTagsPreset**](docs/TagApi.md#getTagsPreset) | **GET** /tag/getTagsPreset | Retrieves all the tags in the preset
*LogicalDocRestApi.TagApi* | [**setDocumentTags**](docs/TagApi.md#setDocumentTags) | **POST** /tag/setDocumentTags | Set the tags of a document
*LogicalDocRestApi.TagApi* | [**setFolderTags**](docs/TagApi.md#setFolderTags) | **POST** /tag/setFolderTags | Sets the tags of a folder


## Documentation for Models

 - [LogicalDocRestApi.CommandInfo](docs/CommandInfo.md)
 - [LogicalDocRestApi.DataFlavor](docs/DataFlavor.md)
 - [LogicalDocRestApi.DataHandler](docs/DataHandler.md)
 - [LogicalDocRestApi.DataSource](docs/DataSource.md)
 - [LogicalDocRestApi.InputStream](docs/InputStream.md)
 - [LogicalDocRestApi.OutputStream](docs/OutputStream.md)
 - [LogicalDocRestApi.WSAttribute](docs/WSAttribute.md)
 - [LogicalDocRestApi.WSAttributeSet](docs/WSAttributeSet.md)
 - [LogicalDocRestApi.WSBookmark](docs/WSBookmark.md)
 - [LogicalDocRestApi.WSDocument](docs/WSDocument.md)
 - [LogicalDocRestApi.WSFolder](docs/WSFolder.md)
 - [LogicalDocRestApi.WSLink](docs/WSLink.md)
 - [LogicalDocRestApi.WSNote](docs/WSNote.md)
 - [LogicalDocRestApi.WSParameter](docs/WSParameter.md)
 - [LogicalDocRestApi.WSRating](docs/WSRating.md)
 - [LogicalDocRestApi.WSRight](docs/WSRight.md)
 - [LogicalDocRestApi.WSSearchOptions](docs/WSSearchOptions.md)
 - [LogicalDocRestApi.WSSearchResult](docs/WSSearchResult.md)
 - [LogicalDocRestApi.WSSystemInfo](docs/WSSystemInfo.md)
 - [LogicalDocRestApi.WSTagCloud](docs/WSTagCloud.md)
 - [LogicalDocRestApi.WSTemplate](docs/WSTemplate.md)


## Documentation for Authorization


### basicAuth

- **Type**: HTTP basic authentication