DocdokuPlmApi.PartApi

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

Method HTTP request Description
addPartTag POST /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tags Add tags to part revision
checkIn PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/checkin Checkin part revision
checkOut PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/checkout Checkout part revision
createNewPartVersion PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/newVersion Create new part version
createSharedPart POST /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/share Create a new shared part from part revision
deletePartRevision DELETE /workspaces/{workspaceId}/parts/{partNumber}-{partVersion} Delete part revision
getAbortedWorkflowListInPart GET /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/aborted-workflows Get part revision's aborted workflow list
getBaselinesWherePartRevisionHasIterations GET /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/baselines Get product baselines where part revision is involved
getConversionStatus GET /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/conversion Get part iteration conversion status
getInstancesUnderPart GET /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/instances Get instances under given part revision (latest checked-in view)
getPartRevision GET /workspaces/{workspaceId}/parts/{partNumber}-{partVersion} Get part revision
getProductInstanceMasters GET /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-product-instance-masters Get product instance where part revision is in use
getUsedByAsComponent GET /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-as-component Get part revisions where given part revision is used as a component
getUsedByAsSubstitute GET /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-as-substitute Get part revisions where given part revision is used as a substitute
markPartRevisionAsObsolete PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/obsolete Set part revision as obsolete
publishPartRevision PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/publish Publish part revision
releasePartRevision PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/release Release part revision
removeFile DELETE /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/files/{subType}/{fileName} Remove file from part iteration
removePartTags DELETE /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tags/{tagName} Delete tags from part revision
renameAttachedFileInPartIteration PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/files/{subType}/{fileName} Rename attached file from part iteration
retryConversion PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/conversion Retry part iteration conversion
savePartTags PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tags Save part revision tags
unPublishPartRevision PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/unpublish Un-publish part revision
undoCheckOut PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/undocheckout Undo checkout part revision
updatePartIteration PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration} Update part iteration
updatePartRevisionACL PUT /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/acl Update part revision ACL

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
body TagListDTO Tag list to add

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
body PartCreationDTO New version of part to create

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
body SharedPartDTO Shared part to create

Return type

SharedPartDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

[WorkflowDTO]

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

[ProductBaselineDTO]

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
partIteration Number Part iteration

Return type

ConversionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

[LeafDTO]

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

[ProductInstanceMasterDTO]

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
partIteration Number Part iteration
subType String Sub type
fileName String File name

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
tagName String Tag name

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
partIteration Number Part iteration
subType String Sub type
fileName String File name
body FileDTO File to rename

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
partIteration Number Part iteration

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
body TagListDTO Tag list to add

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
partIteration Number Part iteration
body PartIterationDTO Part iteration to update

Return type

PartRevisionDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version
body ACLDTO ACL rules to set

Return type

null (empty response body)

Authorization

authorization

HTTP request headers