JBoss.orgCommunity Documentation

ManageDocumentService

Service name Service URL Location Description
ManageDocumentService {portalname}/{restcontextname}/managedocument/

Maven groupId: org.exoplatform.ecms

ArtifactId: exo-ecms-core-connector

The service which is used to perform some actions on a folder or a file, such as creating, deleting a folder/file, or uploading a file.
Name Service URL endpoint Parameters Values Description
getDrives {portalname}/{restcontextname}/managedocument/getDrives/

driveType - types of drive (General, Group, or Personal)

showPrivate - show the Private drive or not. The default value is false

string Get all drives by type (General, Group or Personal drive).
getFoldersAndFiles {portalname}/{restcontextname}/managedocument/getFoldersAndFiles/

driveName - the drive name

workspaceName - the workspace name

currentFolder - the path to the folder to achieve its folders and file

showHidden - show hidden items or not. The default value is false

string

string

string

Get all folders and files which the current user can view.
createFolder {portalname}/{restcontextname}/managedocument/createFolder/

driveName - the drive name

workspaceName - the workspace name

currentFolder - the path to the folder to which a child folder is add

folderName - the folder name show the Private drive or not.

string

string

string

string

Create a new folder and return its information.
deleteFolderOrFile {portalname}/{restcontextname}/managedocument/deleteFolderOrFile/

driveName - the drive name

workspaceName - the workspace name

itemPath - the path to the folder/file.

string

string

string

Delete a folder or a file.
upload {portalname}/{restcontextname}/managedocument//uploadFile/upload/

servletRequest - the servlet request

uploadId - the Id of the upload resource

HttpServletRequest

string

Upload a file to the server.
control {portalname}/{restcontextname}/managedocument//uploadFile/control/

workspaceName - the workspace name

driveName - the drive name

currentFolder - the path to the current folder

currentPortal - the current site

action - the action to perform (save, process and more)

language - the language of the user

fileName - the file name

uploadId - the Id of the upload resource

string

string

string

string

string

string

string

string

Return the information about the upload status of a file (upload percentage, file name, and more).