DocdokuPlmApi.WorkspacesApi

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

acknowledgeNotification

acknowledgeNotification(workspaceId, notificationId, body)

Acknowledge a modification notification

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

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

var notificationId = 56; // Number | Notification id

var body = new DocdokuPlmApi.ModificationNotificationDTO(); // ModificationNotificationDTO | Modification notification to acknowledge


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

addDocTag

DocumentRevisionDTO addDocTag(workspaceId, documentId, documentVersion, body)

Add tags to document 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.WorkspacesApi();

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

var documentId = "documentId_example"; // String | Document master id

var documentVersion = "documentVersion_example"; // String | Document 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.addDocTag(workspaceId, documentId, documentVersion, body, callback);

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

addNewPathDataIteration

PathDataMasterDTO addNewPathDataIteration(workspaceId, ciId, serialNumber, pathDataId, body)

Add new path-data 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.WorkspacesApi();

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathDataId = 56; // Number | Path data master id

var body = new DocdokuPlmApi.PathDataIterationCreationDTO(); // PathDataIterationCreationDTO | Path data iteration to create


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

Parameters

Return type

PathDataMasterDTO

Authorization

authorization

HTTP request headers

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

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

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

addTagToChangeIssue

ChangeIssueDTO addTagToChangeIssue(workspaceId, issueId, body)

Attached a new tag to a change issue

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

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

var issueId = 56; // Number | Issue id

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.addTagToChangeIssue(workspaceId, issueId, body, callback);

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

addTagToChangeOrder

ChangeOrderDTO addTagToChangeOrder(workspaceId, orderId, body)

Add new tag to order

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

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

var orderId = 56; // Number | Order id

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.addTagToChangeOrder(workspaceId, orderId, body, callback);

Parameters

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

addTagsToChangeRequest

ChangeRequestDTO addTagsToChangeRequest(workspaceId, requestId, body)

Attach a new tag to a change request

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

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

var requestId = 56; // Number | Request id

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.addTagsToChangeRequest(workspaceId, requestId, body, callback);

Parameters

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

addUser

addUser(workspaceId, body, opts)

Add a user to 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.WorkspacesApi();

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

var body = new DocdokuPlmApi.UserDTO(); // UserDTO | User to add

var opts = { 
  'group': "group_example" // String | Group id
};

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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

cascadeCheckin

CascadeResult cascadeCheckin(workspaceId, ciId, path, body, opts)

Cascade part revision check in with given config spec and path

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

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

var ciId = "ciId_example"; // String | Configuration item id

var path = "path_example"; // String | Complete path to checkin from

var body = new DocdokuPlmApi.IterationNoteDTO(); // IterationNoteDTO | Iteration note to add

var opts = { 
  'configSpec': "configSpec_example" // String | Config spec
};

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

Parameters

Return type

CascadeResult

Authorization

authorization

HTTP request headers

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

cascadeCheckout

CascadeResult cascadeCheckout(workspaceId, ciId, path, opts)

Cascade part revision check out with given config spec and path

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

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

var ciId = "ciId_example"; // String | Configuration item id

var path = "path_example"; // String | Complete path to checkout from

var opts = { 
  'configSpec': "configSpec_example" // String | Config spec
};

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

Parameters

Return type

CascadeResult

Authorization

authorization

HTTP request headers

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

cascadeUndoCheckOut

CascadeResult cascadeUndoCheckOut(workspaceId, ciId, path, opts)

Cascade part revision undo check out with given config spec and path

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

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

var ciId = "ciId_example"; // String | Configuration item id

var path = "path_example"; // String | Complete path to undo checkout from

var opts = { 
  'configSpec': "configSpec_example" // String | Config spec
};

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

Parameters

Return type

CascadeResult

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• 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.WorkspacesApi();

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

checkInDocument

DocumentRevisionDTO checkInDocument(workspaceId, documentId, documentVersion)

Checkin document 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.WorkspacesApi();

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

var documentId = "documentId_example"; // String | Document master id

var documentVersion = "documentVersion_example"; // String | Document version


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

Parameters

Return type

DocumentRevisionDTO

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

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

checkOutDocument

DocumentRevisionDTO checkOutDocument(workspaceId, documentId, documentVersion)

