DocdokuPlmApi.AccountsApi

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

Method HTTP request Description
createAccount POST /accounts/create Create a new account
deleteGCMAccount DELETE /accounts/gcm Update GCM account for authenticated user
getAccount GET /accounts/me Get authenticated user's account
getWorkspaces GET /accounts/workspaces Get workspaces where authenticated user is active
setGCMAccount PUT /accounts/gcm Update GCM account for authenticated user
updateAccount PUT /accounts/me Update user's account

createAccount

AccountDTO createAccount(body)

Create a new account

Example

var DocdokuPlmApi = require('docdoku-plm-api');

var apiInstance = new DocdokuPlmApi.AccountsApi();

var body = new DocdokuPlmApi.AccountDTO(); // AccountDTO | Account to create


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

Parameters

Name Type Description Notes
body AccountDTO Account to create

Return type

AccountDTO

Authorization

No authorization required

HTTP request headers

deleteGCMAccount

deleteGCMAccount()

Update GCM account 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.AccountsApi();

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

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

getAccount

AccountDTO getAccount()

Get authenticated user's account

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.AccountsApi();

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

Parameters

This endpoint does not need any parameter.

Return type

AccountDTO

Authorization

authorization

HTTP request headers

getWorkspaces

[WorkspaceDTO] getWorkspaces()

Get workspaces where authenticated user is active

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.AccountsApi();

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

Parameters

This endpoint does not need any parameter.

Return type

[WorkspaceDTO]

Authorization

authorization

HTTP request headers

setGCMAccount

setGCMAccount(body)

Update GCM account 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.AccountsApi();

var body = new DocdokuPlmApi.GCMAccountDTO(); // GCMAccountDTO | GCM account to set


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

Parameters

Name Type Description Notes
body GCMAccountDTO GCM account to set

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

updateAccount

AccountDTO updateAccount(body)

Update user's account

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.AccountsApi();

var body = new DocdokuPlmApi.AccountDTO(); // AccountDTO | Updated account


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

Parameters

Name Type Description Notes
body AccountDTO Updated account

Return type

AccountDTO

Authorization

authorization

HTTP request headers