DocdokuPlmApi.DocumentBinaryApi

All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api

downloadDocumentFile

File downloadDocumentFile(workspaceId, documentId, version, iteration, fileName, opts)

Download document file

Example

var DocdokuPlmApi = require('docdoku-plm-api');

var apiInstance = new DocdokuPlmApi.DocumentBinaryApi();

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);

Parameters

Return type

File

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/octet-stream

uploadDocumentFiles

uploadDocumentFiles(workspaceId, documentId, version, iteration, upload)

Upload document file

Example

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.DocumentBinaryApi();

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);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: multipart/form-data
• Accept: Not defined