synactaclientjs

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

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

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 synactaclientjs --save

git

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

    npm install YOUR_USERNAME/synactaclientjs --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.

Getting Started

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

var Synactaclientjs = require('synactaclientjs');

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

Documentation for Models

• Synactaclientjs.Container
• Synactaclientjs.DocumentVersion
• Synactaclientjs.KeyValuePairStringString
• Synactaclientjs.Log
• Synactaclientjs.Organisation
• Synactaclientjs.PrincipalSearchResult
• Synactaclientjs.RecycleBinEntry
• Synactaclientjs.Right
• Synactaclientjs.Role

Documentation for Authorization

All endpoints do not require authorization.