Skip to content

OrganisationApi.md

Latest commit

 

History

History
647 lines (434 loc) · 17 KB

OrganisationApi.md

File metadata and controls

647 lines (434 loc) · 17 KB
Raw

Synactaclientjs.OrganisationApi

All URIs are relative to https://localhost/

Method HTTP request Description
apiOrgByIdAddGet GET /_api/org/{id}/Add Gets the new organisation.
apiOrgByIdAddPut PUT /_api/org/{id}/Add Saves the new organisation.
apiOrgByIdByTypeGet GET /_api/org/{id}/{type} Gets all containers.
apiOrgByIdChildrenGet GET /_api/org/{id}/Children Gets the child organisations.
apiOrgByIdDelete DELETE /_api/org/{id} Deletes the organisation.
apiOrgByIdGet GET /_api/org/{id} Gets the organisation.
apiOrgByIdMovePost POST /_api/org/{id}/Move Moves the organisation.
apiOrgByIdPost POST /_api/org/{id} Updates the organisation.
apiOrgByIdRecycleBinByRecycleBinIdGet GET /_api/org/{id}/RecycleBin/{recycleBinId} Gets the recycle bin entry.
apiOrgByIdRecycleBinByRecycleBinIdRestorePost POST /_api/org/{id}/RecycleBin/{recycleBinId}/Restore Restores the recycle bin entry.
apiOrgByIdRecycleBinGet GET /_api/org/{id}/RecycleBin Gets the recycle bin.
apiOrgGet GET /_api/org Gets all organisations.
apiOrgOrgTreeGet GET /_api/org/OrgTree Gets all organisations with childs.

apiOrgByIdAddGet

Organisation apiOrgByIdAddGet(id, authorization)

Gets the new organisation.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

var id = "id_example"; // String | The organisation 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.apiOrgByIdAddGet(id, authorization, callback);

Parameters

Name Type Description Notes
id String The organisation identifier.
authorization String access token

Return type

Organisation

Authorization

No authorization required

HTTP request headers

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

apiOrgByIdAddPut

Organisation apiOrgByIdAddPut(id, authorization, opts)

Saves the new organisation.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

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

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

var opts = { 
  'newOrganisation': new Synactaclientjs.Organisation() // Organisation | The new organisation.
};

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

Parameters

Name Type Description Notes
id String The organisation identifier.
authorization String access token
newOrganisation Organisation The new organisation. [optional]

Return type

Organisation

Authorization

No authorization required

HTTP request headers

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

apiOrgByIdByTypeGet

[Container] apiOrgByIdByTypeGet(id, type, authorization)

Gets all containers.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

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

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

Parameters

Name Type Description Notes
id String The organisation identifier.
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

apiOrgByIdChildrenGet

[Organisation] apiOrgByIdChildrenGet(id, authorization)

Gets the child organisations.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

var id = "id_example"; // String | The organisation 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.apiOrgByIdChildrenGet(id, authorization, callback);

Parameters

Name Type Description Notes
id String The organisation identifier.
authorization String access token

Return type

[Organisation]

Authorization

No authorization required

HTTP request headers

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

apiOrgByIdDelete

'Boolean' apiOrgByIdDelete(id, authorization)

Deletes the organisation.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

var id = "id_example"; // String | The organisation 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.apiOrgByIdDelete(id, authorization, callback);

Parameters

Name Type Description Notes
id String The organisation 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

apiOrgByIdGet

Organisation apiOrgByIdGet(id, authorization)

Gets the organisation.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

var id = "id_example"; // String | The organisation 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.apiOrgByIdGet(id, authorization, callback);

Parameters

Name Type Description Notes
id String The organisation identifier.
authorization String access token

Return type

Organisation

Authorization

No authorization required

HTTP request headers

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

apiOrgByIdMovePost

Organisation apiOrgByIdMovePost(id, authorization, opts)

Moves the organisation.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

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

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

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

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

Parameters

Name Type Description Notes
id String The organisation identifier.
authorization String access token
organisation Organisation The organisation. [optional]

Return type

Organisation

Authorization

No authorization required

HTTP request headers

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

apiOrgByIdPost

Organisation apiOrgByIdPost(id, authorization, opts)

Updates the organisation.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

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

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

var opts = { 
  'pOrganisation': new Synactaclientjs.Organisation() // Organisation | The organisation.
};

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

Parameters

Name Type Description Notes
id String The organisation identifier.
authorization String access token
pOrganisation Organisation The organisation. [optional]

Return type

Organisation

Authorization

No authorization required

HTTP request headers

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

apiOrgByIdRecycleBinByRecycleBinIdGet

RecycleBinEntry apiOrgByIdRecycleBinByRecycleBinIdGet(id, recycleBinId, authorization)

Gets the recycle bin entry.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

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

var recycleBinId = "recycleBinId_example"; // String | The recycle 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.apiOrgByIdRecycleBinByRecycleBinIdGet(id, recycleBinId, authorization, callback);

Parameters

Name Type Description Notes
id String The organisation identifier.
recycleBinId String The recycle identifier.
authorization String access token

Return type

RecycleBinEntry

Authorization

No authorization required

HTTP request headers

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

apiOrgByIdRecycleBinByRecycleBinIdRestorePost

Container apiOrgByIdRecycleBinByRecycleBinIdRestorePost(id, recycleBinId, authorization)

Restores the recycle bin entry.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

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

var recycleBinId = "recycleBinId_example"; // String | The recycle bin 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.apiOrgByIdRecycleBinByRecycleBinIdRestorePost(id, recycleBinId, authorization, callback);

Parameters

Name Type Description Notes
id String The organisation identifier.
recycleBinId String The recycle bin 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

apiOrgByIdRecycleBinGet

[RecycleBinEntry] apiOrgByIdRecycleBinGet(id, authorization)

Gets the recycle bin.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

var id = "id_example"; // String | The organisation 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.apiOrgByIdRecycleBinGet(id, authorization, callback);

Parameters

Name Type Description Notes
id String The organisation identifier.
authorization String access token

Return type

[RecycleBinEntry]

Authorization

No authorization required

HTTP request headers

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

apiOrgGet

[Organisation] apiOrgGet(authorization)

Gets all organisations.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

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.apiOrgGet(authorization, callback);

Parameters

Name Type Description Notes
authorization String access token

Return type

[Organisation]

Authorization

No authorization required

HTTP request headers

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

apiOrgOrgTreeGet

[Organisation] apiOrgOrgTreeGet(authorization)

Gets all organisations with childs.

Example

var Synactaclientjs = require('synactaclientjs');

var apiInstance = new Synactaclientjs.OrganisationApi();

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.apiOrgOrgTreeGet(authorization, callback);

Parameters

Name Type Description Notes
authorization String access token

Return type

[Organisation]

Authorization

No authorization required

HTTP request headers

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