DocdokuPlmApi.PartTemplatesApi

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

createPartMasterTemplate

PartMasterTemplateDTO createPartMasterTemplate(workspaceId, body)

Crate a new part master template

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

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

var body = new DocdokuPlmApi.PartTemplateCreationDTO(); // PartTemplateCreationDTO | Part master template to create


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

Parameters

Return type

PartMasterTemplateDTO

Authorization

authorization

HTTP request headers

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

deletePartMasterTemplate

deletePartMasterTemplate(workspaceId, templateId)

Delete part master template

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

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

var templateId = "templateId_example"; // String | Template id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

generatePartMasterTemplateId

TemplateGeneratedIdDTO generatePartMasterTemplateId(workspaceId, templateId)

Generate part master template id

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

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

var templateId = "templateId_example"; // String | Template id


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

Parameters

Return type

TemplateGeneratedIdDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPartMasterTemplate

PartMasterTemplateDTO getPartMasterTemplate(workspaceId, templateId)

Get part master template

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

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

var templateId = "templateId_example"; // String | Template id


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

Parameters

Return type

PartMasterTemplateDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPartMasterTemplates

[PartMasterTemplateDTO] getPartMasterTemplates(workspaceId)

Get part master templates

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

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


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

Parameters

Return type

[PartMasterTemplateDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

removeAttachedFileFromPartTemplate

removeAttachedFileFromPartTemplate(workspaceId, templateId, fileName)

Remove attached file from part master template

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

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

var templateId = "templateId_example"; // String | Template id

var fileName = "fileName_example"; // String | File name


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

renameAttachedFileInPartTemplate

FileDTO renameAttachedFileInPartTemplate(workspaceId, templateId, fileName, body)

Rename attached file in part master template

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

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

var templateId = "templateId_example"; // String | Template id

var fileName = "fileName_example"; // String | File name

var body = new DocdokuPlmApi.FileDTO(); // FileDTO | File to rename


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

Parameters

Return type

FileDTO

Authorization

authorization

HTTP request headers

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

updatePartMasterTemplate

PartMasterTemplateDTO updatePartMasterTemplate(workspaceId, templateId, body)

Update part master template

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

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

var templateId = "templateId_example"; // String | Template id

var body = new DocdokuPlmApi.PartMasterTemplateDTO(); // PartMasterTemplateDTO | Part master template to update


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

Parameters

Return type

PartMasterTemplateDTO

Authorization

authorization

HTTP request headers

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

updatePartMasterTemplateACL

updatePartMasterTemplateACL(workspaceId, templateId, body)

Update part master template ACL

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

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

var templateId = "templateId_example"; // String | Template id

var body = new DocdokuPlmApi.ACLDTO(); // ACLDTO | ACL rules to set


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: Not defined