filedossier-api

FiledossierApi - JavaScript client for filedossier-api This SDK is automatically generated by the OpenAPI Generator project:

• API version:
• Package version: 1.0-SNAPSHOT
• Build package: org.openapitools.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 filedossier-api --save

Finaly, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your filedossier-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finaly, you need to build the module:

npm run build

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --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):

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 FiledossierApi = require('filedossier-api');


var api = new FiledossierApi.DefaultApi()
var fileCode = "fileCode_example"; // {String} 
var dossierKey = "dossierKey_example"; // {String} 
var dossierPackage = "dossierPackage_example"; // {String} 
var dossierCode = "dossierCode_example"; // {String} 
api.getContents(fileCode, dossierKey, dossierPackage, dossierCode).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- FiledossierApi.DefaultApi | getContents | GET /dossiers/{dossierKey}/{dossierPackage}/{dossierCode}/dossierfiles/{fileCode} | FiledossierApi.DefaultApi | getDossier | GET /dossiers/{dossierKey}/{dossierPackage}/{dossierCode} | FiledossierApi.DefaultApi | setContents | PUT /dossiers/{dossierKey}/{dossierPackage}/{dossierCode}/dossierfiles/{fileCode} | FiledossierApi.DefaultApi | uploadContents | POST /dossiers/{dossierKey}/{dossierPackage}/{dossierCode}/dossierfiles/{fileCode} |

Documentation for Models

• FiledossierApi.Dossier
• FiledossierApi.DossierFile
• FiledossierApi.InlineObject

Documentation for Authorization

All endpoints do not require authorization.