DocdokuPlmApi.ProductConfigurationsApi

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

Method HTTP request Description
createConfiguration POST /workspaces/{workspaceId}/product-configurations Create a new product configuration
deleteProductConfiguration DELETE /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId} Delete product configuration
getAllConfigurations GET /workspaces/{workspaceId}/product-configurations Get all product configurations in workspace
getConfiguration GET /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId} Get product configuration by id
getConfigurationsForProduct GET /workspaces/{workspaceId}/product-configurations/{ciId}/configurations Get all product configurations for given product
updateConfigurationACL PUT /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId}/acl Update product configuration ACL

createConfiguration

ProductConfigurationDTO createConfiguration(workspaceId, body)

Create a new product configuration

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

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

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


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
body ProductConfigurationDTO Product configuration to create

Return type

ProductConfigurationDTO

Authorization

authorization

HTTP request headers

deleteProductConfiguration

deleteProductConfiguration(workspaceId, ciId, productConfigurationId)

Delete product configuration

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

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

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

var productConfigurationId = 56; // Number | Product configuration id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id
productConfigurationId Number Product configuration id

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

getAllConfigurations

[ProductConfigurationDTO] getAllConfigurations(workspaceId)

Get all product configurations in 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.ProductConfigurationsApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id

Return type

[ProductConfigurationDTO]

Authorization

authorization

HTTP request headers

getConfiguration

ProductConfigurationDTO getConfiguration(workspaceId, ciId, productConfigurationId)

Get product configuration 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.ProductConfigurationsApi();

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

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

var productConfigurationId = 56; // Number | Product configuration id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id
productConfigurationId Number Product configuration id

Return type

ProductConfigurationDTO

Authorization

authorization

HTTP request headers

getConfigurationsForProduct

[ProductConfigurationDTO] getConfigurationsForProduct(workspaceId, ciId)

Get all product configurations 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.ProductConfigurationsApi();

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

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


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

Parameters

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

Return type

[ProductConfigurationDTO]

Authorization

authorization

HTTP request headers

updateConfigurationACL

updateConfigurationACL(workspaceId, ciId, productConfigurationId, body)

Update product configuration 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.ProductConfigurationsApi();

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

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

var productConfigurationId = 56; // Number | Product configuration 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.updateConfigurationACL(workspaceId, ciId, productConfigurationId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
ciId String Configuration item id
productConfigurationId Number Product configuration id
body ACLDTO ACL rules to set

Return type

null (empty response body)

Authorization

authorization

HTTP request headers