DocdokuPlmApi.ProductInstancesApi

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

addNewPathDataIteration

PathDataMasterDTO addNewPathDataIteration(workspaceId, ciId, serialNumber, pathDataId, body)

Add new path-data iteration

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathDataId = 56; // Number | Path data master id

var body = new DocdokuPlmApi.PathDataIterationCreationDTO(); // PathDataIterationCreationDTO | Path data iteration to create


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

Parameters

Return type

PathDataMasterDTO

Authorization

authorization

HTTP request headers

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

createPathDataMaster

PathDataMasterDTO createPathDataMaster(workspaceId, ciId, serialNumber, path, body)

Create a new path-data in product-instance last iteration

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var path = "path_example"; // String | Complete path in context

var body = new DocdokuPlmApi.PathDataIterationCreationDTO(); // PathDataIterationCreationDTO | Path data iteration create


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

Parameters

Return type

PathDataMasterDTO

Authorization

authorization

HTTP request headers

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

createProductInstanceMaster

ProductInstanceMasterDTO createProductInstanceMaster(workspaceId, body)

Create a new product-instance

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

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

var body = new DocdokuPlmApi.ProductInstanceCreationDTO(); // ProductInstanceCreationDTO | Product instance master to create


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

Parameters

Return type

ProductInstanceMasterDTO

Authorization

authorization

HTTP request headers

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

deleteAttachedFileInPathData

deleteAttachedFileInPathData(workspaceId, ciId, serialNumber, pathDataId, iteration, fileName)

Delete product-instance's attached file

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathDataId = 56; // Number | Path data master id

var iteration = 56; // Number | Product instance iteration

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.deleteAttachedFileInPathData(workspaceId, ciId, serialNumber, pathDataId, iteration, fileName, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deletePathData

deletePathData(workspaceId, ciId, serialNumber, pathDataId)

Delete product-instance's path-data

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathDataId = 56; // Number | Path data master id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteProductInstanceMaster

deleteProductInstanceMaster(workspaceId, ciId, serialNumber)

Delete product-instance

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

getAllProductInstances

[ProductInstanceMasterDTO] getAllProductInstances(workspaceId)

Get product instances in 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.ProductInstancesApi();

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.getAllProductInstances(workspaceId, callback);

Parameters

Return type

[ProductInstanceMasterDTO]

Authorization

authorization

HTTP request headers

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

getPartFromPathLink

LightPartMasterDTO getPartFromPathLink(workspaceId, ciId, serialNumber, pathPart)

Get part from path-to-path link

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathPart = "pathPart_example"; // String | Complete path to the part


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

Parameters

Return type

LightPartMasterDTO

Authorization

authorization

HTTP request headers

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

getPathData

PathDataMasterDTO getPathData(workspaceId, ciId, serialNumber, path)

Get product-instance's last iteration path-data

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var path = "path_example"; // String | Complete path in context


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

Parameters

Return type

PathDataMasterDTO

Authorization

authorization

HTTP request headers

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

getPathToPathLink

LightPathToPathLinkDTO getPathToPathLink(workspaceId, ciId, serialNumber, pathToPathLinkId)

Get path-to-path link

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathToPathLinkId = 56; // Number | Path to path link id


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

Parameters

Return type

LightPathToPathLinkDTO

Authorization

authorization

HTTP request headers

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

getPathToPathLinkTypesInProductInstance

[LightPathToPathLinkDTO] getPathToPathLinkTypesInProductInstance(workspaceId, ciId, serialNumber)

Get path-to-path link types

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number


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

Parameters

Return type

[LightPathToPathLinkDTO]

Authorization

authorization

HTTP request headers

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

getPathToPathLinks

[LightPathToPathLinkDTO] getPathToPathLinks(workspaceId, ciId, serialNumber)

Get path-to-path links

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number


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

Parameters

Return type

[LightPathToPathLinkDTO]

Authorization

authorization

HTTP request headers

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

getPathToPathLinksForGivenSourceAndTarget

[LightPathToPathLinkDTO] getPathToPathLinksForGivenSourceAndTarget(workspaceId, ciId, serialNumber, sourcePath, targetPath)

Get path-to-path link for given source and target

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var sourcePath = "sourcePath_example"; // String | Complete source path

var targetPath = "targetPath_example"; // String | Complete target path


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

Parameters

Return type

[LightPathToPathLinkDTO]

Authorization

authorization

HTTP request headers

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

getProductInstance

ProductInstanceMasterDTO getProductInstance(workspaceId, ciId, serialNumber)

Get product-instance by serial number

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number


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

Parameters

Return type

ProductInstanceMasterDTO

Authorization

authorization

HTTP request headers

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

getProductInstanceIteration

ProductInstanceIterationDTO getProductInstanceIteration(workspaceId, ciId, serialNumber, iteration)

Get product-instance's iteration

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var iteration = 56; // Number | Product instance iteration


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

Parameters

Return type

ProductInstanceIterationDTO

Authorization

authorization

HTTP request headers

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

getProductInstanceIterations

[ProductInstanceIterationDTO] getProductInstanceIterations(workspaceId, ciId, serialNumber)

Get product-instance's iterations

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number


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

Parameters

Return type

[ProductInstanceIterationDTO]

Authorization

authorization

HTTP request headers

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

getProductInstances

[ProductInstanceMasterDTO] getProductInstances(workspaceId, ciId)

Get product-instance with given configuration item

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

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

var ciId = "ciId_example"; // String | Configuration item id


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

Parameters

Return type

[ProductInstanceMasterDTO]

Authorization

authorization

HTTP request headers

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

getRootPathToPathLinks

[LightPathToPathLinkDTO] getRootPathToPathLinks(workspaceId, ciId, serialNumber, type)

Get root path-to-path links

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var type = "type_example"; // String | Link type


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

Parameters

Return type

[LightPathToPathLinkDTO]

Authorization

authorization

HTTP request headers

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

importProductInstanceAttributes

importProductInstanceAttributes(workspaceId, opts)

Import attribute into product-instance

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

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

var opts = { 
  'autoFreezeAfterUpdate': true, // Boolean | Auto freeze after update flag
  'permissiveUpdate': true, // Boolean | Permissive update flag
  'revisionNote': "revisionNote_example" // String | Revision note to set
};

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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

rebaseProductInstance

rebaseProductInstance(workspaceId, ciId, serialNumber, body)

Rebase product-instance with given baseline

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var body = new DocdokuPlmApi.ProductBaselineDTO(); // ProductBaselineDTO | Product baseline to rebase with


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

removeAttachedFileFromProductInstance

removeAttachedFileFromProductInstance(workspaceId, iteration, ciId, serialNumber, fileName)

Remove attached file from product-instance

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

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

var iteration = 56; // Number | Product instance iteration

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

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.removeAttachedFileFromProductInstance(workspaceId, iteration, ciId, serialNumber, fileName, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

renameAttachedFileInPathData

FileDTO renameAttachedFileInPathData(workspaceId, ciId, serialNumber, pathDataId, iteration, fileName, body)

Rename product-instance's attached file

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathDataId = 56; // Number | Path data master id

var iteration = 56; // Number | Product instance iteration

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

var body = new DocdokuPlmApi.FileDTO(); // FileDTO | Renamed file


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

Parameters

Return type

FileDTO

Authorization

authorization

HTTP request headers

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

renameAttachedFileInProductInstance

FileDTO renameAttachedFileInProductInstance(workspaceId, ciId, serialNumber, iteration, fileName, body)

Rename attached file in product instance iteration

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var iteration = 56; // Number | Product instance iteration

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

var body = new DocdokuPlmApi.FileDTO(); // FileDTO | Renamed file


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

Parameters

Return type

FileDTO

Authorization

authorization

HTTP request headers

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

updatePathData

PathDataMasterDTO updatePathData(workspaceId, ciId, serialNumber, pathDataId, iteration, body)

Update path-data

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathDataId = 56; // Number | Path data master id

var iteration = 56; // Number | Product instance iteration

var body = new DocdokuPlmApi.PathDataIterationCreationDTO(); // PathDataIterationCreationDTO | Path data iteration to update


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

Parameters

Return type

PathDataMasterDTO

Authorization

authorization

HTTP request headers

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

updateProductInstanceACL

updateProductInstanceACL(workspaceId, ciId, serialNumber, body)

Update product-instance's 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.ProductInstancesApi();

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

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


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

updateProductInstanceMaster

ProductInstanceMasterDTO updateProductInstanceMaster(workspaceId, ciId, serialNumber, iteration, body)

Update product-instance

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var iteration = 56; // Number | Product instance iteration

var body = new DocdokuPlmApi.ProductInstanceIterationDTO(); // ProductInstanceIterationDTO | Product instance master to update


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

Parameters

Return type

ProductInstanceMasterDTO

Authorization

authorization

HTTP request headers

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