DocdokuPlmApi.ProductBaselineApi

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

Method HTTP request Description
createProductBaseline POST /workspaces/{workspaceId}/product-baselines Create a new product-baseline
deleteProductBaseline DELETE /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId} Delete product-baseline
getAllProductBaselines GET /workspaces/{workspaceId}/product-baselines Get product-baselines in given workspace
getPathToPathLinkInProductBaseline GET /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/path-to-path-links/source/{sourcePath}/target/{targetPath} Get product-baseline's path-to-path links for given source and target
getPathToPathLinkTypesInBaseline GET /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/path-to-path-links-types Get product-baseline's path-to-path links
getProductBaseline GET /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId} Get product-baseline by id
getProductBaselineParts GET /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/parts Get product-baseline's baselined parts
getProductBaselinesForProduct GET /workspaces/{workspaceId}/product-baselines/{ciId}/baselines Get product-baseline with given configuration item

createProductBaseline

ProductBaselineDTO createProductBaseline(workspaceId, body, opts)

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

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

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

var opts = { 
  'dryRun': true // Boolean | Dry run flag
};

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

Parameters

Name Type Description Notes
workspaceId String Workspace id
body ProductBaselineCreationDTO Product baseline to create
dryRun Boolean Dry run flag [optional]

Return type

ProductBaselineDTO

Authorization

authorization

HTTP request headers

deleteProductBaseline

deleteProductBaseline(workspaceId, ciId, baselineId)

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

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

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

var baselineId = 56; // Number | Baseline id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id
baselineId Number Baseline id

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

getAllProductBaselines

[ProductBaselineDTO] getAllProductBaselines(workspaceId)

Get product-baselines 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.ProductBaselineApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id

Return type

[ProductBaselineDTO]

Authorization

authorization

HTTP request headers

getPathToPathLinkInProductBaseline

[LightPathToPathLinkDTO] getPathToPathLinkInProductBaseline(workspaceId, ciId, baselineId, sourcePath, targetPath)

Get product-baseline's path-to-path links 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.ProductBaselineApi();

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

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

var baselineId = 56; // Number | Baseline id

var sourcePath = "sourcePath_example"; // String | Source path

var targetPath = "targetPath_example"; // String | Target path


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id
baselineId Number Baseline id
sourcePath String Source path
targetPath String Target path

Return type

[LightPathToPathLinkDTO]

Authorization

authorization

HTTP request headers

getPathToPathLinkTypesInBaseline

[LightPathToPathLinkDTO] getPathToPathLinkTypesInBaseline(workspaceId, ciId, baselineId)

Get product-baseline's 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.ProductBaselineApi();

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

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

var baselineId = 56; // Number | Baseline id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id
baselineId Number Baseline id

Return type

[LightPathToPathLinkDTO]

Authorization

authorization

HTTP request headers

getProductBaseline

ProductBaselineDTO getProductBaseline(workspaceId, ciId, baselineId)

Get product-baseline 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.ProductBaselineApi();

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

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

var baselineId = 56; // Number | Baseline id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id
baselineId Number Baseline id

Return type

ProductBaselineDTO

Authorization

authorization

HTTP request headers

getProductBaselineParts

[BaselinedPartDTO] getProductBaselineParts(workspaceId, ciId, baselineId, q)

Get product-baseline's baselined parts

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

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

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

var baselineId = 56; // Number | Baseline 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.getProductBaselineParts(workspaceId, ciId, baselineId, q, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id
baselineId Number Baseline id
q String Query

Return type

[BaselinedPartDTO]

Authorization

authorization

HTTP request headers

getProductBaselinesForProduct

[ProductBaselineDTO] getProductBaselinesForProduct(workspaceId, ciId)

Get product-baseline 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.ProductBaselineApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id

Return type

[ProductBaselineDTO]

Authorization

authorization

HTTP request headers