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 |
ProductConfigurationDTO createConfiguration(workspaceId, body)
Create a new product configuration
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
body | ProductConfigurationDTO | Product configuration to create |
deleteProductConfiguration(workspaceId, ciId, productConfigurationId)
Delete product configuration
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
productConfigurationId | Number | Product configuration id |
null (empty response body)
[ProductConfigurationDTO] getAllConfigurations(workspaceId)
Get all product configurations in workspace
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id |
ProductConfigurationDTO getConfiguration(workspaceId, ciId, productConfigurationId)
Get product configuration by id
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
productConfigurationId | Number | Product configuration id |
[ProductConfigurationDTO] getConfigurationsForProduct(workspaceId, ciId)
Get all product configurations for given product
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id filter |
updateConfigurationACL(workspaceId, ciId, productConfigurationId, body)
Update product configuration ACL
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
productConfigurationId | Number | Product configuration id | |
body | ACLDTO | ACL rules to set |
null (empty response body)