1.0.12 • Published 7 years ago

synactaclientjs v1.0.12

Weekly downloads
3
License
Apache-2.0
Repository
-
Last release
7 years ago

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/

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

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

1.0.12

7 years ago

1.0.11

7 years ago

1.0.8

7 years ago

1.0.4

7 years ago

1.0.5

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.3

7 years ago

1.0.6

7 years ago

1.1.7

8 years ago