DocdokuPlmApi.PartsApi

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

addPartTag

PartRevisionDTO addPartTag(workspaceId, partNumber, partVersion, body)

Add tags to part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var body = new DocdokuPlmApi.TagListDTO(); // TagListDTO | Tag list to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addPartTag(workspaceId, partNumber, partVersion, body, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

checkIn

PartRevisionDTO checkIn(workspaceId, partNumber, partVersion)

Checkin part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.checkIn(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

checkOut

PartRevisionDTO checkOut(workspaceId, partNumber, partVersion)

Checkout part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.checkOut(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createEffectivity

EffectivityDTO createEffectivity(body, workspaceId, partNumber, partVersion)

Create an Effectivity for a given PartRevision

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

var body = new DocdokuPlmApi.EffectivityDTO(); // EffectivityDTO | Effectivity to create

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part revision number

var partVersion = "partVersion_example"; // String | Part revision version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createEffectivity(body, workspaceId, partNumber, partVersion, callback);

Parameters

Return type

EffectivityDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

createNewPart

PartRevisionDTO createNewPart(workspaceId, body)

Create a new part master and its first revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var body = new DocdokuPlmApi.PartCreationDTO(); // PartCreationDTO | Part to create


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createNewPart(workspaceId, body, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

createNewPartVersion

createNewPartVersion(workspaceId, partNumber, partVersion, body)

Create new part version

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var body = new DocdokuPlmApi.PartCreationDTO(); // PartCreationDTO | New version of part to create


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.createNewPartVersion(workspaceId, partNumber, partVersion, body, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createSharedPart

SharedPartDTO createSharedPart(workspaceId, partNumber, partVersion, body)

Create a new shared part from part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var body = new DocdokuPlmApi.SharedPartDTO(); // SharedPartDTO | Shared part to create


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createSharedPart(workspaceId, partNumber, partVersion, body, callback);

Parameters

Return type

SharedPartDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteEffectivity

deleteEffectivity(workspaceId, partNumber, partVersion, effectivityId)

Delete effectivity from given part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part revision number

var partVersion = "partVersion_example"; // String | Part revision version

var effectivityId = 56; // Number | Effectivity id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteEffectivity(workspaceId, partNumber, partVersion, effectivityId, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteImport

deleteImport(workspaceId, importId)

Delete import

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var importId = "importId_example"; // String | Import id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteImport(workspaceId, importId, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

deletePartRevision

deletePartRevision(workspaceId, partNumber, partVersion)

Delete part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deletePartRevision(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteQuery

deleteQuery(workspaceId, queryId)

Delete custom query

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var queryId = 56; // Number | Query id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteQuery(workspaceId, queryId, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

exportCustomQuery

File exportCustomQuery(workspaceId, body, opts)

Run and export a custom query

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var body = new DocdokuPlmApi.QueryDTO(); // QueryDTO | Query to export

var opts = { 
  '_export': "JSON" // String | Choose export type
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.exportCustomQuery(workspaceId, body, opts, callback);

Parameters

Return type

File

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.ms-excel

exportExistingQuery

File exportExistingQuery(workspaceId, queryId, _export)

Run and export an existing query

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var queryId = 56; // Number | Query id

var _export = "_export_example"; // String | Choose export type


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.exportExistingQuery(workspaceId, queryId, _export, callback);

Parameters

Return type

File

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.ms-excel

filterPartMasterInBaseline

PartIterationDTO filterPartMasterInBaseline(workspaceId, partNumber, baselineId)

Filter part master with in baseline : resolve part iteration

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var baselineId = 56; // Number | Baseline id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.filterPartMasterInBaseline(workspaceId, partNumber, baselineId, callback);

Parameters

Return type

PartIterationDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getAbortedWorkflowListInPart

[WorkflowDTO] getAbortedWorkflowListInPart(workspaceId, partNumber, partVersion)

Get part revision's aborted workflow list

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getAbortedWorkflowListInPart(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

[WorkflowDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getBaselinesWherePartRevisionHasIterations

[ProductBaselineDTO] getBaselinesWherePartRevisionHasIterations(workspaceId, partNumber, partVersion)

Get product baselines where part revision is involved

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getBaselinesWherePartRevisionHasIterations(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

[ProductBaselineDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getCheckedOutNumberOfItems

CountDTO getCheckedOutNumberOfItems(workspaceId)

Count checked out part revisions

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

var workspaceId = "workspaceId_example"; // String | Workspace id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCheckedOutNumberOfItems(workspaceId, callback);

Parameters

Return type

CountDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getCheckedOutPartRevisions

[PartRevisionDTO] getCheckedOutPartRevisions(workspaceId)

Get checked out part revisions

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

var workspaceId = "workspaceId_example"; // String | Workspace id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCheckedOutPartRevisions(workspaceId, callback);

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getConversionStatus

ConversionDTO getConversionStatus(workspaceId, partNumber, partVersion, partIteration)

Get part iteration conversion status

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var partIteration = 56; // Number | Part iteration


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getConversionStatus(workspaceId, partNumber, partVersion, partIteration, callback);

Parameters

Return type

ConversionDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getCustomQueries

[QueryDTO] getCustomQueries(workspaceId)

Get custom queries in workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCustomQueries(workspaceId, callback);

Parameters

Return type

[QueryDTO]

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

getEffectivities

[EffectivityDTO] getEffectivities(workspaceId, partNumber, partVersion)

Get effectivities of a given PartRevision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part revision number

var partVersion = "partVersion_example"; // String | Part revision version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getEffectivities(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

[EffectivityDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getImport

ImportDTO getImport(workspaceId, importId)

Get import by id

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var importId = "importId_example"; // String | Import id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImport(workspaceId, importId, callback);

Parameters

Return type

ImportDTO

Authorization

authorization

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

getImportPreview

ImportPreviewDTO getImportPreview(workspaceId, importType, opts)

Get import preview

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var importType = "importType_example"; // String | Import type

var opts = { 
  'autoCheckout': true, // Boolean | Auto check out parts flag
  'autoCheckin': true, // Boolean | Auto check in parts flag
  'permissiveUpdate': true // Boolean | Permissive update flag
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImportPreview(workspaceId, importType, opts, callback);

Parameters

Return type

ImportPreviewDTO

Authorization

authorization

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

getImports

[ImportDTO] getImports(workspaceId, filename)

Get imports currently running for given 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.PartsApi();

var workspaceId = "workspaceId_example"; // String | Workspace id

var filename = "filename_example"; // String | File name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getImports(workspaceId, filename, callback);

Parameters

Return type

[ImportDTO]

Authorization

authorization

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

getInstancesUnderPart

[LeafDTO] getInstancesUnderPart(workspaceId, partNumber, partVersion)

Get instances under given part revision (latest checked-in view)

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getInstancesUnderPart(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

[LeafDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getLatestPartRevision

PartRevisionDTO getLatestPartRevision(workspaceId, partNumber)

Get part master latest available revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getLatestPartRevision(workspaceId, partNumber, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPartRevision

PartRevisionDTO getPartRevision(workspaceId, partNumber, partVersion)

Get part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getPartRevision(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPartRevisions

[PartRevisionDTO] getPartRevisions(workspaceId, opts)

Get part revisions in workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var opts = { 
  'start': 0, // Number | Start offset
  'length': 20 // Number | Max results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getPartRevisions(workspaceId, opts, callback);

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPartRevisionsByTag

[PartRevisionDTO] getPartRevisionsByTag(workspaceId, tagId)

Get part revisions in workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var tagId = "tagId_example"; // String | Tag id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getPartRevisionsByTag(workspaceId, tagId, callback);

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getProductInstanceMasters

[ProductInstanceMasterDTO] getProductInstanceMasters(workspaceId, partNumber, partVersion)

Get product instance where part revision is in use

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getProductInstanceMasters(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

[ProductInstanceMasterDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getTotalNumberOfParts

CountDTO getTotalNumberOfParts(workspaceId)

Count part revisions in workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getTotalNumberOfParts(workspaceId, callback);

Parameters

Return type

CountDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUsedByAsComponent

[PartRevisionDTO] getUsedByAsComponent(workspaceId, partNumber, partVersion)

Get part revisions where given part revision is used as a component

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getUsedByAsComponent(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getUsedByAsSubstitute

[PartRevisionDTO] getUsedByAsSubstitute(workspaceId, partNumber, partVersion)

Get part revisions where given part revision is used as a substitute

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getUsedByAsSubstitute(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

importPartAttributes

importPartAttributes(workspaceId, importType, opts)

Import part iteration attributes from 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.PartsApi();

var workspaceId = "workspaceId_example"; // String | Workspace id

var importType = "importType_example"; // String | Import type

var opts = { 
  'autoCheckout': true, // Boolean | Auto check out parts flag
  'autoCheckin': true, // Boolean | Auto check in parts flag
  'permissiveUpdate': true, // Boolean | Permissive update flag
  'revisionNote': "revisionNote_example" // String | Revision note to add
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.importPartAttributes(workspaceId, importType, opts, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

markPartRevisionAsObsolete

PartRevisionDTO markPartRevisionAsObsolete(workspaceId, partNumber, partVersion)

Set part revision as obsolete

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.markPartRevisionAsObsolete(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

publishPartRevision

publishPartRevision(workspaceId, partNumber, partVersion)

Publish part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.publishPartRevision(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

releasePartRevision

PartRevisionDTO releasePartRevision(workspaceId, partNumber, partVersion)

Release part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.releasePartRevision(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

removeFile

removeFile(workspaceId, partNumber, partVersion, partIteration, subType, fileName)

Remove file from part iteration

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var partIteration = 56; // Number | Part iteration

var subType = "subType_example"; // String | Sub type

var fileName = "fileName_example"; // String | File name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.removeFile(workspaceId, partNumber, partVersion, partIteration, subType, fileName, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

removePartTags

PartRevisionDTO removePartTags(workspaceId, partNumber, partVersion, tagName)

Delete tags from part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var tagName = "tagName_example"; // String | Tag name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.removePartTags(workspaceId, partNumber, partVersion, tagName, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

renameAttachedFileInPartIteration

renameAttachedFileInPartIteration(workspaceId, partNumber, partVersion, partIteration, subType, fileName, body)

Rename attached file from part iteration

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var partIteration = 56; // Number | Part iteration

var subType = "subType_example"; // String | Sub type

var fileName = "fileName_example"; // String | File name

var body = new DocdokuPlmApi.FileDTO(); // FileDTO | File to rename


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.renameAttachedFileInPartIteration(workspaceId, partNumber, partVersion, partIteration, subType, fileName, body, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

retryConversion

retryConversion(workspaceId, partNumber, partVersion, partIteration)

Retry part iteration conversion

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var partIteration = 56; // Number | Part iteration


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.retryConversion(workspaceId, partNumber, partVersion, partIteration, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

runCustomQuery

File runCustomQuery(workspaceId, body, opts)

Run custom query in workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var body = new DocdokuPlmApi.QueryDTO(); // QueryDTO | Query to run

var opts = { 
  'save': false, // Boolean | Save the query flag
  '_export': "JSON" // String | Choose export type
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.runCustomQuery(workspaceId, body, opts, callback);

Parameters

Return type

File

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/octet-stream

savePartTags

PartRevisionDTO savePartTags(workspaceId, partNumber, partVersion, body)

Save part revision tags

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var body = new DocdokuPlmApi.TagListDTO(); // TagListDTO | Tag list to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.savePartTags(workspaceId, partNumber, partVersion, body, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

searchPartNumbers

[LightPartMasterDTO] searchPartNumbers(workspaceId, q)

Search for available part numbers in given workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var q = "q_example"; // String | Query


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.searchPartNumbers(workspaceId, q, callback);

Parameters

Return type

[LightPartMasterDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

searchPartRevisions

[PartRevisionDTO] searchPartRevisions(workspaceId, opts)

Search part revisions in workspace

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var opts = { 
  'q': "q_example", // String | Query
  '_number': "_number_example", // String | Part number
  'name': "name_example", // String | Part name
  'version': "version_example", // String | Part version
  'author': "author_example", // String | Part author
  'type': "type_example", // String | Part type
  'createdFrom': "createdFrom_example", // String | Part created from date
  'createdTo': "createdTo_example", // String | Part created to date
  'modifiedFrom': "modifiedFrom_example", // String | Part modified from date
  'modifiedTo': "modifiedTo_example", // String | Part modified to date
  'tags': "tags_example", // String | Part tags
  'content': "content_example", // String | Part files content
  'attributes': "attributes_example", // String | Part files attributes
  'from': 0, // Number | Start offset
  'size': 10, // Number | Max results
  'fetchHeadOnly': true // Boolean | Search mode (false for history / true for head only)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.searchPartRevisions(workspaceId, opts, callback);

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

searchPartsLastIterationWithReferenceOrName

[PartIterationDTO] searchPartsLastIterationWithReferenceOrName(workspaceId, q, opts)

Search documents last iteration to link

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var q = "q_example"; // String | Query

var opts = { 
  'l': 15 // Number | Max results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.searchPartsLastIterationWithReferenceOrName(workspaceId, q, opts, callback);

Parameters

Return type

[PartIterationDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

unPublishPartRevision

unPublishPartRevision(workspaceId, partNumber, partVersion)

Un-publish part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.unPublishPartRevision(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

undoCheckOut

PartRevisionDTO undoCheckOut(workspaceId, partNumber, partVersion)

Undo checkout part revision

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.undoCheckOut(workspaceId, partNumber, partVersion, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updatePartIteration

PartRevisionDTO updatePartIteration(workspaceId, partNumber, partVersion, partIteration, body)

Update part iteration

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var partIteration = 56; // Number | Part iteration

var body = new DocdokuPlmApi.PartIterationDTO(); // PartIterationDTO | Part iteration to update


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updatePartIteration(workspaceId, partNumber, partVersion, partIteration, body, callback);

Parameters

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updatePartRevisionACL

updatePartRevisionACL(workspaceId, partNumber, partVersion, body)

Update part revision ACL

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

var workspaceId = "workspaceId_example"; // String | Workspace id

var partNumber = "partNumber_example"; // String | Part number

var partVersion = "partVersion_example"; // String | Part version

var body = new DocdokuPlmApi.ACLDTO(); // ACLDTO | ACL rules to set


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updatePartRevisionACL(workspaceId, partNumber, partVersion, body, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json