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 |
AccountDTO createAccount(body)
Create a new account
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);
Name | Type | Description | Notes |
---|---|---|---|
body | AccountDTO | Account to create |
No authorization required
deleteGCMAccount()
Update GCM account for authenticated user
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);
This endpoint does not need any parameter.
null (empty response body)
AccountDTO getAccount()
Get authenticated user's account
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);
This endpoint does not need any parameter.
[WorkspaceDTO] getWorkspaces()
Get workspaces where authenticated user is active
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);
This endpoint does not need any parameter.
setGCMAccount(body)
Update GCM account for authenticated user
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);
Name | Type | Description | Notes |
---|---|---|---|
body | GCMAccountDTO | GCM account to set |
null (empty response body)
AccountDTO updateAccount(body)
Update user's account
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);
Name | Type | Description | Notes |
---|---|---|---|
body | AccountDTO | Updated account |