All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
createLayer | POST /workspaces/{workspaceId}/products/{ciId}/layers | Create a new layer for given product |
createMarker | POST /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markers | Create a new marker in a given layer |
deleteLayer | DELETE /workspaces/{workspaceId}/products/{ciId}/layers/{layerId} | Delete layer |
deleteMarker | DELETE /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markers/{markerId} | Delete marker |
getLayersInProduct | GET /workspaces/{workspaceId}/products/{ciId}/layers | Get layers for given product |
getMarkersInLayer | GET /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markers | Get markers of a given layer |
updateLayer | PUT /workspaces/{workspaceId}/products/{ciId}/layers/{layerId} | Update layer |
LayerDTO createLayer(workspaceId, ciId, body)
Create a new layer 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.LayersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
body | LayerDTO | Layer to create |
MarkerDTO createMarker(workspaceId, ciId, layerId, body)
Create a new marker in a given layer
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.LayersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
layerId | Number | Layer id | |
body | MarkerDTO | Marker to create |
deleteLayer(workspaceId, ciId, layerId)
Delete layer
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.LayersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
layerId | Number | Layer id |
null (empty response body)
deleteMarker(workspaceId, ciId, layerId, markerId)
Delete marker
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.LayersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
layerId | Number | Layer id | |
markerId | Number | Marker id |
null (empty response body)
[LayerDTO] getLayersInProduct(workspaceId, ciId)
Get layers 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.LayersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id |
[MarkerDTO] getMarkersInLayer(workspaceId, ciId, layerId)
Get markers of a given layer
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.LayersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
layerId | Number | Layer id |
LayerDTO updateLayer(workspaceId, ciId, layerId, body)
Update layer
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.LayersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
layerId | Number | Layer id | |
body | LayerDTO | Layer to update |