Synactaclientjs.BaseApi

All URIs are relative to https://localhost/

Method	HTTP request	Description
apiBaseByTypeByIdAddByNewContainerTypeGet	GET /_api/base/{type}/{id}/Add/{newContainerType}	Gets the empty container.
apiBaseByTypeByIdAddPut	PUT /_api/base/{type}/{id}/Add	Saves the new container.
apiBaseByTypeByIdCheckinPut	PUT /_api/base/{type}/{id}/Checkin	Checkins the specified .
apiBaseByTypeByIdCheckoutPut	PUT /_api/base/{type}/{id}/Checkout	Checkouts the specified .
apiBaseByTypeByIdChildrenGet	GET /_api/base/{type}/{id}/Children	Gets the children of container.
apiBaseByTypeByIdChildrenTypesGet	GET /_api/base/{type}/{id}/Children/Types	Gets the container types.
apiBaseByTypeByIdDelete	DELETE /_api/base/{type}/{id}	Deletes the container.
apiBaseByTypeByIdDocumentsGet	GET /_api/base/{type}/{id}/Documents	Gets the documents.
apiBaseByTypeByIdDocumentsTypesGet	GET /_api/base/{type}/{id}/Documents/Types	Gets the documents types.
apiBaseByTypeByIdGet	GET /_api/base/{type}/{id}	Gets the container by identifier.
apiBaseByTypeByIdGetFileGet	GET /_api/base/{type}/{id}/GetFile	Gets the file.
apiBaseByTypeByIdLookupListByLookupListNameGet	GET /_api/base/{type}/{id}/LookupList/{lookupListName}	Gets the lookup list entries.
apiBaseByTypeByIdMovePost	POST /_api/base/{type}/{id}/Move	Moves the object.
apiBaseByTypeByIdPost	POST /_api/base/{type}/{id}	Updates the container.
apiBaseByTypeByIdUploadFilePost	POST /_api/base/{type}/{id}/UploadFile	Uploads the file.
apiBaseByTypeByIdVersionsByVersionIdGet	GET /_api/base/{type}/{id}/Versions/{versionId}	Gets the version by identifier.
apiBaseByTypeByIdVersionsByVersionIdGetFileGet	GET /_api/base/{type}/{id}/Versions/{versionId}/GetFile	Gets the file for version.
apiBaseByTypeByIdVersionsByVersionIdRestorePost	POST /_api/base/{type}/{id}/Versions/{versionId}/Restore	Restores the version.
apiBaseByTypeByIdVersionsGet	GET /_api/base/{type}/{id}/Versions	Gets the versions.
apiBaseByTypeGet	GET /_api/base/{type}	Gets containers by a type.
apiBaseRootGet	GET /_api/base/Root	Gets the root.
apiBaseTypesGet	GET /_api/base/Types	Gets the container types.

apiBaseByTypeByIdAddByNewContainerTypeGet

Container apiBaseByTypeByIdAddByNewContainerTypeGet(type, id, newContainerType, authorization)

Gets the empty container.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container identifier.

