logical_doc_rest_api v8.4.21

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. 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). Here is an example to list the children folders: curl -u admin:admin -H ''Accept: application/json'' http://localhost:8080/services/rest/folder/listChildren?folderId=4 RESTful Guide with curl: https://wiki.logicaldoc.com/wiki/RESTful_Guide_with_curl Practical examples of use are available for various programming languages at: http://wiki.logicaldoc.com/wiki/Bindings_And_Samples 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 Find out more about LogicalDOC https://www.logicaldoc.com This SDK is automatically generated by the Swagger Codegen project:

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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

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

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:

    npm install YOUR_USERNAME/logical_doc_rest_api --save

For browser

The library also works in the browser environment via npm and browserify. 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):

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:

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

Getting Started

Please follow the installation instruction and execute the following JS code:

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

Documentation for Models

• LogicalDocRestApi.CommandInfo
• LogicalDocRestApi.DataFlavor
• LogicalDocRestApi.DataHandler
• LogicalDocRestApi.DataSource
• LogicalDocRestApi.InputStream
• LogicalDocRestApi.OutputStream
• LogicalDocRestApi.WSAttribute
• LogicalDocRestApi.WSAttributeSet
• LogicalDocRestApi.WSBookmark
• LogicalDocRestApi.WSDocument
• LogicalDocRestApi.WSFolder
• LogicalDocRestApi.WSLink
• LogicalDocRestApi.WSNote
• LogicalDocRestApi.WSParameter
• LogicalDocRestApi.WSRating
• LogicalDocRestApi.WSRight
• LogicalDocRestApi.WSSearchOptions
• LogicalDocRestApi.WSSearchResult
• LogicalDocRestApi.WSSystemInfo
• LogicalDocRestApi.WSTagCloud
• LogicalDocRestApi.WSTemplate

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication