DocdokuPlmApi.ProductsApi

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

cascadeCheckin

CascadeResult cascadeCheckin(workspaceId, ciId, path, body, opts)

Cascade part revision check in with given config spec and path

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

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

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

var path = "path_example"; // String | Complete path to checkin from

var body = new DocdokuPlmApi.IterationNoteDTO(); // IterationNoteDTO | Iteration note to add

var opts = { 
  'configSpec': "configSpec_example" // String | Config spec
};

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

Parameters

Return type

CascadeResult

Authorization

authorization

HTTP request headers

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

cascadeCheckout

CascadeResult cascadeCheckout(workspaceId, ciId, path, opts)

Cascade part revision check out with given config spec and path

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

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

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

var path = "path_example"; // String | Complete path to checkout from

var opts = { 
  'configSpec': "configSpec_example" // String | Config spec
};

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

Parameters

Return type

CascadeResult

Authorization

authorization

HTTP request headers

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

cascadeUndoCheckOut

CascadeResult cascadeUndoCheckOut(workspaceId, ciId, path, opts)

Cascade part revision undo check out with given config spec and path

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

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

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

var path = "path_example"; // String | Complete path to undo checkout from

var opts = { 
  'configSpec': "configSpec_example" // String | Config spec
};

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

Parameters

Return type

CascadeResult

Authorization

authorization

HTTP request headers

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

createConfigurationItem

ConfigurationItemDTO createConfigurationItem(workspaceId, body)

Create a new 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.ProductsApi();

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

var body = new DocdokuPlmApi.ConfigurationItemDTO(); // ConfigurationItemDTO | Product to create


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

Parameters

Return type

ConfigurationItemDTO

Authorization

authorization

HTTP request headers

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

createLayer

LayerDTO createLayer(workspaceId, ciId, body)

Create a new layer for given product

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

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

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

var body = new DocdokuPlmApi.LayerDTO(); // LayerDTO | Layer to create


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

Parameters

Return type

LayerDTO

Authorization

authorization

HTTP request headers

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

createMarker

MarkerDTO createMarker(workspaceId, ciId, layerId, body)

Create a new marker in a given layer

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

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

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

var layerId = 56; // Number | Layer id

var body = new DocdokuPlmApi.MarkerDTO(); // MarkerDTO | Marker to create


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

Parameters

Return type

MarkerDTO

Authorization

authorization

HTTP request headers

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

createPathToPathLink

LightPathToPathLinkDTO createPathToPathLink(workspaceId, ciId, body)

Create a new 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.ProductsApi();

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

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

var body = new DocdokuPlmApi.LightPathToPathLinkDTO(); // LightPathToPathLinkDTO | Path to path link to create


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

Parameters

Return type

LightPathToPathLinkDTO

Authorization

authorization

HTTP request headers

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

decodePath

[LightPartLinkDTO] decodePath(workspaceId, ciId, path)

Decode given path as string

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

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

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

var path = "path_example"; // String | Complete path to decode


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

Parameters

Return type

[LightPartLinkDTO]

Authorization

authorization

HTTP request headers

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

deleteConfigurationItem

deleteConfigurationItem(workspaceId, ciId)

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

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.');
  }
};
apiInstance.deleteConfigurationItem(workspaceId, ciId, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteLayer

deleteLayer(workspaceId, ciId, layerId)

Delete layer

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

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

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

var layerId = 56; // Number | Layer id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteMarker

deleteMarker(workspaceId, ciId, layerId, markerId)

Delete marker

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

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

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

var layerId = 56; // Number | Layer id

var markerId = 56; // Number | Marker id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deletePathToPathLink

deletePathToPathLink(workspaceId, ciId, pathToPathLinkId)

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

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

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

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.');
  }
};
apiInstance.deletePathToPathLink(workspaceId, ciId, pathToPathLinkId, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

exportProductFiles

File exportProductFiles(workspaceId, ciId, opts)

Export files from configuration item with given config spec

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

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

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

var opts = { 
  'configSpecType': "configSpecType_example", // String | Config spec
  'exportNativeCADFiles': true, // Boolean | Export native cad files flag
  'exportDocumentLinks': true // Boolean | Export linked documents attached files flag
};

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

Parameters

Return type

File

Authorization

authorization

HTTP request headers

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

filterPart

[PartRevisionDTO] filterPart(workspaceId, ciId, opts)

Filter part with given config spec and path

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

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

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

var opts = { 
  'configSpec': "wip", // String | Config spec
  'path': "path_example", // String | Complete path of part
  'diverge': false // Boolean | Discover substitute links
};

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

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

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

filterProductStructure

ComponentDTO filterProductStructure(workspaceId, ciId, opts)

Filter product structure

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

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

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

var opts = { 
  'configSpec': "configSpec_example", // String | Config spec
  'path': "path_example", // String | Complete path of part
  'depth': 56, // Number | Depth to stop at
  'linkType': "linkType_example", // String | Type link to filter
  'diverge': true // Boolean | Discover substitute links
};

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

Parameters

Return type

ComponentDTO

Authorization

authorization

HTTP request headers

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

getBaselineCreationPathChoices

[PathChoiceDTO] getBaselineCreationPathChoices(workspaceId, ciId, opts)

Get baseline creation path choices

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

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

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

var opts = { 
  'type': "type_example" // String | Baseline type
};

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

Parameters

Return type

[PathChoiceDTO]

Authorization

authorization

HTTP request headers

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

getBaselineCreationVersionsChoices

[BaselinedPartDTO] getBaselineCreationVersionsChoices(workspaceId, ciId)

Get baseline creation version choices

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

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

Parameters

Return type

[BaselinedPartDTO]

Authorization

authorization

HTTP request headers

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

getConfigurationItem

ConfigurationItemDTO getConfigurationItem(workspaceId, ciId)

Get configuration item by 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.ProductsApi();

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

Parameters

Return type

ConfigurationItemDTO

Authorization

authorization

HTTP request headers

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

getConfigurationItems

[ConfigurationItemDTO] getConfigurationItems(workspaceId)

Get configuration items 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.ProductsApi();

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

Parameters

Return type

[ConfigurationItemDTO]

Authorization

authorization

HTTP request headers

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

getDocumentLinksForGivenPartIteration

[DocumentIterationLinkDTO] getDocumentLinksForGivenPartIteration(workspaceId, ciId, partNumber, partVersion, partIteration, configSpec)

Get document links for given part 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.ProductsApi();

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

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

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var partIteration = 56; // Number | Part iteration

var configSpec = "configSpec_example"; // String | Config spec


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

Parameters

Return type

[DocumentIterationLinkDTO]

Authorization

authorization

HTTP request headers

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

getFilteredInstances

[LeafDTO] getFilteredInstances(workspaceId, ciId, configSpec, path, opts)

Get instances under given path and config spec

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

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

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

var configSpec = "configSpec_example"; // String | Config spec

var path = "path_example"; // String | Complete path to start from

var opts = { 
  'diverge': true // Boolean | Discover substitute links
};

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

Parameters

Return type

[LeafDTO]

Authorization

authorization

HTTP request headers

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

getInstancesForMultiplePath

[LeafDTO] getInstancesForMultiplePath(workspaceId, ciId, body, opts)

Get instances for multiple paths

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

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

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

var body = new DocdokuPlmApi.PathListDTO(); // PathListDTO | List of paths to start from

var opts = { 
  'diverge': true // Boolean | Discover substitute links
};

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

Parameters

Return type

[LeafDTO]

Authorization

authorization

HTTP request headers

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

getLastRelease

PartRevisionDTO getLastRelease(workspaceId, ciId)

Get last release of part

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

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

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

getLayersInProduct

[LayerDTO] getLayersInProduct(workspaceId, ciId)

Get layers for given product

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

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

Parameters

Return type

[LayerDTO]

Authorization

authorization

HTTP request headers

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

getMarkersInLayer

[MarkerDTO] getMarkersInLayer(workspaceId, ciId, layerId)

Get markers of a given layer

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

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

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

var layerId = 56; // Number | Layer id


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

Parameters

Return type

[MarkerDTO]

Authorization

authorization

HTTP request headers

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

getPathToPathLinkInProduct

[PathToPathLinkDTO] getPathToPathLinkInProduct(workspaceId, ciId, sourcePath, targetPath)

Get path-to-path links from 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.ProductsApi();

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

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

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.getPathToPathLinkInProduct(workspaceId, ciId, sourcePath, targetPath, callback);

Parameters

Return type

[PathToPathLinkDTO]

Authorization

authorization

HTTP request headers

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

getPathToPathLinkTypesInProduct

[LightPathToPathLinkDTO] getPathToPathLinkTypesInProduct(workspaceId, ciId)

Get path-to-path links 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.ProductsApi();

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

Parameters

Return type

[LightPathToPathLinkDTO]

Authorization

authorization

HTTP request headers

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

searchConfigurationItemId

[ConfigurationItemDTO] searchConfigurationItemId(workspaceId, q)

Search configuration items by reference

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

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

var q = "q_example"; // String | Query


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

Parameters

Return type

[ConfigurationItemDTO]

Authorization

authorization

HTTP request headers

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

searchPaths

[PathDTO] searchPaths(workspaceId, ciId, search, opts)

Search paths with part reference or name

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

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

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

var search = "search_example"; // String | Search value

var opts = { 
  'configSpec': "configSpec_example", // String | Config spec
  'diverge': true // Boolean | Discover substitute links
};

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

Parameters

Return type

[PathDTO]

Authorization

authorization

HTTP request headers

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

updateLayer

LayerDTO updateLayer(workspaceId, ciId, layerId, body)

Update layer

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

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

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

var layerId = 56; // Number | Layer id

var body = new DocdokuPlmApi.LayerDTO(); // LayerDTO | Layer to update


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

Parameters

Return type

LayerDTO

Authorization

authorization

HTTP request headers

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

updatePathToPathLink

LightPathToPathLinkDTO updatePathToPathLink(workspaceId, ciId, pathToPathLinkId, body)

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

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

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

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

var body = new DocdokuPlmApi.LightPathToPathLinkDTO(); // LightPathToPathLinkDTO | Path to path link to update


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

Parameters

Return type

LightPathToPathLinkDTO

Authorization

authorization

HTTP request headers

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