Checkout document 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.WorkspacesApi();

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

var documentId = "documentId_example"; // String | Document master id

var documentVersion = "documentVersion_example"; // String | Document version


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

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

countCheckedOutDocs

[DocumentRevisionDTO] countCheckedOutDocs(workspaceId)

Count checked out document 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.WorkspacesApi();

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.countCheckedOutDocs(workspaceId, callback);

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

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

createConfiguration

ProductConfigurationDTO createConfiguration(workspaceId, body)

Create a new product configuration

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

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

var body = new DocdokuPlmApi.ProductConfigurationDTO(); // ProductConfigurationDTO | Product configuration to create


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

Parameters

Return type

ProductConfigurationDTO

Authorization

authorization

HTTP request headers

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

createConfigurationItem

ConfigurationItemDTO createConfigurationItem(workspaceId, body)

Create a new configuration item

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

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

var body = new DocdokuPlmApi.ConfigurationItemDTO(); // ConfigurationItemDTO | Product to create


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

Parameters

Return type

ConfigurationItemDTO

Authorization

authorization

HTTP request headers

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

createDocumentBaseline

DocumentBaselineDTO createDocumentBaseline(workspaceId, body)

Create a new document baseline

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

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

var body = new DocdokuPlmApi.DocumentBaselineDTO(); // DocumentBaselineDTO | Document baseline to create


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

Parameters

Return type

DocumentBaselineDTO

Authorization

authorization

HTTP request headers

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

createDocumentMasterInFolder

DocumentRevisionDTO createDocumentMasterInFolder(workspaceId, body, folderId)

Create a new document revision in given folder

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

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

var body = new DocdokuPlmApi.DocumentCreationDTO(); // DocumentCreationDTO | Document to create

var folderId = "folderId_example"; // String | Folder id


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

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

createDocumentMasterInRootFolderWithTag

[DocumentRevisionDTO] createDocumentMasterInRootFolderWithTag(workspaceId, body, tagId)

Create a new document master and its first revision with given tag

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

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

var body = new DocdokuPlmApi.DocumentCreationDTO(); // DocumentCreationDTO | Document to create

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.createDocumentMasterInRootFolderWithTag(workspaceId, body, tagId, callback);

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

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

createDocumentMasterTemplate

DocumentMasterTemplateDTO createDocumentMasterTemplate(workspaceId, body)

Create a new document template

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

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

var body = new DocdokuPlmApi.DocumentTemplateCreationDTO(); // DocumentTemplateCreationDTO | Document master template to create


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

Parameters

Return type

DocumentMasterTemplateDTO

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

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

createGroup

UserGroupDTO createGroup(workspaceId, body)

Create a new user group

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

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

var body = new DocdokuPlmApi.UserGroupDTO(); // UserGroupDTO | UserGroup to create


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

Parameters

Return type

UserGroupDTO

Authorization

authorization

HTTP request headers

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

createIssue

ChangeIssueDTO createIssue(workspaceId, body)

Create a new change issue

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

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

var body = new DocdokuPlmApi.ChangeIssueDTO(); // ChangeIssueDTO | Change issue to create


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

createLOV

ListOfValuesDTO createLOV(workspaceId, body)

Create a new ListOfValues

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

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

var body = new DocdokuPlmApi.ListOfValuesDTO(); // ListOfValuesDTO | LOV to create


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

Parameters

Return type

ListOfValuesDTO

Authorization

authorization

HTTP request headers

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

createLayer

LayerDTO createLayer(workspaceId, ciId, body)

Create a new layer for given product

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

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

var ciId = "ciId_example"; // String | Configuration item id

var body = new DocdokuPlmApi.LayerDTO(); // LayerDTO | Layer to create


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

Parameters

Return type

LayerDTO

Authorization

authorization

HTTP request headers

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

createMarker

MarkerDTO createMarker(workspaceId, ciId, layerId, body)

Create a new marker in a given layer

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

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

var ciId = "ciId_example"; // String | Configuration item id

var layerId = 56; // Number | Layer id

var body = new DocdokuPlmApi.MarkerDTO(); // MarkerDTO | Marker to create


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

Parameters

Return type

MarkerDTO

Authorization

authorization

