DocdokuPlmApi.DocumentsApi

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getDocumentRevision

DocumentRevisionDTO getDocumentRevision(workspaceId, documentId, documentVersion)

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

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.getDocumentRevision(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

getDocumentsInWorkspace

[DocumentRevisionDTO] getDocumentsInWorkspace(workspaceId, opts)

Get document revisions in workspace

Example

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

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

var apiInstance = new DocdokuPlmApi.DocumentsApi();

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

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

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

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

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

getDocumentsInWorkspaceCount

CountDTO getDocumentsInWorkspaceCount(workspaceId)

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

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

Parameters

Return type

CountDTO

Authorization

authorization

HTTP request headers

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

getInverseDocumentLinks

[DocumentRevisionDTO] getInverseDocumentLinks(workspaceId, documentId, documentVersion, iteration)

Get inverse document revisions links

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

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

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

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

var iteration = 56; // Number | Document iteration


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

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

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

getInversePartsLinks

[PartRevisionDTO] getInversePartsLinks(workspaceId, documentId, documentVersion, iteration)

Get inverse part revisions links

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

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

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

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

var iteration = 56; // Number | Document iteration


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

Parameters

Return type

[PartRevisionDTO]

Authorization

authorization

HTTP request headers

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

getInversePathDataLinks

[PathDataMasterDTO] getInversePathDataLinks(workspaceId, documentId, documentVersion, iteration)

Get inverse path data links

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

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

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

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

var iteration = 56; // Number | Document iteration


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

Parameters

Return type

[PathDataMasterDTO]

Authorization

authorization

HTTP request headers

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

getInverseProductInstancesLinks

[ProductInstanceMasterDTO] getInverseProductInstancesLinks(workspaceId, documentId, documentVersion, iteration)

Get inverse product instances links

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

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

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

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

var iteration = 56; // Number | Document iteration


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

Parameters

Return type

[ProductInstanceMasterDTO]

Authorization

authorization

HTTP request headers

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

markDocumentRevisionAsObsolete

DocumentRevisionDTO markDocumentRevisionAsObsolete(workspaceId, documentId, documentVersion)

Set document revision as obsolete

Example

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

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

var apiInstance = new DocdokuPlmApi.DocumentsApi();

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.markDocumentRevisionAsObsolete(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

moveDocument

DocumentRevisionDTO moveDocument(workspaceId, documentId, documentVersion, body)

Move document revision to 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.DocumentsApi();

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 | Document revision to move


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

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

publishDocumentRevision

publishDocumentRevision(workspaceId, documentId, documentVersion)

Publish a 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.DocumentsApi();

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.publishDocumentRevision(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

releaseDocumentRevision

DocumentRevisionDTO releaseDocumentRevision(workspaceId, documentId, documentVersion)

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

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.releaseDocumentRevision(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

removeAttachedFileFromDocument

removeAttachedFileFromDocument(workspaceId, documentId, documentVersion, docIteration, fileName)

Remove attached file from document 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.DocumentsApi();

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

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

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

var docIteration = 56; // Number | Document 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.removeAttachedFileFromDocument(workspaceId, documentId, documentVersion, docIteration, fileName, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

removeDocTags

DocumentRevisionDTO removeDocTags(workspaceId, documentId, documentVersion, tagName)

Remove tags from 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.DocumentsApi();

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

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

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

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


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

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

renameAttachedFileInDocument

FileDTO renameAttachedFileInDocument(workspaceId, documentId, documentVersion, docIteration, fileName, body)

Rename attached files of document 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.DocumentsApi();

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

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

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

var docIteration = 56; // Number | Document iteration

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

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


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

Parameters

Return type

FileDTO

Authorization

authorization

HTTP request headers

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

saveDocTags

DocumentRevisionDTO saveDocTags(workspaceId, documentId, documentVersion, body)

Set the tags 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.DocumentsApi();

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 save


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

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

searchDocumentRevision

[DocumentRevisionDTO] searchDocumentRevision(workspaceId, opts)

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

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

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

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

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

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

searchDocumentRevisionsToLink

[DocumentRevisionDTO] searchDocumentRevisionsToLink(workspaceId, q, opts)

Search document revisions by id and/or name

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

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

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

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

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

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

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

subscribeToIterationChangeEvent

subscribeToIterationChangeEvent(workspaceId, documentId, documentVersion)

Subscribe to notifications on change events 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.DocumentsApi();

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.subscribeToIterationChangeEvent(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

subscribeToStateChangeEvent

subscribeToStateChangeEvent(workspaceId, documentId, documentVersion)

Subscribe to notifications on state events 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.DocumentsApi();

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.subscribeToStateChangeEvent(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

unPublishDocumentRevision

unPublishDocumentRevision(workspaceId, documentId, documentVersion)

Un-publish a 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.DocumentsApi();

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.unPublishDocumentRevision(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

unSubscribeToIterationChangeEvent

unSubscribeToIterationChangeEvent(workspaceId, documentId, documentVersion)

Unsubscribe from notifications on change events 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.DocumentsApi();

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.unSubscribeToIterationChangeEvent(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

undoCheckOutDocument

DocumentRevisionDTO undoCheckOutDocument(workspaceId, documentId, documentVersion)

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

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.undoCheckOutDocument(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

DocumentRevisionDTO

Authorization

authorization

HTTP request headers

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

unsubscribeToStateChangeEvent

unsubscribeToStateChangeEvent(workspaceId, documentId, documentVersion)

Unsubscribe to notifications on state events 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.DocumentsApi();

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.unsubscribeToStateChangeEvent(workspaceId, documentId, documentVersion, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

updateDocumentIteration

DocumentIterationDTO updateDocumentIteration(workspaceId, documentId, documentVersion, docIteration, body)

Update document 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.DocumentsApi();

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

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

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

var docIteration = 56; // Number | Document iteration

var body = new DocdokuPlmApi.DocumentIterationDTO(); // DocumentIterationDTO | Document iteration to update


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

Parameters

Return type

DocumentIterationDTO

Authorization

authorization

HTTP request headers

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

updateDocumentRevisionACL

updateDocumentRevisionACL(workspaceId, documentId, documentVersion, body)

Update document revision ACL

Example

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

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

var apiInstance = new DocdokuPlmApi.DocumentsApi();

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.ACLDTO(); // ACLDTO | ACL rules to set


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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