DocdokuPlmApi.DocumentTemplateBinaryApi

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

Method HTTP request Description
downloadDocumentTemplateFile GET /files/{workspaceId}/document-templates/{templateId}/{fileName} Download document template file
uploadDocumentTemplateFiles POST /files/{workspaceId}/document-templates/{templateId} Upload document template file

downloadDocumentTemplateFile

File downloadDocumentTemplateFile(workspaceId, templateId, fileName, opts)

Download document template 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.DocumentTemplateBinaryApi();

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

Parameters

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]

Return type

File

Authorization

authorization

HTTP request headers

uploadDocumentTemplateFiles

uploadDocumentTemplateFiles(workspaceId, templateId, upload)

Upload document template 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.DocumentTemplateBinaryApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id
templateId String Template id
upload File

Return type

null (empty response body)

Authorization

authorization

HTTP request headers