HTTP request headers

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

createMilestone

MilestoneDTO createMilestone(workspaceId, body)

Create a new milestone

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

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

var body = new DocdokuPlmApi.MilestoneDTO(); // MilestoneDTO | Milestone to create


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

Parameters

Return type

MilestoneDTO

Authorization

authorization

HTTP request headers

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

createNewDocumentVersion

[DocumentRevisionDTO] createNewDocumentVersion(workspaceId, documentId, documentVersion, body)

Create a new version of the document 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.WorkspacesApi();

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

var documentId = "documentId_example"; // String | Document master id

var documentVersion = "documentVersion_example"; // String | Document version

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


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

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• 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.WorkspacesApi();

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

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

createOrder

ChangeOrderDTO createOrder(workspaceId, body)

Create order

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

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

var body = new DocdokuPlmApi.ChangeOrderDTO(); // ChangeOrderDTO | Change order to create


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

Parameters

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

createPartMasterTemplate

PartMasterTemplateDTO createPartMasterTemplate(workspaceId, body)

Crate a new part master template

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

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

var body = new DocdokuPlmApi.PartTemplateCreationDTO(); // PartTemplateCreationDTO | Part master template to create


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

Parameters

Return type

PartMasterTemplateDTO

Authorization

authorization

HTTP request headers

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

createPathDataMaster

PathDataMasterDTO createPathDataMaster(workspaceId, ciId, serialNumber, path, body)

Create a new path-data in product-instance last 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.WorkspacesApi();

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var path = "path_example"; // String | Complete path in context

var body = new DocdokuPlmApi.PathDataIterationCreationDTO(); // PathDataIterationCreationDTO | Path data iteration create


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

Parameters

Return type

PathDataMasterDTO

Authorization

authorization

HTTP request headers

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

createPathToPathLink

LightPathToPathLinkDTO createPathToPathLink(workspaceId, ciId, body)

Create a new path-to-path 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.WorkspacesApi();

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

var ciId = "ciId_example"; // String | Configuration item id

var body = new DocdokuPlmApi.LightPathToPathLinkDTO(); // LightPathToPathLinkDTO | Path to path link to create


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

Parameters

Return type

LightPathToPathLinkDTO

Authorization

authorization

HTTP request headers

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

createProductBaseline

ProductBaselineDTO createProductBaseline(workspaceId, body, opts)

Create a new product-baseline

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

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

var body = new DocdokuPlmApi.ProductBaselineCreationDTO(); // ProductBaselineCreationDTO | Product baseline to create

var opts = { 
  'dryRun': true // Boolean | Dry run flag
};

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

Parameters

Return type

ProductBaselineDTO

Authorization

authorization

HTTP request headers

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

createProductInstanceMaster

ProductInstanceMasterDTO createProductInstanceMaster(workspaceId, body)

Create a new product-instance

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

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

var body = new DocdokuPlmApi.ProductInstanceCreationDTO(); // ProductInstanceCreationDTO | Product instance master to create


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

Parameters

Return type

ProductInstanceMasterDTO

Authorization

authorization

HTTP request headers

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

createRequest

ChangeRequestDTO createRequest(workspaceId, body)

Create request

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

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

var body = new DocdokuPlmApi.ChangeRequestDTO(); // ChangeRequestDTO | Change request to create


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

Parameters

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

createRole

RoleDTO createRole(workspaceId, body)

Create a new role

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

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

var body = new DocdokuPlmApi.RoleDTO(); // RoleDTO | Role to create


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

Parameters

Return type

RoleDTO

Authorization

authorization

HTTP request headers

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

createRootFolder

FolderDTO createRootFolder(workspaceId, body)

Create root folder

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

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

var body = new DocdokuPlmApi.FolderDTO(); // FolderDTO | Folder to create


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

Parameters

Return type

FolderDTO

Authorization

authorization

HTTP request headers

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

createSharedDocument

SharedDocumentDTO createSharedDocument(workspaceId, documentId, documentVersion, body)

Create a shared document for given document 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.WorkspacesApi();

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

var documentId = "documentId_example"; // String | Document master id

var documentVersion = "documentVersion_example"; // String | Document version

