1.0.0 • Published 8 years ago

synactaclient v1.0.0

Weekly downloads
1
License
Apache-2.0
Repository
-
Last release
8 years ago

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

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

git

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

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

ClassMethodHTTP requestDescription
Synactaclient.AuthorizationApiapiAuthorizationPrincipalsByIdGetGET /_api/authorization/Principals/{id}Provides a principal by his identifier.
Synactaclient.AuthorizationApiapiAuthorizationPrincipalsGetGET /_api/authorization/PrincipalsGets the principals.
Synactaclient.AuthorizationApiapiAuthorizationRightsGetGET /_api/authorization/RightsGets the rights.
Synactaclient.AuthorizationApiapiAuthorizationRolesAddGetGET /_api/authorization/Roles/AddGets the role container.
Synactaclient.AuthorizationApiapiAuthorizationRolesAddPutPUT /_api/authorization/Roles/AddAdds the role.
Synactaclient.AuthorizationApiapiAuthorizationRolesByIdDeleteDELETE /_api/authorization/Roles/{id}Deletes the role.
Synactaclient.AuthorizationApiapiAuthorizationRolesByIdGetGET /_api/authorization/Roles/{id}Gets the role.
Synactaclient.AuthorizationApiapiAuthorizationRolesByIdPostPOST /_api/authorization/Roles/{id}Updates the role.
Synactaclient.AuthorizationApiapiAuthorizationRolesGetGET /_api/authorization/RolesGets the roles.
Synactaclient.BaseApiapiBaseByTypeByIdAddByNewContainerTypeGetGET /_api/base/{type}/{id}/Add/{newContainerType}Gets the empty container.
Synactaclient.BaseApiapiBaseByTypeByIdAddPutPUT /_api/base/{type}/{id}/AddSaves the new container.
Synactaclient.BaseApiapiBaseByTypeByIdCheckinPutPUT /_api/base/{type}/{id}/CheckinCheckins the specified .
Synactaclient.BaseApiapiBaseByTypeByIdCheckoutPutPUT /_api/base/{type}/{id}/CheckoutCheckouts the specified .
Synactaclient.BaseApiapiBaseByTypeByIdChildrenGetGET /_api/base/{type}/{id}/ChildrenGets the children of container.
Synactaclient.BaseApiapiBaseByTypeByIdChildrenTypesGetGET /_api/base/{type}/{id}/Children/TypesGets the container types.
Synactaclient.BaseApiapiBaseByTypeByIdDeleteDELETE /_api/base/{type}/{id}Deletes the container.
Synactaclient.BaseApiapiBaseByTypeByIdDocumentsGetGET /_api/base/{type}/{id}/DocumentsGets the documents.
Synactaclient.BaseApiapiBaseByTypeByIdDocumentsTypesGetGET /_api/base/{type}/{id}/Documents/TypesGets the documents types.
Synactaclient.BaseApiapiBaseByTypeByIdGetGET /_api/base/{type}/{id}Gets the container by identifier.
Synactaclient.BaseApiapiBaseByTypeByIdGetFileGetGET /_api/base/{type}/{id}/GetFileGets the file.
Synactaclient.BaseApiapiBaseByTypeByIdLookupListByLookupListNameGetGET /_api/base/{type}/{id}/LookupList/{lookupListName}Gets the lookup list entries.
Synactaclient.BaseApiapiBaseByTypeByIdMovePostPOST /_api/base/{type}/{id}/MoveMoves the object.
Synactaclient.BaseApiapiBaseByTypeByIdPostPOST /_api/base/{type}/{id}Updates the container.
Synactaclient.BaseApiapiBaseByTypeByIdUploadFilePostPOST /_api/base/{type}/{id}/UploadFileUploads the file.
Synactaclient.BaseApiapiBaseByTypeByIdVersionsByVersionIdGetGET /_api/base/{type}/{id}/Versions/{versionId}Gets the version by identifier.
Synactaclient.BaseApiapiBaseByTypeByIdVersionsByVersionIdGetFileGetGET /_api/base/{type}/{id}/Versions/{versionId}/GetFileGets the file for version.
Synactaclient.BaseApiapiBaseByTypeByIdVersionsByVersionIdRestorePostPOST /_api/base/{type}/{id}/Versions/{versionId}/RestoreRestores the version.
Synactaclient.BaseApiapiBaseByTypeByIdVersionsGetGET /_api/base/{type}/{id}/VersionsGets the versions.
Synactaclient.BaseApiapiBaseByTypeGetGET /_api/base/{type}Gets containers by a type.
Synactaclient.BaseApiapiBaseRootGetGET /_api/base/RootGets the root.
Synactaclient.BaseApiapiBaseTypesGetGET /_api/base/TypesGets the container types.
Synactaclient.LoggingApiapiLogAddGetGET /_api/log/AddGets the log container.
Synactaclient.LoggingApiapiLogAddPutPUT /_api/log/AddAdds the log.
Synactaclient.LoggingApiapiLogGetGET /_api/logGets all logs.
Synactaclient.OrganisationApiapiOrgByIdAddGetGET /_api/org/{id}/AddGets the new organisation.
Synactaclient.OrganisationApiapiOrgByIdAddPutPUT /_api/org/{id}/AddSaves the new organisation.
Synactaclient.OrganisationApiapiOrgByIdByTypeGetGET /_api/org/{id}/{type}Gets all containers.
Synactaclient.OrganisationApiapiOrgByIdChildrenGetGET /_api/org/{id}/ChildrenGets the child organisations.
Synactaclient.OrganisationApiapiOrgByIdDeleteDELETE /_api/org/{id}Deletes the organisation.
Synactaclient.OrganisationApiapiOrgByIdGetGET /_api/org/{id}Gets the organisation.
Synactaclient.OrganisationApiapiOrgByIdMovePostPOST /_api/org/{id}/MoveMoves the organisation.
Synactaclient.OrganisationApiapiOrgByIdPostPOST /_api/org/{id}Updates the organisation.
Synactaclient.OrganisationApiapiOrgByIdRecycleBinByRecycleBinIdGetGET /_api/org/{id}/RecycleBin/{recycleBinId}Gets the recycle bin entry.
Synactaclient.OrganisationApiapiOrgByIdRecycleBinByRecycleBinIdRestorePostPOST /_api/org/{id}/RecycleBin/{recycleBinId}/RestoreRestores the recycle bin entry.
Synactaclient.OrganisationApiapiOrgByIdRecycleBinGetGET /_api/org/{id}/RecycleBinGets the recycle bin.
Synactaclient.OrganisationApiapiOrgGetGET /_api/orgGets all organisations.
Synactaclient.OrganisationApiapiOrgOrgTreeGetGET /_api/org/OrgTreeGets all organisations with childs.
Synactaclient.SearchApiapiSearchGetGET /_api/searchExecutes the search.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.