Synacta-jsclient NPM

synacta-jsclient

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

API version: v1
Package version: v1
Build date: 2016-05-13T14:34:31.590Z
Build package: class io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.agile-is.de/

Installation

For Node.js

npm

Install it via:

npm install synacta-jsclient --save

open the file ApiClient.js in javascript-client/src/ and change the basePath to your URL.

Maybe you need to add additional informations in the 'defaultHeader' or 'authentication' to authenticate.

bower

Install it via:

bower install synacta-jsclient

git

The library is hosted at a git repository, install it via:

https://github.com/AgileIS/Synacta-JSClient

For browser

Include synacta-jsclient.min.js in the HTML pages. Include synacta-clientconf.js in the HTML pages. Change the baseURL in synacta-clientconf.js to your URL.

In Script Block use:

var baseApi = new window.AIS.Synacta.repo.SynactaApi.BaseApi(); var orgApi = new window.AIS.Synacta.repo.SynactaApi.OrganisationApi(); ...

then with:

baseApi.apiBaseRootGet();

you start the request against the /base/root Route.

Getting Started

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

var Synacta = require('synacta-jsclient');

var baseApi = new Synacta.BaseApi();

var id = "id_example"; // {String} 


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

Documentation for API Endpoints

Class	Method	HTTP request
Synacta.AuthorizationApi	apiAuthorizationPrincipalsByIdGet	GET /_api/authorization/Principals/{id}
Synacta.AuthorizationApi	apiAuthorizationPrincipalsGet	GET /_api/authorization/Principals
Synacta.AuthorizationApi	apiAuthorizationRightsGet	GET /_api/authorization/Rights
Synacta.AuthorizationApi	apiAuthorizationRolesAddGet	GET /_api/authorization/Roles/Add
Synacta.AuthorizationApi	apiAuthorizationRolesByIdDelete	DELETE /_api/authorization/Roles/{id}
Synacta.AuthorizationApi	apiAuthorizationRolesByIdGet	GET /_api/authorization/Roles/{id}
Synacta.AuthorizationApi	apiAuthorizationRolesByIdPost	POST /_api/authorization/Roles/{id}
Synacta.AuthorizationApi	apiAuthorizationRolesGet	GET /_api/authorization/Roles
Synacta.AuthorizationApi	apiAuthorizationRolesPut	PUT /_api/authorization/Roles
Synacta.BaseApi	apiBaseByTypeByIdAddByNewContainerTypeGet	GET /_api/base/{type}/{id}/Add/{newContainerType}
Synacta.BaseApi	apiBaseByTypeByIdAddPut	PUT /_api/base/{type}/{id}/Add
Synacta.BaseApi	apiBaseByTypeByIdCheckinPut	PUT /_api/base/{type}/{id}/Checkin
Synacta.BaseApi	apiBaseByTypeByIdCheckoutPut	PUT /_api/base/{type}/{id}/Checkout
Synacta.BaseApi	apiBaseByTypeByIdChildrenGet	GET /_api/base/{type}/{id}/Children
Synacta.BaseApi	apiBaseByTypeByIdChildrenTypesGet	GET /_api/base/{type}/{id}/Children/Types
Synacta.BaseApi	apiBaseByTypeByIdDelete	DELETE /_api/base/{type}/{id}
Synacta.BaseApi	apiBaseByTypeByIdDocumentsGet	GET /_api/base/{type}/{id}/Documents
Synacta.BaseApi	apiBaseByTypeByIdDocumentsTypesGet	GET /_api/base/{type}/{id}/Documents/Types
Synacta.BaseApi	apiBaseByTypeByIdGet	GET /_api/base/{type}/{id}
Synacta.BaseApi	apiBaseByTypeByIdGetFileGet	GET /_api/base/{type}/{id}/GetFile
Synacta.BaseApi	apiBaseByTypeByIdLookupListByLookupListNameGet	GET /_api/base/{type}/{id}/LookupList/{lookupListName}
Synacta.BaseApi	apiBaseByTypeByIdMovePost	POST /_api/base/{type}/{id}/Move
Synacta.BaseApi	apiBaseByTypeByIdPost	POST /_api/base/{type}/{id}
Synacta.BaseApi	apiBaseByTypeByIdUploadFilePost	POST /_api/base/{type}/{id}/UploadFile
Synacta.BaseApi	apiBaseByTypeByIdVersionsByVersionIdGet	GET /_api/base/{type}/{id}/Versions/{versionId}
Synacta.BaseApi	apiBaseByTypeByIdVersionsByVersionIdGetFileGet	GET /_api/base/{type}/{id}/Versions/{versionId}/GetFile
Synacta.BaseApi	apiBaseByTypeByIdVersionsByVersionIdRestorePost	POST /_api/base/{type}/{id}/Versions/{versionId}/Restore
Synacta.BaseApi	apiBaseByTypeByIdVersionsGet	GET /_api/base/{type}/{id}/Versions
Synacta.BaseApi	apiBaseByTypeGet	GET /_api/base/{type}
Synacta.BaseApi	apiBaseRootGet	GET /_api/base/Root
Synacta.BaseApi	apiBaseTypesGet	GET /_api/base/Types
Synacta.LoggingApi	apiLogGet	GET /_api/log
Synacta.OrganisationApi	apiOrgByIdAddGet	GET /_api/org/{id}/Add
Synacta.OrganisationApi	apiOrgByIdAddPut	PUT /_api/org/{id}/Add
Synacta.OrganisationApi	apiOrgByIdByTypeGet	GET /_api/org/{id}/{type}
Synacta.OrganisationApi	apiOrgByIdChildrenGet	GET /_api/org/{id}/Children
Synacta.OrganisationApi	apiOrgByIdDelete	DELETE /_api/org/{id}
Synacta.OrganisationApi	apiOrgByIdGet	GET /_api/org/{id}
Synacta.OrganisationApi	apiOrgByIdMovePost	POST /_api/org/{id}/Move
Synacta.OrganisationApi	apiOrgByIdPost	POST /_api/org/{id}
Synacta.OrganisationApi	apiOrgByIdRecycleBinByRecycleIdGet	GET /_api/org/{id}/RecycleBin/{recycleId}
Synacta.OrganisationApi	apiOrgByIdRecycleBinByRecycleIdRestorePost	POST /_api/org/{id}/RecycleBin/{recycleId}/Restore
Synacta.OrganisationApi	apiOrgByIdRecycleBinGet	GET /_api/org/{id}/RecycleBin
Synacta.OrganisationApi	apiOrgGet	GET /_api/org
Synacta.OrganisationApi	apiOrgOrgTreeGet	GET /_api/org/OrgTree