var newContainerType = "newContainerType_example"; // String | New type of the container.

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);
  }
};
apiInstance.apiBaseByTypeByIdAddByNewContainerTypeGet(type, id, newContainerType, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the container.
id	String	The container identifier.
newContainerType	String	New type of the container.
authorization	String	access token

Return type

Container

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdAddPut

Container apiBaseByTypeByIdAddPut(type, id, authorization, opts)

Saves the new container.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container identifier.

var authorization = "authorization_example"; // String | access token

var opts = { 
  'newContainer': new Synactaclientjs.Container() // Container | The new container.
};

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

Parameters

Name	Type	Description	Notes
type	String	Type of the container.
id	String	The container identifier.
authorization	String	access token
newContainer	Container	The new container.	[optional]

Return type

Container

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/json-patch+json
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdCheckinPut

Container apiBaseByTypeByIdCheckinPut(type, id, authorization, opts)

Checkins the specified .

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the document.

var id = "id_example"; // String | The document identifier.

var authorization = "authorization_example"; // String | access token

var opts = { 
  'container': new Synactaclientjs.Container() // Container | The container.
};

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

Parameters

Name	Type	Description	Notes
type	String	Type of the document.
id	String	The document identifier.
authorization	String	access token
container	Container	The container.	[optional]

Return type

Container

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/json-patch+json
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdCheckoutPut

Container apiBaseByTypeByIdCheckoutPut(type, id, authorization, opts)

Checkouts the specified .

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the document.

var id = "id_example"; // String | The document identifier.

var authorization = "authorization_example"; // String | access token

var opts = { 
  'container': new Synactaclientjs.Container() // Container | The container.
};

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

Parameters

Name	Type	Description	Notes
type	String	Type of the document.
id	String	The document identifier.
authorization	String	access token
container	Container	The container.	[optional]

Return type

Container

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/json-patch+json
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdChildrenGet

[Container] apiBaseByTypeByIdChildrenGet(type, id, authorization)

Gets the children of container.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container 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);
  }
};
apiInstance.apiBaseByTypeByIdChildrenGet(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the container.
id	String	The container identifier.
authorization	String	access token

Return type

[Container]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdChildrenTypesGet

['String'] apiBaseByTypeByIdChildrenTypesGet(type, id, authorization)

Gets the container types.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container 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);
  }
};
apiInstance.apiBaseByTypeByIdChildrenTypesGet(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the container.
id	String	The container identifier.
authorization	String	access token

Return type

['String']

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml

apiBaseByTypeByIdDelete

'Boolean' apiBaseByTypeByIdDelete(type, id, authorization)

Deletes the container.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container 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);
  }
};
apiInstance.apiBaseByTypeByIdDelete(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the container.
id	String	The container identifier.
authorization	String	access token

Return type

'Boolean'

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml

apiBaseByTypeByIdDocumentsGet

[Container] apiBaseByTypeByIdDocumentsGet(type, id, authorization)

Gets the documents.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container 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);
  }
};
apiInstance.apiBaseByTypeByIdDocumentsGet(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the container.
id	String	The container identifier.
authorization	String	access token

Return type

[Container]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdDocumentsTypesGet

['String'] apiBaseByTypeByIdDocumentsTypesGet(type, id, authorization)

Gets the documents types.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container 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);
  }
};
apiInstance.apiBaseByTypeByIdDocumentsTypesGet(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the container.
id	String	The container identifier.
authorization	String	access token

Return type

['String']

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml

apiBaseByTypeByIdGet

Container apiBaseByTypeByIdGet(type, id, authorization)

Gets the container by identifier.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container identifer.

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);
  }
};
apiInstance.apiBaseByTypeByIdGet(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the container.
id	String	The container identifer.
authorization	String	access token

Return type

Container

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdGetFileGet

apiBaseByTypeByIdGetFileGet(type, id, authorization)

Gets the file.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the document.

var id = "id_example"; // String | The document 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.');
  }
};
apiInstance.apiBaseByTypeByIdGetFileGet(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the document.
id	String	The document identifier.
authorization	String	access token

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

apiBaseByTypeByIdLookupListByLookupListNameGet

[KeyValuePairStringString] apiBaseByTypeByIdLookupListByLookupListNameGet(type, id, lookupListName, authorization)

Gets the lookup list entries.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container identifier.

var lookupListName = "lookupListName_example"; // String | Name of the lookup list.

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);
  }
};
apiInstance.apiBaseByTypeByIdLookupListByLookupListNameGet(type, id, lookupListName, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the container.
id	String	The container identifier.
lookupListName	String	Name of the lookup list.
authorization	String	access token

Return type

[KeyValuePairStringString]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml

apiBaseByTypeByIdMovePost

Container apiBaseByTypeByIdMovePost(type, id, authorization, opts)

Moves the object.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container identifier.

var authorization = "authorization_example"; // String | access token

var opts = { 
  'container': new Synactaclientjs.Container() // Container | The container.
};

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

Parameters

Name	Type	Description	Notes
type	String	Type of the container.
id	String	The container identifier.
authorization	String	access token
container	Container	The container.	[optional]

Return type

Container

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/json-patch+json
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdPost

Container apiBaseByTypeByIdPost(type, id, authorization, opts)

Updates the container.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

var id = "id_example"; // String | The container identifier.

var authorization = "authorization_example"; // String | access token

var opts = { 
  'newContainer': new Synactaclientjs.Container() // Container | The new container.
};

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

Parameters

Name	Type	Description	Notes
type	String	Type of the container.
id	String	The container identifier.
authorization	String	access token
newContainer	Container	The new container.	[optional]

Return type

Container

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/json-patch+json
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdUploadFilePost

apiBaseByTypeByIdUploadFilePost(type, id, authorization)

Uploads the file.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the document.

var id = "id_example"; // String | The document 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.');
  }
};
apiInstance.apiBaseByTypeByIdUploadFilePost(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the document.
id	String	The document identifier.
authorization	String	access token

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

apiBaseByTypeByIdVersionsByVersionIdGet

DocumentVersion apiBaseByTypeByIdVersionsByVersionIdGet(type, id, versionId, authorization)

Gets the version by identifier.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the document.

var id = "id_example"; // String | The document identifier.

var versionId = "versionId_example"; // String | The version 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);
  }
};
apiInstance.apiBaseByTypeByIdVersionsByVersionIdGet(type, id, versionId, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the document.
id	String	The document identifier.
versionId	String	The version identifier.
authorization	String	access token

Return type

DocumentVersion

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml

apiBaseByTypeByIdVersionsByVersionIdGetFileGet

apiBaseByTypeByIdVersionsByVersionIdGetFileGet(type, id, versionId, authorization)

Gets the file for version.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the document .

var id = "id_example"; // String | The document identifier.

var versionId = "versionId_example"; // String | The version 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.');
  }
};
apiInstance.apiBaseByTypeByIdVersionsByVersionIdGetFileGet(type, id, versionId, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the document .
id	String	The document identifier.
versionId	String	The version identifier.
authorization	String	access token

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

apiBaseByTypeByIdVersionsByVersionIdRestorePost

Container apiBaseByTypeByIdVersionsByVersionIdRestorePost(type, id, versionId, authorization)

Restores the version.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the document .

var id = "id_example"; // String | The document identifier.

var versionId = "versionId_example"; // String | The version 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);
  }
};
apiInstance.apiBaseByTypeByIdVersionsByVersionIdRestorePost(type, id, versionId, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the document .
id	String	The document identifier.
versionId	String	The version identifier.
authorization	String	access token

Return type

Container

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

apiBaseByTypeByIdVersionsGet

[DocumentVersion] apiBaseByTypeByIdVersionsGet(type, id, authorization)

Gets the versions.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the document.

var id = "id_example"; // String | The document 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);
  }
};
apiInstance.apiBaseByTypeByIdVersionsGet(type, id, authorization, callback);

