All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
createDocumentMasterInFolder | POST /workspaces/{workspaceId}/folders/{folderId}/documents | Create a new document revision in given folder |
createRootFolder | POST /workspaces/{workspaceId}/folders | Create root folder |
createSubFolder | POST /workspaces/{workspaceId}/folders/{parentFolderPath}/folders | Create a sub folder in a given folder |
deleteRootFolder | DELETE /workspaces/{workspaceId}/folders/{folderId} | Delete root folder |
getDocumentsWithGivenFolderIdAndWorkspaceId | GET /workspaces/{workspaceId}/folders/{folderId}/documents | Get document revisions in given folder |
getRootFolders | GET /workspaces/{workspaceId}/folders | Get root folders |
getSubFolders | GET /workspaces/{workspaceId}/folders/{completePath}/folders | Get sub folders of given folder |
moveFolder | PUT /workspaces/{workspaceId}/folders/{folderId}/move | Move a folder to given folder |
renameFolder | PUT /workspaces/{workspaceId}/folders/{folderId} | Rename a folder |
DocumentRevisionDTO createDocumentMasterInFolder(workspaceId, body, folderId)
Create a new document revision in 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.FoldersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
body | DocumentCreationDTO | Document to create | |
folderId | String | Folder id |
FolderDTO createRootFolder(workspaceId, body)
Create root 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.FoldersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
body | FolderDTO | Folder to create |
FolderDTO createSubFolder(workspaceId, parentFolderPath, body)
Create a sub folder in a 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.FoldersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
parentFolderPath | String | Parent folder id | |
body | FolderDTO | Folder to create |
deleteRootFolder(workspaceId, folderId)
Delete root 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.FoldersApi();
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);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
folderId | String | Folder id |
null (empty response body)
[DocumentRevisionDTO] getDocumentsWithGivenFolderIdAndWorkspaceId(workspaceId, folderId)
Get document revisions in 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.FoldersApi();
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. Returned data: ' + data);
}
};
apiInstance.getDocumentsWithGivenFolderIdAndWorkspaceId(workspaceId, folderId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
folderId | String | Folder id |
[FolderDTO] getRootFolders(workspaceId)
Get root folders
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.FoldersApi();
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.getRootFolders(workspaceId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id |
[FolderDTO] getSubFolders(workspaceId, completePath)
Get sub folders of 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.FoldersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var completePath = "completePath_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.getSubFolders(workspaceId, completePath, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
completePath | String | Folder id |
FolderDTO moveFolder(workspaceId, folderId, body)
Move a folder 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.FoldersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var folderId = "folderId_example"; // String | Folder id
var body = new DocdokuPlmApi.FolderDTO(); // FolderDTO | Folder to move
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.moveFolder(workspaceId, folderId, body, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
folderId | String | Folder id | |
body | FolderDTO | Folder to move |
FolderDTO renameFolder(workspaceId, folderId, body)
Rename a 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.FoldersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var folderId = "folderId_example"; // String | Folder id
var body = new DocdokuPlmApi.FolderDTO(); // FolderDTO | Folder with new name
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.renameFolder(workspaceId, folderId, body, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
folderId | String | Folder id | |
body | FolderDTO | Folder with new name |