synactaclient

Synactaclient - JavaScript client for synactaclient
WebApi
This SDK is automatically generated by the Swagger Codegen project:

- API version: v1
- Package version: v1
- Build date: 2016-11-04T14:51:52.715Z
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
For more information, please visit http://www.agile-is.de/

Installation

$3

#### npm

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

Then install it via:

``shell
npm install synactaclient --save
`

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

`shell
npm install YOUR_USERNAME/synactaclient --save
`

$3

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):

`shell
browserify main.js > bundle.js
`

Then include bundle.js in the HTML pages.

Getting Started

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

`javascript
var Synactaclient = require('synactaclient');

var api = new Synactaclient.AuthorizationApi()

var id = "id_example"; // {String} The principal identifier.

var authorization = "authorization_example"; // {String} access token


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

``

Documentation for API Endpoints

All URIs are relative to https://localhost/

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
Synactaclient.AuthorizationApi | apiAuthorizationPrincipalsByIdGet | GET /_api/authorization/Principals/{id} | Provides a principal by his identifier.
Synactaclient.AuthorizationApi | apiAuthorizationPrincipalsGet | GET /_api/authorization/Principals | Gets the principals.
Synactaclient.AuthorizationApi | apiAuthorizationRightsGet | GET /_api/authorization/Rights | Gets the rights.
Synactaclient.AuthorizationApi | apiAuthorizationRolesAddGet | GET /_api/authorization/Roles/Add | Gets the role container.
Synactaclient.AuthorizationApi | apiAuthorizationRolesAddPut | PUT /_api/authorization/Roles/Add | Adds the role.
Synactaclient.AuthorizationApi | apiAuthorizationRolesByIdDelete | DELETE /_api/authorization/Roles/{id} | Deletes the role.
Synactaclient.AuthorizationApi | apiAuthorizationRolesByIdGet | GET /_api/authorization/Roles/{id} | Gets the role.
Synactaclient.AuthorizationApi | apiAuthorizationRolesByIdPost | POST /_api/authorization/Roles/{id} | Updates the role.
Synactaclient.AuthorizationApi | apiAuthorizationRolesGet | GET /_api/authorization/Roles | Gets the roles.
Synactaclient.BaseApi | apiBaseByTypeByIdAddByNewContainerTypeGet | GET /_api/base/{type}/{id}/Add/{newContainerType} | Gets the empty container.
Synactaclient.BaseApi | apiBaseByTypeByIdAddPut | PUT /_api/base/{type}/{id}/Add | Saves the new container.
Synactaclient.BaseApi | apiBaseByTypeByIdCheckinPut | PUT /_api/base/{type}/{id}/Checkin | Checkins the specified .
Synactaclient.BaseApi | apiBaseByTypeByIdCheckoutPut | PUT /_api/base/{type}/{id}/Checkout | Checkouts the specified .
Synactaclient.BaseApi | apiBaseByTypeByIdChildrenGet | GET /_api/base/{type}/{id}/Children | Gets the children of container.
Synactaclient.BaseApi | apiBaseByTypeByIdChildrenTypesGet | GET /_api/base/{type}/{id}/Children/Types | Gets the container types.
Synactaclient.BaseApi | apiBaseByTypeByIdDelete | DELETE /_api/base/{type}/{id} | Deletes the container.
Synactaclient.BaseApi | apiBaseByTypeByIdDocumentsGet | GET /_api/base/{type}/{id}/Documents | Gets the documents.
Synactaclient.BaseApi | apiBaseByTypeByIdDocumentsTypesGet | GET /_api/base/{type}/{id}/Documents/Types | Gets the documents types.
Synactaclient.BaseApi | apiBaseByTypeByIdGet | GET /_api/base/{type}/{id} | Gets the container by identifier.
Synactaclient.BaseApi | apiBaseByTypeByIdGetFileGet | GET /_api/base/{type}/{id}/GetFile | Gets the file.
Synactaclient.BaseApi | apiBaseByTypeByIdLookupListByLookupListNameGet | GET /_api/base/{type}/{id}/LookupList/{lookupListName} | Gets the lookup list entries.
Synactaclient.BaseApi | apiBaseByTypeByIdMovePost | POST /_api/base/{type}/{id}/Move | Moves the object.
Synactaclient.BaseApi | apiBaseByTypeByIdPost | POST /_api/base/{type}/{id} | Updates the container.
Synactaclient.BaseApi | apiBaseByTypeByIdUploadFilePost | POST /_api/base/{type}/{id}/UploadFile | Uploads the file.
Synactaclient.BaseApi | apiBaseByTypeByIdVersionsByVersionIdGet | GET /_api/base/{type}/{id}/Versions/{versionId} | Gets the version by identifier.
Synactaclient.BaseApi | apiBaseByTypeByIdVersionsByVersionIdGetFileGet | GET /_api/base/{type}/{id}/Versions/{versionId}/GetFile | Gets the file for version.
Synactaclient.BaseApi | apiBaseByTypeByIdVersionsByVersionIdRestorePost | POST /_api/base/{type}/{id}/Versions/{versionId}/Restore | Restores the version.
Synactaclient.BaseApi | apiBaseByTypeByIdVersionsGet | GET /_api/base/{type}/{id}/Versions | Gets the versions.
Synactaclient.BaseApi | apiBaseByTypeGet | GET /_api/base/{type} | Gets containers by a type.
Synactaclient.BaseApi | apiBaseRootGet | GET /_api/base/Root | Gets the root.
Synactaclient.BaseApi | apiBaseTypesGet | GET /_api/base/Types | Gets the container types.
Synactaclient.LoggingApi | apiLogAddGet | GET /_api/log/Add | Gets the log container.
Synactaclient.LoggingApi | apiLogAddPut | PUT /_api/log/Add | Adds the log.
Synactaclient.LoggingApi | apiLogGet | GET /_api/log | Gets all logs.
Synactaclient.OrganisationApi | apiOrgByIdAddGet | GET /_api/org/{id}/Add | Gets the new organisation.
Synactaclient.OrganisationApi | apiOrgByIdAddPut | PUT /_api/org/{id}/Add | Saves the new organisation.
Synactaclient.OrganisationApi | apiOrgByIdByTypeGet | GET /_api/org/{id}/{type} | Gets all containers.
Synactaclient.OrganisationApi | apiOrgByIdChildrenGet | GET /_api/org/{id}/Children | Gets the child organisations.
Synactaclient.OrganisationApi | apiOrgByIdDelete | DELETE /_api/org/{id} | Deletes the organisation.
Synactaclient.OrganisationApi | apiOrgByIdGet | GET /_api/org/{id} | Gets the organisation.
Synactaclient.OrganisationApi | apiOrgByIdMovePost | POST /_api/org/{id}/Move | Moves the organisation.
Synactaclient.OrganisationApi | apiOrgByIdPost | POST /_api/org/{id} | Updates the organisation.
Synactaclient.OrganisationApi | apiOrgByIdRecycleBinByRecycleBinIdGet | GET /_api/org/{id}/RecycleBin/{recycleBinId} | Gets the recycle bin entry.
Synactaclient.OrganisationApi | apiOrgByIdRecycleBinByRecycleBinIdRestorePost | POST /_api/org/{id}/RecycleBin/{recycleBinId}/Restore | Restores the recycle bin entry.
Synactaclient.OrganisationApi | apiOrgByIdRecycleBinGet | GET /_api/org/{id}/RecycleBin | Gets the recycle bin.
Synactaclient.OrganisationApi | apiOrgGet | GET /_api/org | Gets all organisations.
Synactaclient.OrganisationApi | apiOrgOrgTreeGet | GET /_api/org/OrgTree | Gets all organisations with childs.
Synactaclient.SearchApi | apiSearchGet | GET /_api/search | Executes the search.

Documentation for Models

- Synactaclient.Container
- Synactaclient.DocumentVersion
- Synactaclient.KeyValuePairStringString
- Synactaclient.Log
- Synactaclient.Organisation
- Synactaclient.PrincipalSearchResult
- Synactaclient.RecycleBinEntry
- Synactaclient.Right
- Synactaclient.Role

Documentation for Authorization

All endpoints do not require authorization.