Parameters

Name	Type	Description
type	String	Type of the document.
id	String	The document identifier.
authorization	String	access token

Return type

[DocumentVersion]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml

apiBaseByTypeGet

[Container] apiBaseByTypeGet(type, authorization)

Gets containers by a type.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

var type = "type_example"; // String | Type of the container.

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);
  }
};
apiInstance.apiBaseByTypeGet(type, authorization, callback);

Parameters

Name	Type	Description	Notes
type	String	Type of the container.
authorization	String	access token

Return type

[Container]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

apiBaseRootGet

[Container] apiBaseRootGet(authorization)

Gets the root.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

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);
  }
};
apiInstance.apiBaseRootGet(authorization, callback);

Parameters

Name	Type	Description	Notes
authorization	String	access token

Return type

[Container]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

apiBaseTypesGet

['String'] apiBaseTypesGet(authorization)

Gets the container types.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.BaseApi();

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);
  }
};
apiInstance.apiBaseTypesGet(authorization, callback);

Parameters

Name	Type	Description	Notes
authorization	String	access token

Return type

['String']

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json, application/xml, text/xml

Uh oh!

FilesExpand file tree

BaseApi.md

Latest commit

History

BaseApi.md

File metadata and controls

Synactaclientjs.BaseApi

apiBaseByTypeByIdAddByNewContainerTypeGet

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdAddPut

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdCheckinPut

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdCheckoutPut

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdChildrenGet

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdChildrenTypesGet

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdDocumentsGet

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdDocumentsTypesGet

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdGetFileGet

Example

Parameters

Return type

Authorization

HTTP request headers

apiBaseByTypeByIdLookupListByLookupListNameGet

Example

Parameters

Return type

Authorization

HTTP request headers