var body = new DocdokuPlmApi.SharedDocumentDTO(); // SharedDocumentDTO | Shared document to create


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

Parameters

Return type

SharedDocumentDTO

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

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

createSubFolder

FolderDTO createSubFolder(workspaceId, parentFolderPath, body)

Create a sub folder in a given folder

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

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

var parentFolderPath = "parentFolderPath_example"; // String | Parent folder id

var body = new DocdokuPlmApi.FolderDTO(); // FolderDTO | Folder to create


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

Parameters

Return type

FolderDTO

Authorization

authorization

HTTP request headers

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

createTag

TagDTO createTag(workspaceId, body)

Create a new tag 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.WorkspacesApi();

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

var body = new DocdokuPlmApi.TagDTO(); // TagDTO | Tag to create


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

Parameters

Return type

TagDTO

Authorization

authorization

HTTP request headers

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

createTags

createTags(workspaceId, body)

Create new tags 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.WorkspacesApi();

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

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


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

createWebhook

WebhookDTO createWebhook(workspaceId, body)

Create a new webhook 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.WorkspacesApi();

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

var body = new DocdokuPlmApi.WebhookDTO(); // WebhookDTO | Webhook definition


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

Parameters

Return type

WebhookDTO

Authorization

authorization

HTTP request headers

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

createWorkflowModel

WorkflowModelDTO createWorkflowModel(workspaceId, body)

Create a new workflow model

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

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

var body = new DocdokuPlmApi.WorkflowModelDTO(); // WorkflowModelDTO | Workflow model to create rules to set


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

Parameters

Return type

WorkflowModelDTO

Authorization

authorization

HTTP request headers

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

createWorkspace

WorkspaceDTO createWorkspace(body, opts)

Create a new 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.WorkspacesApi();

var body = new DocdokuPlmApi.WorkspaceDTO(); // WorkspaceDTO | Workspace to create

var opts = { 
  'userLogin': "userLogin_example" // String | Login for workspace admin
};

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

Parameters

Return type

WorkspaceDTO

Authorization

authorization

HTTP request headers

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

createWorkspaceWorkflow

WorkspaceWorkflowDTO createWorkspaceWorkflow(workspaceId, body)

Instantiate a workspace workflow from given workflow model

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

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

var body = new DocdokuPlmApi.WorkspaceWorkflowCreationDTO(); // WorkspaceWorkflowCreationDTO | Workspace workflow to create


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

Parameters

Return type

WorkspaceWorkflowDTO

Authorization

authorization

HTTP request headers

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

decodePath

[LightPartLinkDTO] decodePath(workspaceId, ciId, path)

Decode given path as string

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

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

var ciId = "ciId_example"; // String | Configuration item id

var path = "path_example"; // String | Complete path to decode


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

Parameters

Return type

[LightPartLinkDTO]

Authorization

authorization

HTTP request headers

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

delWorkflowModel

delWorkflowModel(workspaceId, workflowModelId)

Delete a workflow model

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

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

var workflowModelId = "workflowModelId_example"; // String | Workflow model id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

deleteAttachedFileInPathData

deleteAttachedFileInPathData(workspaceId, ciId, serialNumber, pathDataId, iteration, fileName)

Delete product-instance's attached 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.WorkspacesApi();

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathDataId = 56; // Number | Path data master id

