All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
createDocumentBaseline | POST /workspaces/{workspaceId}/document-baselines | Create a new document baseline |
deleteBaseline | DELETE /workspaces/{workspaceId}/document-baselines/{baselineId} | Delete a document baseline |
exportDocumentFiles | GET /workspaces/{workspaceId}/document-baselines/{baselineId}/export-files | Export document baseline's files |
getBaseline | GET /workspaces/{workspaceId}/document-baselines/{baselineId} | Get document baseline by id |
getBaselineLight | GET /workspaces/{workspaceId}/document-baselines/{baselineId}-light | Get document baseline in a light format |
getDocumentBaselines | GET /workspaces/{workspaceId}/document-baselines | Get document baselines |
DocumentBaselineDTO createDocumentBaseline(workspaceId, body)
Create a new document baseline
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.DocumentBaselineApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var body = new DocdokuPlmApi.DocumentBaselineDTO(); // DocumentBaselineDTO | Document baseline to create
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.createDocumentBaseline(workspaceId, body, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
body | DocumentBaselineDTO | Document baseline to create |
deleteBaseline(workspaceId, baselineId)
Delete a document baseline
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.DocumentBaselineApi();
var workspaceId = "workspaceId_example"; // String | Workspace 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.deleteBaseline(workspaceId, baselineId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
baselineId | Number | Baseline id |
null (empty response body)
File exportDocumentFiles(workspaceId, baselineId)
Export document baseline's files
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.DocumentBaselineApi();
var workspaceId = "workspaceId_example"; // String | Workspace 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.exportDocumentFiles(workspaceId, baselineId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
baselineId | Number | Baseline id |
File
DocumentBaselineDTO getBaseline(workspaceId, baselineId)
Get document baseline 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.DocumentBaselineApi();
var workspaceId = "workspaceId_example"; // String | Workspace 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.getBaseline(workspaceId, baselineId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
baselineId | Number | Baseline id |
DocumentBaselineDTO getBaselineLight(workspaceId, baselineId)
Get document baseline in a light format
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.DocumentBaselineApi();
var workspaceId = "workspaceId_example"; // String | Workspace 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.getBaselineLight(workspaceId, baselineId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
baselineId | Number | Baseline id |
[DocumentBaselineDTO] getDocumentBaselines(workspaceId)
Get document baselines
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.DocumentBaselineApi();
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.getDocumentBaselines(workspaceId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id |