All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
downloadDirectPartFile | GET /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/{fileName} | Download part file without a sub type |
downloadDocumentFile | GET /files/{workspaceId}/documents/{documentId}/{version}/{iteration}/{fileName} | Download document file |
downloadDocumentTemplateFile | GET /files/{workspaceId}/document-templates/{templateId}/{fileName} | Download document template file |
downloadFileFromPathData | GET /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/{fileName} | Download path data file |
downloadFileFromPathDataIteration | GET /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/iterations/{iteration}/{fileName} | Download path data iteration file |
downloadFileFromProductInstance | GET /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/iterations/{iteration}/{fileName} | Download product instance file |
downloadPartFile | GET /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/{subType}/{fileName} | Download part file with a sub type |
downloadPartTemplateFile | GET /files/{workspaceId}/part-templates/{templateId}/{fileName} | Download part template file |
uploadAttachedFiles | POST /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/attachedfiles | Upload attached file |
uploadDocumentFiles | POST /files/{workspaceId}/documents/{documentId}/{version}/{iteration} | Upload document file |
uploadDocumentTemplateFiles | POST /files/{workspaceId}/document-templates/{templateId} | Upload document template file |
uploadFilesToPathDataIteration | POST /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/iterations/{iteration} | Upload path data iteration file |
uploadFilesToProductInstanceIteration | POST /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/iterations/{iteration} | Upload product instance files |
uploadNativeCADFile | POST /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/nativecad | Upload CAD file |
uploadPartTemplateFiles | POST /files/{workspaceId}/part-templates/{templateId} | Upload part template files |
File downloadDirectPartFile(workspaceId, partNumber, version, iteration, fileName, opts)
Download part file without a sub type
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var partNumber = "partNumber_example"; // String | Part number
var version = "version_example"; // String | Part version
var iteration = 56; // Number | Part iteration
var fileName = "fileName_example"; // String | File name
var opts = {
'type': "type_example", // String | Type
'output': "output_example", // String | Output
'range': "range_example", // String | Range
'uuid': "uuid_example", // String | Shared entity uuid
'password': "password_example", // String | Password for private resource
'token': "token_example" // String | Shared entity token
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.downloadDirectPartFile(workspaceId, partNumber, version, iteration, fileName, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
partNumber | String | Part number | |
version | String | Part version | |
iteration | Number | Part iteration | |
fileName | String | File name | |
type | String | Type | [optional] |
output | String | Output | [optional] |
range | String | Range | [optional] |
uuid | String | Shared entity uuid | [optional] |
password | String | Password for private resource | [optional] |
token | String | Shared entity token | [optional] |
File
No authorization required
File downloadDocumentFile(workspaceId, documentId, version, iteration, fileName, opts)
Download document file
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var documentId = "documentId_example"; // String | Document master id
var version = "version_example"; // String | Workspace version
var iteration = 56; // Number | Document iteration
var fileName = "fileName_example"; // String | File name
var opts = {
'type': "type_example", // String | Type
'output': "output_example", // String | Output
'range': "range_example", // String | Range
'uuid': "uuid_example", // String | Shared entity uuid
'password': "password_example", // String | Password for private resource
'token': "token_example" // String | Shared entity token
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.downloadDocumentFile(workspaceId, documentId, version, iteration, fileName, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
version | String | Workspace version | |
iteration | Number | Document iteration | |
fileName | String | File name | |
type | String | Type | [optional] |
output | String | Output | [optional] |
range | String | Range | [optional] |
uuid | String | Shared entity uuid | [optional] |
password | String | Password for private resource | [optional] |
token | String | Shared entity token | [optional] |
File
No authorization required
File downloadDocumentTemplateFile(workspaceId, templateId, fileName, opts)
Download document template file
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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var templateId = "templateId_example"; // String | Template id
var fileName = "fileName_example"; // String | File name
var opts = {
'range': "range_example", // String | Range
'type': "type_example", // String | Type
'output': "output_example" // String | Output
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.downloadDocumentTemplateFile(workspaceId, templateId, fileName, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
templateId | String | Template id | |
fileName | String | File name | |
range | String | Range | [optional] |
type | String | Type | [optional] |
output | String | Output | [optional] |
File
File downloadFileFromPathData(workspaceId, serialNumber, ciId, pathDataId, fileName, opts)
Download path data file
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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var serialNumber = "serialNumber_example"; // String | Serial number
var ciId = "ciId_example"; // String | Configuration item id
var pathDataId = 56; // Number | Path data master id
var fileName = "fileName_example"; // String | File name
var opts = {
'range': "range_example", // String | Range
'type': "type_example", // String | Type
'output': "output_example" // String | Output
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.downloadFileFromPathData(workspaceId, serialNumber, ciId, pathDataId, fileName, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
serialNumber | String | Serial number | |
ciId | String | Configuration item id | |
pathDataId | Number | Path data master id | |
fileName | String | File name | |
range | String | Range | [optional] |
type | String | Type | [optional] |
output | String | Output | [optional] |
File
File downloadFileFromPathDataIteration(workspaceId, serialNumber, ciId, pathDataId, iteration, fileName, opts)
Download path data iteration file
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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var serialNumber = "serialNumber_example"; // String | Serial number
var ciId = "ciId_example"; // String | Configuration item id
var pathDataId = 56; // Number | Path data master id
var iteration = 56; // Number | Path data iteration number
var fileName = "fileName_example"; // String | File name id
var opts = {
'range': "range_example", // String | Range
'type': "type_example", // String | Type
'output': "output_example" // String | Output
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.downloadFileFromPathDataIteration(workspaceId, serialNumber, ciId, pathDataId, iteration, fileName, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
serialNumber | String | Serial number | |
ciId | String | Configuration item id | |
pathDataId | Number | Path data master id | |
iteration | Number | Path data iteration number | |
fileName | String | File name id | |
range | String | Range | [optional] |
type | String | Type | [optional] |
output | String | Output | [optional] |
File
File downloadFileFromProductInstance(workspaceId, ciId, serialNumber, iteration, fileName, opts)
Download product instance file
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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var ciId = "ciId_example"; // String | Configuration item id
var serialNumber = "serialNumber_example"; // String | Serial number
var iteration = 56; // Number | Product instance iteration
var fileName = "fileName_example"; // String | File name
var opts = {
'range': "range_example", // String | Range
'type': "type_example", // String | Type
'output': "output_example" // String | Output
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.downloadFileFromProductInstance(workspaceId, ciId, serialNumber, iteration, fileName, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
serialNumber | String | Serial number | |
iteration | Number | Product instance iteration | |
fileName | String | File name | |
range | String | Range | [optional] |
type | String | Type | [optional] |
output | String | Output | [optional] |
File
File downloadPartFile(workspaceId, partNumber, version, iteration, subType, fileName, opts)
Download part file with a sub type
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var partNumber = "partNumber_example"; // String | Part number
var version = "version_example"; // String | Part version
var iteration = 56; // Number | Part iteration
var subType = "subType_example"; // String | File sub type
var fileName = "fileName_example"; // String | File name
var opts = {
'type': "type_example", // String | Type
'output': "output_example", // String | Output
'range': "range_example", // String | Range
'uuid': "uuid_example", // String | Shared entity uuid
'password': "password_example", // String | Password for private resource
'token': "token_example" // String | Shared entity token
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.downloadPartFile(workspaceId, partNumber, version, iteration, subType, fileName, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
partNumber | String | Part number | |
version | String | Part version | |
iteration | Number | Part iteration | |
subType | String | File sub type | |
fileName | String | File name | |
type | String | Type | [optional] |
output | String | Output | [optional] |
range | String | Range | [optional] |
uuid | String | Shared entity uuid | [optional] |
password | String | Password for private resource | [optional] |
token | String | Shared entity token | [optional] |
File
No authorization required
File downloadPartTemplateFile(workspaceId, templateId, fileName, opts)
Download part template file
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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var templateId = "templateId_example"; // String | Template id
var fileName = "fileName_example"; // String | File name
var opts = {
'range': "range_example" // String | Range
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.downloadPartTemplateFile(workspaceId, templateId, fileName, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
templateId | String | Template id | |
fileName | String | File name | |
range | String | Range | [optional] |
File
uploadAttachedFiles(workspaceId, partNumber, version, iteration, upload)
Upload attached file
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var partNumber = "partNumber_example"; // String | Part number
var version = "version_example"; // String | Part version
var iteration = 56; // Number | Part iteration
var upload = "/path/to/file.txt"; // File |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.uploadAttachedFiles(workspaceId, partNumber, version, iteration, upload, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
partNumber | String | Part number | |
version | String | Part version | |
iteration | Number | Part iteration | |
upload | File |
null (empty response body)
No authorization required
uploadDocumentFiles(workspaceId, documentId, version, iteration, upload)
Upload document file
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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var documentId = "documentId_example"; // String | Document master id
var version = "version_example"; // String | Workspace version
var iteration = 56; // Number | Document iteration
var upload = "/path/to/file.txt"; // File |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.uploadDocumentFiles(workspaceId, documentId, version, iteration, upload, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
version | String | Workspace version | |
iteration | Number | Document iteration | |
upload | File |
null (empty response body)
uploadDocumentTemplateFiles(workspaceId, templateId, upload)
Upload document template file
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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var templateId = "templateId_example"; // String | Template id
var upload = "/path/to/file.txt"; // File |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.uploadDocumentTemplateFiles(workspaceId, templateId, upload, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
templateId | String | Template id | |
upload | File |
null (empty response body)
uploadFilesToPathDataIteration(workspaceId, ciId, serialNumber, iteration, pathDataId, upload)
Upload path data iteration file
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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var ciId = "ciId_example"; // String | Configuration item id
var serialNumber = "serialNumber_example"; // String | Serial number
var iteration = 56; // Number | Product instance iteration
var pathDataId = 56; // Number | PathDataMaster Id
var upload = "/path/to/file.txt"; // File |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.uploadFilesToPathDataIteration(workspaceId, ciId, serialNumber, iteration, pathDataId, upload, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
serialNumber | String | Serial number | |
iteration | Number | Product instance iteration | |
pathDataId | Number | PathDataMaster Id | |
upload | File |
null (empty response body)
uploadFilesToProductInstanceIteration(workspaceId, ciId, serialNumber, iteration, upload)
Upload product instance 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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var ciId = "ciId_example"; // String | Configuration item id
var serialNumber = "serialNumber_example"; // String | Serial number
var iteration = 56; // Number | Product instance iteration
var upload = "/path/to/file.txt"; // File |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.uploadFilesToProductInstanceIteration(workspaceId, ciId, serialNumber, iteration, upload, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
ciId | String | Configuration item id | |
serialNumber | String | Serial number | |
iteration | Number | Product instance iteration | |
upload | File |
null (empty response body)
uploadNativeCADFile(workspaceId, partNumber, version, iteration, upload)
Upload CAD file
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var partNumber = "partNumber_example"; // String | Part number
var version = "version_example"; // String | Part version
var iteration = 56; // Number | Part iteration
var upload = "/path/to/file.txt"; // File |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.uploadNativeCADFile(workspaceId, partNumber, version, iteration, upload, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
partNumber | String | Part number | |
version | String | Part version | |
iteration | Number | Part iteration | |
upload | File |
null (empty response body)
No authorization required
uploadPartTemplateFiles(workspaceId, templateId, upload)
Upload part template 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.FilesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var templateId = "templateId_example"; // String | Template id
var upload = "/path/to/file.txt"; // File |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.uploadPartTemplateFiles(workspaceId, templateId, upload, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
templateId | String | Template id | |
upload | File |
null (empty response body)