All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
addDocTag | POST /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tags | Add tags to document revision |
checkInDocument | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/checkin | Checkin document revision |
checkOutDocument | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/checkout | Checkout document revision |
createNewDocumentVersion | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/newVersion | Create a new version of the document revision |
createSharedDocument | POST /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/share | Create a shared document for given document revision |
deleteDocument | DELETE /workspaces/{workspaceId}/documents/{documentId}-{documentVersion} | Delete the document revision |
getAbortedWorkflowListInDocument | GET /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/aborted-workflows | Get document revision aborted workflow history |
getDocumentRevision | GET /workspaces/{workspaceId}/documents/{documentId}-{documentVersion} | Get document revision |
getInverseDocumentLinks | GET /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-document-link | Get inverse document revisions links |
getInversePartsLinks | GET /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-part-link | Get inverse part revisions links |
getInversePathDataLinks | GET /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-path-data-link | Get inverse path data links |
getInverseProductInstancesLinks | GET /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-product-instances-link | Get inverse product instances links |
markDocumentRevisionAsObsolete | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/obsolete | Set document revision as obsolete |
moveDocument | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/move | Move document revision to given folder |
publishDocumentRevision | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/publish | Publish a document revision |
releaseDocumentRevision | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/release | Release document revision |
removeAttachedFileFromDocument | DELETE /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration}/files/{fileName} | Remove attached file from document iteration |
removeDocTags | DELETE /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tags/{tagName} | Remove tags from document revision |
renameAttachedFileInDocument | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration}/files/{fileName} | Rename attached files of document iteration |
saveDocTags | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tags | Set the tags of the document revision |
subscribeToIterationChangeEvent | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/iterationChange/subscribe | Subscribe to notifications on change events for given document revision |
subscribeToStateChangeEvent | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/stateChange/subscribe | Subscribe to notifications on state events for given document revision |
unPublishDocumentRevision | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/unpublish | Un-publish a document revision |
unSubscribeToIterationChangeEvent | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/iterationChange/unsubscribe | Unsubscribe from notifications on change events for given document revision |
undoCheckOutDocument | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/undocheckout | Undo checkout document revision |
unsubscribeToStateChangeEvent | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/stateChange/unsubscribe | Unsubscribe to notifications on state events for given document revision |
updateDocumentIteration | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration} | Update document iteration |
updateDocumentRevisionACL | PUT /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/acl | Update document revision ACL |
DocumentRevisionDTO addDocTag(workspaceId, documentId, documentVersion, body)
Add tags to document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
body | TagListDTO | Tag list to add |
DocumentRevisionDTO checkInDocument(workspaceId, documentId, documentVersion)
Checkin document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
DocumentRevisionDTO checkOutDocument(workspaceId, documentId, documentVersion)
Checkout document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
[DocumentRevisionDTO] createNewDocumentVersion(workspaceId, documentId, documentVersion, body)
Create a new version of the document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
body | DocumentCreationDTO | New version of document to create |
SharedDocumentDTO createSharedDocument(workspaceId, documentId, documentVersion, body)
Create a shared document for given document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
body | SharedDocumentDTO | Shared document to create |
deleteDocument(workspaceId, documentId, documentVersion)
Delete the document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
null (empty response body)
[WorkflowDTO] getAbortedWorkflowListInDocument(workspaceId, documentId, documentVersion)
Get document revision aborted workflow history
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
DocumentRevisionDTO getDocumentRevision(workspaceId, documentId, documentVersion)
Get document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
[DocumentRevisionDTO] getInverseDocumentLinks(workspaceId, documentId, documentVersion, iteration)
Get inverse document revisions links
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
iteration | Number | Document iteration |
[PartRevisionDTO] getInversePartsLinks(workspaceId, documentId, documentVersion, iteration)
Get inverse part revisions links
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
iteration | Number | Document iteration |
[PathDataMasterDTO] getInversePathDataLinks(workspaceId, documentId, documentVersion, iteration)
Get inverse path data links
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
iteration | Number | Document iteration |
[ProductInstanceMasterDTO] getInverseProductInstancesLinks(workspaceId, documentId, documentVersion, iteration)
Get inverse product instances links
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
iteration | Number | Document iteration |
DocumentRevisionDTO markDocumentRevisionAsObsolete(workspaceId, documentId, documentVersion)
Set document revision as obsolete
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
DocumentRevisionDTO moveDocument(workspaceId, documentId, documentVersion, body)
Move document revision to given folder
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
body | DocumentCreationDTO | Document revision to move |
publishDocumentRevision(workspaceId, documentId, documentVersion)
Publish a document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
null (empty response body)
DocumentRevisionDTO releaseDocumentRevision(workspaceId, documentId, documentVersion)
Release document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
removeAttachedFileFromDocument(workspaceId, documentId, documentVersion, docIteration, fileName)
Remove attached file from document iteration
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
docIteration | Number | Document iteration | |
fileName | String | File name |
null (empty response body)
DocumentRevisionDTO removeDocTags(workspaceId, documentId, documentVersion, tagName)
Remove tags from document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
tagName | String | Tag name |
FileDTO renameAttachedFileInDocument(workspaceId, documentId, documentVersion, docIteration, fileName, body)
Rename attached files of document iteration
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
docIteration | Number | Document iteration | |
fileName | String | File name | |
body | FileDTO | File to rename |
DocumentRevisionDTO saveDocTags(workspaceId, documentId, documentVersion, body)
Set the tags of the document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
body | TagListDTO | Tag list to save |
subscribeToIterationChangeEvent(workspaceId, documentId, documentVersion)
Subscribe to notifications on change events for given document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
null (empty response body)
subscribeToStateChangeEvent(workspaceId, documentId, documentVersion)
Subscribe to notifications on state events for given document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
null (empty response body)
unPublishDocumentRevision(workspaceId, documentId, documentVersion)
Un-publish a document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
null (empty response body)
unSubscribeToIterationChangeEvent(workspaceId, documentId, documentVersion)
Unsubscribe from notifications on change events for given document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
null (empty response body)
DocumentRevisionDTO undoCheckOutDocument(workspaceId, documentId, documentVersion)
Undo checkout document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
unsubscribeToStateChangeEvent(workspaceId, documentId, documentVersion)
Unsubscribe to notifications on state events for given document revision
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version |
null (empty response body)
DocumentIterationDTO updateDocumentIteration(workspaceId, documentId, documentVersion, docIteration, body)
Update document iteration
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
docIteration | Number | Document iteration | |
body | DocumentIterationDTO | Document iteration to update |
updateDocumentRevisionACL(workspaceId, documentId, documentVersion, body)
Update document revision ACL
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.DocumentApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
documentId | String | Document master id | |
documentVersion | String | Document version | |
body | ACLDTO | ACL rules to set |
null (empty response body)