var iteration = 56; // Number | Product instance iteration

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.deleteAttachedFileInPathData(workspaceId, ciId, serialNumber, pathDataId, iteration, fileName, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteBaseline

deleteBaseline(workspaceId, baselineId)

Delete a document baseline

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

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

var baselineId = 56; // Number | Baseline id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteConfigurationItem

deleteConfigurationItem(workspaceId, ciId)

Delete configuration item

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

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

var ciId = "ciId_example"; // String | Configuration item id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteDocument

deleteDocument(workspaceId, documentId, documentVersion)

Delete the document 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.WorkspacesApi();

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

var documentId = "documentId_example"; // String | Document master id

var documentVersion = "documentVersion_example"; // String | Document version


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

deleteDocumentMasterTemplate

deleteDocumentMasterTemplate(workspaceId, templateId)

Delete document template

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

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

var templateId = "templateId_example"; // String | Template id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

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

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

deleteLOV

deleteLOV(workspaceId, name)

Delete a ListOfValues

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

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

var name = "name_example"; // String | Name


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteLayer

deleteLayer(workspaceId, ciId, layerId)

Delete layer

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

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

var ciId = "ciId_example"; // String | Configuration item id

var layerId = 56; // Number | Layer id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteMarker

deleteMarker(workspaceId, ciId, layerId, markerId)

Delete marker

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

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

var ciId = "ciId_example"; // String | Configuration item id

var layerId = 56; // Number | Layer id

var markerId = 56; // Number | Marker id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deletePartMasterTemplate

deletePartMasterTemplate(workspaceId, templateId)

Delete part master template

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

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

var templateId = "templateId_example"; // String | Template id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

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

deletePathData

deletePathData(workspaceId, ciId, serialNumber, pathDataId)

Delete product-instance's path-data

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number

var pathDataId = 56; // Number | Path data master id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deletePathToPathLink

deletePathToPathLink(workspaceId, ciId, pathToPathLinkId)

Delete path-to-path 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.WorkspacesApi();

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

var ciId = "ciId_example"; // String | Configuration item id

var pathToPathLinkId = 56; // Number | Path to path link id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

deleteProductBaseline

deleteProductBaseline(workspaceId, ciId, baselineId)

Delete product-baseline

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

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

var ciId = "ciId_example"; // String | Configuration item id

var baselineId = 56; // Number | Baseline id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteProductConfiguration

deleteProductConfiguration(workspaceId, ciId, productConfigurationId)

Delete product configuration

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

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

var ciId = "ciId_example"; // String | Configuration item id

var productConfigurationId = 56; // Number | Product configuration id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteProductInstanceMaster

deleteProductInstanceMaster(workspaceId, ciId, serialNumber)

Delete product-instance

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

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

var ciId = "ciId_example"; // String | Configuration item id

var serialNumber = "serialNumber_example"; // String | Serial number


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

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

deleteRole

deleteRole(workspaceId, roleName)

Delete a role

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

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

var roleName = "roleName_example"; // String | Role name


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteRootFolder

deleteRootFolder(workspaceId, folderId)

Delete root folder

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

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

var folderId = "folderId_example"; // String | Folder id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteTag

deleteTag(workspaceId, tagId)

Delete a tag 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.WorkspacesApi();

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.');
  }
};
apiInstance.deleteTag(workspaceId, tagId, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

deleteUserGroupSubscription

deleteUserGroupSubscription(workspaceId, groupId, tagName)

Delete tag subscription of given user group

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

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

var groupId = "groupId_example"; // String | Group id id

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


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteUserSubscription

deleteUserSubscription(workspaceId, login, tagName)

Delete tag subscription of user

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

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

var login = "login_example"; // String | User login

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


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteWebhook

deleteWebhook(workspaceId, webhookId)

Delete a webhook

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

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

var webhookId = 56; // Number | Webhook id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteWorkspace

deleteWorkspace(workspaceId)

Delete a 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.WorkspacesApi();

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


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

deleteWorkspaceWorkflow

deleteWorkspaceWorkflow(workspaceId, workspaceWorkflowId)

Delete a workspace workflow

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

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

var workspaceWorkflowId = "workspaceWorkflowId_example"; // String | Workspace workflow id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

disableGroup

disableGroup(workspaceId, body)

Disable user group 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.WorkspacesApi();

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

var body = new DocdokuPlmApi.UserGroupDTO(); // UserGroupDTO | Group to disable


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

disableUser

disableUser(workspaceId, body)

Disable user 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.WorkspacesApi();

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

var body = new DocdokuPlmApi.UserDTO(); // UserDTO | User to disable


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

enableGroup

enableGroup(workspaceId, body)

Enable user group 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.WorkspacesApi();

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

var body = new DocdokuPlmApi.UserGroupDTO(); // UserGroupDTO | Group to enable


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

enableUser

enableUser(workspaceId, body)

Enable user 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.WorkspacesApi();

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

var body = new DocdokuPlmApi.UserDTO(); // UserDTO | User to enable


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.enableUser(workspaceId, body, 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.WorkspacesApi();

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

exportDocumentFiles

File exportDocumentFiles(workspaceId, baselineId)

Export document baseline's files

Example

var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;

// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';

var apiInstance = new DocdokuPlmApi.WorkspacesApi();

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

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.exportDocumentFiles(workspaceId, baselineId, callback);

Parameters

Return type

File

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

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

exportProductFiles

File exportProductFiles(workspaceId, ciId, opts)

Export files from configuration item with given config spec

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

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

var ciId = "ciId_example"; // String | Configuration item id

var opts = { 
  'configSpecType': "configSpecType_example", // String | Config spec
  'exportNativeCADFiles': true, // Boolean | Export native cad files flag
  'exportDocumentLinks': true // Boolean | Export linked documents attached files flag
};

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

Parameters

Return type

File

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

filterPart

[PartRevisionDTO] filterPart(workspaceId, ciId, opts)

Filter part with given config spec and path

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

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

var ciId = "ciId_example"; // String | Configuration item id

var opts = { 
  'configSpec': "wip", // String | Config spec
  'path': "path_example", // String | Complete path of part
  'diverge': false // Boolean | Discover substitute links
};

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

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

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

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

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

filterProductStructure

ComponentDTO filterProductStructure(workspaceId, ciId, opts)

Filter product structure

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

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

var ciId = "ciId_example"; // String | Configuration item id

var opts = { 
  'configSpec': "configSpec_example", // String | Config spec
  'path': "path_example", // String | Complete path of part
  'depth': 56, // Number | Depth to stop at
  'linkType': "linkType_example", // String | Type link to filter
  'diverge': true // Boolean | Discover substitute links
};

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

Parameters

Return type

ComponentDTO

Authorization

authorization

HTTP request headers

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

generateDocumentMasterId

TemplateGeneratedIdDTO generateDocumentMasterId(workspaceId, templateId)

Generate document template 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.WorkspacesApi();

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

var templateId = "templateId_example"; // String | Template id


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

Parameters

Return type

TemplateGeneratedIdDTO

Authorization

authorization

HTTP request headers

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

generatePartMasterTemplateId

TemplateGeneratedIdDTO generatePartMasterTemplateId(workspaceId, templateId)

Generate part master template 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.WorkspacesApi();

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

var templateId = "templateId_example"; // String | Template id


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

Parameters

Return type

TemplateGeneratedIdDTO

Authorization

authorization

HTTP request headers

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

getAbortedWorkflowListInDocument

[WorkflowDTO] getAbortedWorkflowListInDocument(workspaceId, documentId, documentVersion)

Get document revision aborted workflow history

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

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

var documentId = "documentId_example"; // String | Document master id

var documentVersion = "documentVersion_example"; // String | Document version


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

Parameters

Return type

[WorkflowDTO]

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

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

getAdminInWorkspace

UserDTO getAdminInWorkspace(workspaceId)

Get admin for 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.WorkspacesApi();

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.getAdminInWorkspace(workspaceId, callback);

Parameters

Return type

UserDTO

Authorization

authorization

HTTP request headers

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

getAllConfigurations

[ProductConfigurationDTO] getAllConfigurations(workspaceId)

Get all product configurations 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.WorkspacesApi();

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.getAllConfigurations(workspaceId, callback);

Parameters

Return type

[ProductConfigurationDTO]

Authorization

authorization

HTTP request headers

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

getAllProductBaselines

[ProductBaselineDTO] getAllProductBaselines(workspaceId)

Get product-baselines 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.WorkspacesApi();

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.getAllProductBaselines(workspaceId, callback);

Parameters

Return type

[ProductBaselineDTO]

Authorization

authorization

HTTP request headers

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

getAllProductInstances

[ProductInstanceMasterDTO] getAllProductInstances(workspaceId)

Get product instances 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.WorkspacesApi();

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.getAllProductInstances(workspaceId, callback);

Parameters

Return type

[ProductInstanceMasterDTO]

Authorization

authorization

HTTP request headers

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

getAssignedTasksForGivenUser

[TaskDTO] getAssignedTasksForGivenUser(workspaceId, assignedUserLogin)

Get assigned tasks for given user

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

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

var assignedUserLogin = "assignedUserLogin_example"; // String | Assigned user login


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

Parameters

Return type

[TaskDTO]

Authorization

authorization

HTTP request headers

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

getBaseline

DocumentBaselineDTO getBaseline(workspaceId, baselineId)

Get document baseline 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.WorkspacesApi();

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

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.getBaseline(workspaceId, baselineId, callback);

Parameters

Return type

DocumentBaselineDTO

Authorization

authorization

HTTP request headers

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

getBaselineCreationPathChoices

[PathChoiceDTO] getBaselineCreationPathChoices(workspaceId, ciId, opts)

Get baseline creation path choices

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

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

var ciId = "ciId_example"; // String | Configuration item id

var opts = { 
  'type': "type_example" // String | Baseline type
};

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

Parameters

Return type

[PathChoiceDTO]

Authorization

authorization

HTTP request headers

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

getBaselineCreationVersionsChoices

[BaselinedPartDTO] getBaselineCreationVersionsChoices(workspaceId, ciId)

Get baseline creation version choices

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

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

var ciId = "ciId_example"; // String | Configuration item id


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

Parameters

Return type

[BaselinedPartDTO]

Authorization

authorization

HTTP request headers

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

getBaselineLight

DocumentBaselineDTO getBaselineLight(workspaceId, baselineId)

Get document baseline in a light format

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

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

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.getBaselineLight(workspaceId, baselineId, callback);

Parameters

Return type

DocumentBaselineDTO

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

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

getCheckedOutDocuments

[DocumentRevisionDTO] getCheckedOutDocuments(workspaceId)

Get checked out document 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.WorkspacesApi();

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.getCheckedOutDocuments(workspaceId, callback);

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

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

getCheckedOutDocumentsStats

{'String': [{'String': 'Number'}]} getCheckedOutDocumentsStats(workspaceId)

Get checked out documents stats for 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.WorkspacesApi();

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.getCheckedOutDocumentsStats(workspaceId, callback);

Parameters

Return type

{'String': [{'String': 'Number'}]}

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

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

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

getCheckedOutPartsStats

{'String': [{'String': 'Number'}]} getCheckedOutPartsStats(workspaceId)

Get checked out parts stats for 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.WorkspacesApi();

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.getCheckedOutPartsStats(workspaceId, callback);

Parameters

Return type

{'String': [{'String': 'Number'}]}

Authorization

authorization

HTTP request headers

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

getConfiguration

ProductConfigurationDTO getConfiguration(workspaceId, ciId, productConfigurationId)

Get product configuration 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.WorkspacesApi();

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

var ciId = "ciId_example"; // String | Configuration item id

var productConfigurationId = 56; // Number | Product configuration id


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

Parameters

Return type

ProductConfigurationDTO

Authorization

authorization

HTTP request headers

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

getConfigurationItem

ConfigurationItemDTO getConfigurationItem(workspaceId, ciId)

Get configuration item 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.WorkspacesApi();

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

var ciId = "ciId_example"; // String | Configuration item id


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

Parameters

Return type

ConfigurationItemDTO

Authorization

authorization

HTTP request headers

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

getConfigurationItems

[ConfigurationItemDTO] getConfigurationItems(workspaceId)

Get configuration items 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.WorkspacesApi();

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.getConfigurationItems(workspaceId, callback);

Parameters

Return type

[ConfigurationItemDTO]

Authorization

authorization

HTTP request headers

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

getConfigurationsForProduct

[ProductConfigurationDTO] getConfigurationsForProduct(workspaceId, ciId)

Get all product configurations for given product

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

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

var ciId = "ciId_example"; // String | Configuration item id filter


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

Parameters

Return type

[ProductConfigurationDTO]

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

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

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

getDetailedWorkspacesForConnectedUser

[WorkspaceDetailsDTO] getDetailedWorkspacesForConnectedUser()

Get detailed workspace list for authenticated user

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

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

Parameters

This endpoint does not need any parameter.

Return type

[WorkspaceDetailsDTO]

Authorization

authorization

HTTP request headers

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

getDiskSpaceUsageStats

DiskUsageSpaceDTO getDiskSpaceUsageStats(workspaceId)

Get disk usage stats for 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.WorkspacesApi();

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.getDiskSpaceUsageStats(workspaceId, callback);

Parameters