DocdokuPlmApi.OrganizationsApi

All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api

Method	HTTP request	Description
addMember	PUT /organizations/add-member	Add a member to the authenticated user's organization
createOrganization	POST /organizations	Create authenticated user's organization
deleteOrganization	DELETE /organizations	Delete authenticated user's organization
getMembers	GET /organizations/members	Get members of the authenticated user's organization
getOrganization	GET /organizations	Get organization for authenticated user
moveMember	PUT /organizations/move-member	Move a member up or down in the authenticated user's organization
removeMember	PUT /organizations/remove-member	Remove a member to the authenticated user's organization
updateOrganization	PUT /organizations	Update authenticated user's organization

addMember

addMember(body)

Add a member to the authenticated user's organization

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.OrganizationsApi();

var body = new DocdokuPlmApi.UserDTO(); // UserDTO | User to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.addMember(body, callback);

Parameters

Name	Type	Description	Notes
body	UserDTO	User to add

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

createOrganization

OrganizationDTO createOrganization(body)

Create authenticated user's organization

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.OrganizationsApi();

var body = new DocdokuPlmApi.OrganizationDTO(); // OrganizationDTO | Organization to create


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

Parameters

Name	Type	Description	Notes
body	OrganizationDTO	Organization to create

Return type

OrganizationDTO

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

deleteOrganization

deleteOrganization()

Delete authenticated user's organization

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.OrganizationsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteOrganization(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getMembers

[AccountDTO] getMembers()

Get members of the authenticated user's organization

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.OrganizationsApi();

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

Parameters

This endpoint does not need any parameter.

Return type

[AccountDTO]

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getOrganization

OrganizationDTO getOrganization()

Get organization for authenticated user

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.OrganizationsApi();

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

Parameters

This endpoint does not need any parameter.

Return type

OrganizationDTO

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

moveMember

moveMember(body, direction)

Move a member up or down in the authenticated user's organization

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.OrganizationsApi();

var body = new DocdokuPlmApi.UserDTO(); // UserDTO | User to move up

var direction = "direction_example"; // String | Direction (up/down)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.moveMember(body, direction, callback);

Parameters

Name	Type	Description	Notes
body	UserDTO	User to move up
direction	String	Direction (up/down)

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

removeMember

removeMember(body)

Remove a member to the authenticated user's organization

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.OrganizationsApi();

var body = new DocdokuPlmApi.UserDTO(); // UserDTO | User to remove


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.removeMember(body, callback);

Parameters

Name	Type	Description	Notes
body	UserDTO	User to remove

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateOrganization

OrganizationDTO updateOrganization(body)

Update authenticated user's organization

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.OrganizationsApi();

var body = new DocdokuPlmApi.OrganizationDTO(); // OrganizationDTO | Updated organization


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

Parameters

Name	Type	Description	Notes
body	OrganizationDTO	Updated organization

Return type

OrganizationDTO

Authorization

authorization

HTTP request headers

Content-Type: application/json
Accept: application/json