DocdokuPlmApi.AdminApi

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

Method	HTTP request	Description
createProvider	POST /admin/providers	Create a new OAuth provider
enableAccount	PUT /admin/accounts/{login}/enable	Enable or disable account
enableWorkspace	PUT /admin/workspace/{workspaceId}/enable	Enable or disable workspace
getAccounts	GET /admin/accounts	Get all registered accounts
getDetailedProvider	GET /admin/providers/{id}	Get detailed provider
getDetailedProviders	GET /admin/providers	Get detailed providers
getDiskSpaceUsageStats	GET /admin/disk-usage-stats	Get disk usage stats
getDocumentsStats	GET /admin/documents-stats	Get documents stats
getPartsStats	GET /admin/parts-stats	Get parts stats
getPlatformOptions	GET /admin/platform-options	Get platform options
getProductsStats	GET /admin/products-stats	Get products stats
getUsersStats	GET /admin/users-stats	Get users stats
indexAllWorkspaces	PUT /admin/index-all	Synchronize index for all workspaces
indexWorkspaceData	PUT /admin/index/{workspaceId}	Synchronize index for given workspace
removeProvider	DELETE /admin/providers/{id}	Delete OAuth provider
setPlatformOptions	PUT /admin/platform-options	Set platform options
updateAccount	PUT /admin/accounts	Update account
updateProvider	PUT /admin/providers/{id}	Update OAuth provider

createProvider

OAuthProviderPublicDTO createProvider(body)

Create a new OAuth provider

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

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


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

Parameters

Name	Type	Description	Notes
body	OAuthProviderPublicDTO	Updated account

Return type

OAuthProviderPublicDTO

Authorization

authorization

HTTP request headers

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

enableAccount

AccountDTO enableAccount(login, enabled)

Enable or disable 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.AdminApi();

var login = "login_example"; // String | Workspace id

var enabled = true; // Boolean | Enabled


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

Parameters

Name	Type	Description	Notes
login	String	Workspace id
enabled	Boolean	Enabled

Return type

AccountDTO

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

enableWorkspace

WorkspaceDTO enableWorkspace(workspaceId, enabled)

Enable or disable workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var enabled = true; // Boolean | Enabled


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

Parameters

Name	Type	Description	Notes
workspaceId	String	Workspace id
enabled	Boolean	Enabled

Return type

WorkspaceDTO

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAccounts

[AccountDTO] getAccounts()

Get all registered accounts

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

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

Parameters

This endpoint does not need any parameter.

Return type

[AccountDTO]

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDetailedProvider

OAuthProviderPublicDTO getDetailedProvider(id)

Get detailed provider

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

var id = 56; // Number | Provider id


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

Parameters

Name	Type	Description	Notes
id	Number	Provider id

Return type

OAuthProviderPublicDTO

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDetailedProviders

[OAuthProviderPublicDTO] getDetailedProviders()

Get detailed providers

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

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

Parameters

This endpoint does not need any parameter.

Return type

[OAuthProviderPublicDTO]

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDiskSpaceUsageStats

'String' getDiskSpaceUsageStats()

Get disk usage stats

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

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

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDocumentsStats

'String' getDocumentsStats()

Get documents stats

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

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

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getPartsStats

'String' getPartsStats()

Get parts stats

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

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

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getPlatformOptions

PlatformOptionsDTO getPlatformOptions()

Get platform options

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

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

Parameters

This endpoint does not need any parameter.

Return type

PlatformOptionsDTO

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getProductsStats

'String' getProductsStats()

Get products stats

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

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

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getUsersStats

'String' getUsersStats()

Get users stats

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

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

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

indexAllWorkspaces

indexAllWorkspaces()

Synchronize index for all workspaces

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

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.indexAllWorkspaces(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: Not defined

indexWorkspaceData

indexWorkspaceData(workspaceId)

Synchronize index for given workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id


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

Parameters

Name	Type	Description	Notes
workspaceId	String	Workspace id

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

removeProvider

removeProvider(id)

Delete OAuth provider

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

var id = 56; // Number | OAuthProvider id


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

Parameters

Name	Type	Description	Notes
id	Number	OAuthProvider id

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

setPlatformOptions

setPlatformOptions(opts)

Set platform options

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

var opts = { 
  'body': new DocdokuPlmApi.PlatformOptionsDTO() // PlatformOptionsDTO | Options to set
};

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

Parameters

Name	Type	Description	Notes
body	PlatformOptionsDTO	Options to set	[optional]

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

updateAccount

AccountDTO updateAccount(body)

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

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

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

updateProvider

OAuthProviderPublicDTO updateProvider(id, body)

Update OAuth provider

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

var id = 56; // Number | OAuthProvider id

var body = new DocdokuPlmApi.OAuthProviderPublicDTO(); // OAuthProviderPublicDTO | Updated provider


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

Parameters

Name	Type	Description	Notes
id	Number	OAuthProvider id
body	OAuthProviderPublicDTO	Updated provider

Return type

OAuthProviderPublicDTO

Authorization

authorization

HTTP request headers

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