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 |
downloadPartFile | GET /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/{subType}/{fileName} | Download part file with a sub type |
uploadAttachedFiles | POST /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/attachedfiles | Upload attached file |
uploadNativeCADFile | POST /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/nativecad | Upload CAD file |
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.PartBinaryApi();
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 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.PartBinaryApi();
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
uploadAttachedFiles(workspaceId, partNumber, version, iteration, upload)
Upload attached file
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.PartBinaryApi();
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
uploadNativeCADFile(workspaceId, partNumber, version, iteration, upload)
Upload CAD file
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.PartBinaryApi();
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