DocdokuPlmApi.ProductInstanceBinaryApi

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

Method	HTTP request	Description
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
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

downloadFileFromPathData

File downloadFileFromPathData(workspaceId, serialNumber, ciId, pathDataId, fileName, opts)

Download path data 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.ProductInstanceBinaryApi();

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

Parameters

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]

Return type

File

Authorization

authorization

HTTP request headers

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

downloadFileFromPathDataIteration

File downloadFileFromPathDataIteration(workspaceId, serialNumber, ciId, pathDataId, iteration, fileName, opts)

Download path data iteration 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.ProductInstanceBinaryApi();

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

Parameters

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]

Return type

File

Authorization

authorization

HTTP request headers

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

downloadFileFromProductInstance

File downloadFileFromProductInstance(workspaceId, ciId, serialNumber, iteration, fileName, opts)

Download product instance 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.ProductInstanceBinaryApi();

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

Parameters

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]

Return type

File

Authorization

authorization

HTTP request headers

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

uploadFilesToPathDataIteration

uploadFilesToPathDataIteration(workspaceId, ciId, serialNumber, iteration, pathDataId, upload)

Upload path data iteration 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.ProductInstanceBinaryApi();

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

Parameters

Name	Type	Description
workspaceId	String	Workspace id
ciId	String	Configuration item id
serialNumber	String	Serial number
iteration	Number	Product instance iteration
pathDataId	Number	PathDataMaster Id
upload	File

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

uploadFilesToProductInstanceIteration

uploadFilesToProductInstanceIteration(workspaceId, ciId, serialNumber, iteration, upload)

Upload product instance files

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

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

Parameters

Name	Type	Description
workspaceId	String	Workspace id
ciId	String	Configuration item id
serialNumber	String	Serial number
iteration	Number	Product instance iteration
upload	File

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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