Uses of Annotation Interface
com.logicaldoc.webservice.doc.WSDoc
-
Uses of WSDoc in com.logicaldoc.webservice.model
Modifier and TypeFieldDescriptionstatic final int
WSDocument.DOC_CHECKED_OUT
static final int
WSDocument.DOC_LOCKED
static final int
WSDocument.DOC_UNLOCKED
static final int
WSDocument.EXPORT_LOCKED
static final int
WSDocument.EXPORT_UNLOCKED
static final long
WSGroup.GROUPID_ADMIN
static final int
WSDocument.INDEX_INDEXED
static final int
WSDocument.INDEX_SKIP
static final int
WSDocument.INDEX_TO_INDEX
static final int
WSUser.SOURCE_ACTIVE_DIRECTORY
static final int
WSUser.SOURCE_DEFAULT
static final int
WSUser.SOURCE_LDAP
static final int
WSAttribute.TYPE_BOOLEAN
static final int
WSAttribute.TYPE_DATE
static final int
WSGroup.TYPE_DEFAULT
static final int
WSUser.TYPE_DEFAULT
static final int
WSAttribute.TYPE_DOCUMENT
static final int
WSAttribute.TYPE_DOUBLE
static final int
WSAttribute.TYPE_FOLDER
static final int
WSUser.TYPE_GUEST
static final int
WSAttribute.TYPE_INT
static final int
WSAttribute.TYPE_STRING
static final int
WSUser.TYPE_SYSTEM
static final int
WSAttribute.TYPE_USER
static final int
WSGroup.TYPE_USER
static final long
WSUser.USERID_ADMIN
-
Uses of WSDoc in com.logicaldoc.webservice.soap
Modifier and TypeInterfaceDescriptioninterface
Auth Web Service definition interfaceinterface
Bookmark Web Service definition interface Marco Meschieri - LogicalDOCinterface
interface
Document Web Service definition interfaceinterface
Folder Web Service definition interfaceinterface
Search Web Service definition interfaceinterface
Security Web Service definition interfaceinterface
System Web Service definition interfaceinterface
Tag Web Service definition interface Marco Meschieri - LogicalDOCModifier and TypeMethodDescriptionvoid
DocumentMetadataService.addAttributeOption
(String sid, long setId, String attribute, WSAttributeOption option) Add a new option for the given attributevoid
TagService.addDocumentTags
(String sid, long docId, List<String> tags) Adds tags to a documentvoid
TagService.addFolderTags
(String sid, long folderId, List<String> tags) Adds tags to a folderAdds a new note for the given documentBookmarkService.bookmarkDocument
(String sid, long docId) BookmarkService.bookmarkFolder
(String sid, long folderId) int
SecurityService.changePassword
(String sid, long userId, String oldPassword, String newPassword) changes the password of a user.
0 if all is ok, 1 if the password is incorrect, 2 if the new password cannot be notified, otherwise a positive number grater than 2void
DocumentService.checkin
(String sid, long docId, String comment, String filename, boolean release, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
DocumentService.checkinDocument
(String sid, long docId, String comment, String filename, boolean release, WSDocument docVO, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
Checks out an existing document with the given identifier.DocumentService.copy
(String sid, long docId, long folderId, boolean links, boolean notes, boolean security) Copies a document into another folder.void
FolderService.copy
(String sid, long folderId, long targetId, int foldersOnly, String securityOption) Copies an existing folder with the given identifier.DocumentService.create
(String sid, WSDocument document, javax.activation.DataHandler content) Create a new document.Creates a new folder.DocumentService.createAlias
(String sid, long docId, long folderId, String type) Creates a new document alias for the given document inside a specified folderFolderService.createAlias
(String sid, long parentId, long foldRef) Creates a new folder aliasDocumentService.createDownloadTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads) Creates a new download ticketlong
FolderService.createFolder
(String sid, long parentId, String name) Create a new folder.FolderService.createPath
(String sid, long parentId, String path) Creates the folder for the specified path.void
Creates the PDF conversion of the given document.void
DocumentService.createThumbnail
(String sid, long docId, String fileVersion, String type) Creates the thumbnail of the given document.DocumentService.createViewTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews) Creates a new view ticketvoid
Deletes an existing document with the given identifier.void
Deletes an existing folder.void
DocumentMetadataService.deleteAttributeSet
(String sid, long setId) Deletes an existing attribute set with the given identifier.void
BookmarkService.deleteBookmark
(String sid, long bookmarkId) void
SecurityService.deleteGroup
(String sid, long groupId) Deletes an existing group with the given identifiervoid
DocumentService.deleteLink
(String sid, long id) Removes an existing linkvoid
DocumentService.deleteNote
(String sid, long noteId) Adds a new note for the given documentvoid
DocumentMetadataService.deleteTemplate
(String sid, long templateId) Deletes an existing template with the given identifiervoid
SecurityService.deleteUser
(String sid, long userId) Deletes an existing user with the given identifierDocumentService.deleteVersion
(String sid, long docId, String version) Deletes a version of a document with the given identifiers.SearchService.find
(String sid, WSSearchOptions options) Performs a search by the search options.SearchService.findByFilename
(String sid, String filename) Finds authorized documents for the current user the given filename (like operator is used)FolderService.findByPath
(String sid, String path) Finds the folder at the specified pathTagService.findDocumentsByTag
(String sid, String tag) Finds authorized documents for the current user having a specified tagSearchService.findFolders
(String sid, String name) Finds authorized folders for the current user containing the given name (like operator is used)TagService.findFoldersByTag
(String sid, String tag) Finds authorized folders for the current user having a specified tagDocumentMetadataService.getAccessControlList
(String sid, long templateId) Retrieves the access control listDocumentService.getAccessControlList
(String sid, long docId) Retrieves the access control listFolderService.getAccessControlList
(String sid, long folderId) Retrieves the access control listDocumentService.getAliases
(String sid, long docId) Gets the aliases of the given documentDocumentMetadataService.getAttributeOptions
(String sid, long setId, String attribute) Retrieves the options for the given attributeDocumentMetadataService.getAttributeOptionsByCategory
(String sid, long setId, String attribute, String category) Retrieves the options for the given attribute inside a given categoryDocumentMetadataService.getAttributeSet
(String sid, String name) Gets attribute set's metadataDocumentMetadataService.getAttributeSetById
(String sid, long setId) Gets attribute set's metadataBookmarkService.getBookmarks
(String sid) Retrieves all the bookmarks of the current userjavax.activation.DataHandler
DocumentService.getContent
(String sid, long docId) Gets the content of an existing document with the given identifierFolderService.getDefaultWorkspace
(String sid) Gets the Default workspaceDocumentService.getDocument
(String sid, long docId) Gets the metadata of an existing document with the given identifierDocumentService.getDocumentByCustomId
(String sid, String customId) Gets document metadata of an existing document with the given custom identifierDocumentService.getDocuments
(String sid, List<Long> docIds) Gets document metadata of a collection of existing documents with the given identifiersTagService.getDocumentTags
(String sid, long docId) Retrieves all the tags of a document.DocumentService.getExtractedText
(String sid, long docId) Gets the document's text stored in the full-text indexGets an existing folderTagService.getFolderTags
(String sid, long folderId) Retrieves all the tags of a folderGets group metadata of an existing group with the given identifierSystemService.getInfo()
Retrieves the Installation informationsSystemService.getLanguages
(String tenantOrSid) Retrieves the languages enabled in the server.Gets all the links of a specific documentGets the notes for the given documentComputes the path from the root to the target folder.DocumentService.getRatings
(String sid, long docId) Gets all the ratings of the given documentDocumentService.getRecentDocuments
(String sid, Integer maxHits) Lists of last modified documents by current user.javax.activation.DataHandler
DocumentService.getResource
(String sid, long docId, String fileVersion, String suffix) Gets the content of a resource associated to the given document.FolderService.getRootFolder
(String sid) Gets root metadataSystemService.getStatistics
(String sid) Retrieves the system statisticsTagService.getTagCloud
(String sid) Retrieves all tag clouds in the repository.Retrieves all the tags in the repositoryTagService.getTagsPreset
(String sid) Retrieves all the tags in the preset(if the input mode is preset).DocumentMetadataService.getTemplate
(String sid, String name) Gets template's metadataDocumentMetadataService.getTemplateById
(String sid, long templateId) Gets template's metadataSystemService.getTenantStatistics
(String sid, long tenantId) Retrieves the statistics of a tenenatGets user metadata of an existing user with the given identifierSecurityService.getUserByUsername
(String sid, String username) Gets user metadata of an existing user with the given usernameDocumentService.getVersion
(String sid, long docId, String version) Gets a specific versionjavax.activation.DataHandler
DocumentService.getVersionContent
(String sid, long docId, String version) Gets the content of a specific version of a documentDocumentService.getVersions
(String sid, long docId) Gets the version history of an existing document with the given identifierboolean
DocumentService.isDownload
(String sid, long docId) Tests if a document is downloadableboolean
Tests if the current user has a specific permission on a documentboolean
Tests if the current user has a specific permission on a folderboolean
Tests if a document is readable.boolean
DocumentMetadataService.isReadable
(String sid, long templateId) Tests if a template is readable.boolean
FolderService.isReadable
(String sid, long folderId) Tests if a folder is readable.boolean
DocumentMetadataService.isWritable
(String sid, long templateId) Tests if a template is writableboolean
FolderService.isWritable
(String sid, long folderId) Tests if a folder is writableboolean
Tests if a document is writableCreates a new link between two documents.DocumentService.list
(String sid, long folderId, String fileName, String sort, Integer page, Integer max) Gets the documents in a specific folderLists all direct folders of a parent folder.
Attention: readable sub-folders only are returned.DocumentMetadataService.listAttributeSets
(String sid) Gets metadata of all existing attribute sets.FolderService.listChildren
(String sid, long folderId) Lists all direct folders of a parent folder.
Attention: readable only sub-folders are returned.DocumentService.listDocuments
(String sid, long folderId, String fileName) Gets the documents in a specific folderSecurityService.listGroups
(String sid) Gets group metadata of all existing groups.DocumentMetadataService.listTemplates
(String sid) Gets metadata of all existing templates.Gets metadata of all existing usersFolderService.listWorkspaces
(String sid) Retrieves the list of all workspaces.void
Locks an existing document with the given identifier.Starts a new session.AuthService.loginApiKey
(String apiKey) Starts a new session.void
Closes a session.void
Merges the contents of folder into a targetvoid
Moves an existing document with the given identifier.void
Moves an existing folder with the given identifier.void
DocumentService.promoteVersion
(String sid, long docId, String version) Promotes an old version to the current default one.DocumentService.rateDocument
(String sid, long docId, int vote) Puts a new rating on the given documentvoid
Re-indexes(or indexes from scratch) a documentvoid
Renames the title of an existing document with the given identifier.void
Renames an existing folder.void
Renews a sessionvoid
DocumentService.replaceFile
(String sid, long docId, String fileVersion, String comment, javax.activation.DataHandler content) Replaces the file associated to a given version.void
Restores a deleted documentBookmarkService.saveBookmark
(String sid, WSBookmark bookmark) Adds a new note for the given documentvoid
DocumentService.sendEmail
(String sid, List<Long> docIds, String recipients, String subject, String message) Sends a set of documents as mail attachmentsvoid
DocumentMetadataService.setAccessControlList
(String sid, long templateId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
DocumentService.setAccessControlList
(String sid, long docId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
FolderService.setAccessControlList
(String sid, long folderId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
DocumentMetadataService.setAttributeOptions
(String sid, long setId, String attribute, List<WSAttributeOption> options) Saves the options for the given attributevoid
TagService.setDocumentTags
(String sid, long docId, List<String> tags) Sets the tags of a documentvoid
TagService.setFolderTags
(String sid, long folderId, List<String> tags) Sets the tags of a foldervoid
DocumentService.setPassword
(String sid, long docId, String password) Puts a password protection to the documentlong
DocumentMetadataService.storeAttributeSet
(String sid, WSAttributeSet attributeSet) Create/Update an attribute set.long
SecurityService.storeGroup
(String sid, WSGroup group) Creates/Updates a group.long
DocumentMetadataService.storeTemplate
(String sid, WSTemplate template) Create/Update a template.long
Creates/Updates a user.void
BookmarkService.unbookmarkDocument
(String sid, long docId) void
BookmarkService.unbookmarkFolder
(String sid, long folderId) void
Unlocks an existing document with the given identifier.boolean
Unprotects a document that is password protected.void
DocumentService.unsetPassword
(String sid, long docId, String currentPassword) Removes the password protection from the documentvoid
DocumentService.update
(String sid, WSDocument document) Updates an existing document with the value object containing the document's metadatavoid
Updates an existing folder.long
DocumentService.upload
(String sid, Long docId, Long folderId, boolean release, String filename, String language, javax.activation.DataHandler content) Creates a new document or updates an existing one.void
DocumentService.uploadResource
(String sid, long docId, String fileVersion, String suffix, javax.activation.DataHandler content) Uploads a new resource attached to the given document.boolean
Checks if a SID is validModifier and TypeMethodDescriptionvoid
TagService.addDocumentTags
(String sid, long docId, List<String> tags) Adds tags to a documentvoid
TagService.addDocumentTags
(String sid, long docId, List<String> tags) Adds tags to a documentvoid
TagService.addFolderTags
(String sid, long folderId, List<String> tags) Adds tags to a folderAdds a new note for the given documentAdds a new note for the given documentint
SecurityService.changePassword
(String sid, long userId, String oldPassword, String newPassword) changes the password of a user.
0 if all is ok, 1 if the password is incorrect, 2 if the new password cannot be notified, otherwise a positive number grater than 2void
DocumentService.checkin
(String sid, long docId, String comment, String filename, boolean release, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
DocumentService.checkin
(String sid, long docId, String comment, String filename, boolean release, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
DocumentService.checkin
(String sid, long docId, String comment, String filename, boolean release, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
DocumentService.checkinDocument
(String sid, long docId, String comment, String filename, boolean release, WSDocument docVO, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
DocumentService.checkinDocument
(String sid, long docId, String comment, String filename, boolean release, WSDocument docVO, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
DocumentService.checkinDocument
(String sid, long docId, String comment, String filename, boolean release, WSDocument docVO, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
DocumentService.checkinDocument
(String sid, long docId, String comment, String filename, boolean release, WSDocument docVO, javax.activation.DataHandler content) Checks in an existing document with the given identifier to create a new version.void
Checks out an existing document with the given identifier.void
Checks out an existing document with the given identifier.DocumentService.copy
(String sid, long docId, long folderId, boolean links, boolean notes, boolean security) Copies a document into another folder.DocumentService.copy
(String sid, long docId, long folderId, boolean links, boolean notes, boolean security) Copies a document into another folder.DocumentService.copy
(String sid, long docId, long folderId, boolean links, boolean notes, boolean security) Copies a document into another folder.DocumentService.copy
(String sid, long docId, long folderId, boolean links, boolean notes, boolean security) Copies a document into another folder.DocumentService.copy
(String sid, long docId, long folderId, boolean links, boolean notes, boolean security) Copies a document into another folder.DocumentService.copy
(String sid, long docId, long folderId, boolean links, boolean notes, boolean security) Copies a document into another folder.void
FolderService.copy
(String sid, long folderId, long targetId, int foldersOnly, String securityOption) Copies an existing folder with the given identifier.void
FolderService.copy
(String sid, long folderId, long targetId, int foldersOnly, String securityOption) Copies an existing folder with the given identifier.void
FolderService.copy
(String sid, long folderId, long targetId, int foldersOnly, String securityOption) Copies an existing folder with the given identifier.void
FolderService.copy
(String sid, long folderId, long targetId, int foldersOnly, String securityOption) Copies an existing folder with the given identifier.DocumentService.create
(String sid, WSDocument document, javax.activation.DataHandler content) Create a new document.DocumentService.create
(String sid, WSDocument document, javax.activation.DataHandler content) Create a new document.Creates a new folder.Creates a new folder.DocumentService.createAlias
(String sid, long docId, long folderId, String type) Creates a new document alias for the given document inside a specified folderDocumentService.createAlias
(String sid, long docId, long folderId, String type) Creates a new document alias for the given document inside a specified folderDocumentService.createAlias
(String sid, long docId, long folderId, String type) Creates a new document alias for the given document inside a specified folderFolderService.createAlias
(String sid, long parentId, long foldRef) Creates a new folder aliasFolderService.createAlias
(String sid, long parentId, long foldRef) Creates a new folder aliasFolderService.createAlias
(String sid, long parentId, long foldRef) Creates a new folder aliasDocumentService.createDownloadTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads) Creates a new download ticketDocumentService.createDownloadTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads) Creates a new download ticketDocumentService.createDownloadTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads) Creates a new download ticketDocumentService.createDownloadTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads) Creates a new download ticketDocumentService.createDownloadTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads) Creates a new download ticketDocumentService.createDownloadTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads) Creates a new download ticketlong
FolderService.createFolder
(String sid, long parentId, String name) Create a new folder.FolderService.createPath
(String sid, long parentId, String path) Creates the folder for the specified path.FolderService.createPath
(String sid, long parentId, String path) Creates the folder for the specified path.void
Creates the PDF conversion of the given document.void
Creates the PDF conversion of the given document.void
Creates the PDF conversion of the given document.void
DocumentService.createThumbnail
(String sid, long docId, String fileVersion, String type) Creates the thumbnail of the given document.void
DocumentService.createThumbnail
(String sid, long docId, String fileVersion, String type) Creates the thumbnail of the given document.void
DocumentService.createThumbnail
(String sid, long docId, String fileVersion, String type) Creates the thumbnail of the given document.void
DocumentService.createThumbnail
(String sid, long docId, String fileVersion, String type) Creates the thumbnail of the given document.DocumentService.createViewTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews) Creates a new view ticketDocumentService.createViewTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews) Creates a new view ticketDocumentService.createViewTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews) Creates a new view ticketDocumentService.createViewTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews) Creates a new view ticketDocumentService.createViewTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews) Creates a new view ticketDocumentService.createViewTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews) Creates a new view ticketDocumentService.createViewTicket
(String sid, long docId, String suffix, Integer expireHours, String expireDate, Integer maxDownloads, Integer maxViews) Creates a new view ticketvoid
Deletes an existing document with the given identifier.void
Deletes an existing document with the given identifier.void
Deletes an existing folder.void
SecurityService.deleteGroup
(String sid, long groupId) Deletes an existing group with the given identifiervoid
DocumentService.deleteLink
(String sid, long id) Removes an existing linkvoid
DocumentService.deleteLink
(String sid, long id) Removes an existing linkvoid
DocumentService.deleteNote
(String sid, long noteId) Adds a new note for the given documentvoid
SecurityService.deleteUser
(String sid, long userId) Deletes an existing user with the given identifierDocumentService.deleteVersion
(String sid, long docId, String version) Deletes a version of a document with the given identifiers.DocumentService.deleteVersion
(String sid, long docId, String version) Deletes a version of a document with the given identifiers.DocumentService.deleteVersion
(String sid, long docId, String version) Deletes a version of a document with the given identifiers.SearchService.find
(String sid, WSSearchOptions options) Performs a search by the search options.SearchService.findByFilename
(String sid, String filename) Finds authorized documents for the current user the given filename (like operator is used)FolderService.findByPath
(String sid, String path) Finds the folder at the specified pathFolderService.findByPath
(String sid, String path) Finds the folder at the specified pathTagService.findDocumentsByTag
(String sid, String tag) Finds authorized documents for the current user having a specified tagSearchService.findFolders
(String sid, String name) Finds authorized folders for the current user containing the given name (like operator is used)TagService.findFoldersByTag
(String sid, String tag) Finds authorized folders for the current user having a specified tagDocumentMetadataService.getAccessControlList
(String sid, long templateId) Retrieves the access control listDocumentService.getAccessControlList
(String sid, long docId) Retrieves the access control listFolderService.getAccessControlList
(String sid, long folderId) Retrieves the access control listDocumentService.getAliases
(String sid, long docId) Gets the aliases of the given documentDocumentService.getAliases
(String sid, long docId) Gets the aliases of the given documentjavax.activation.DataHandler
DocumentService.getContent
(String sid, long docId) Gets the content of an existing document with the given identifierjavax.activation.DataHandler
DocumentService.getContent
(String sid, long docId) Gets the content of an existing document with the given identifierFolderService.getDefaultWorkspace
(String sid) Gets the Default workspaceDocumentService.getDocument
(String sid, long docId) Gets the metadata of an existing document with the given identifierDocumentService.getDocument
(String sid, long docId) Gets the metadata of an existing document with the given identifierDocumentService.getDocumentByCustomId
(String sid, String customId) Gets document metadata of an existing document with the given custom identifierDocumentService.getDocuments
(String sid, List<Long> docIds) Gets document metadata of a collection of existing documents with the given identifiersTagService.getDocumentTags
(String sid, long docId) Retrieves all the tags of a document.TagService.getDocumentTags
(String sid, long docId) Retrieves all the tags of a document.DocumentService.getExtractedText
(String sid, long docId) Gets the document's text stored in the full-text indexDocumentService.getExtractedText
(String sid, long docId) Gets the document's text stored in the full-text indexGets an existing folderTagService.getFolderTags
(String sid, long folderId) Retrieves all the tags of a folderGets group metadata of an existing group with the given identifierSystemService.getLanguages
(String tenantOrSid) Retrieves the languages enabled in the server.Gets all the links of a specific documentGets all the links of a specific documentGets the notes for the given documentGets the notes for the given documentComputes the path from the root to the target folder.DocumentService.getRatings
(String sid, long docId) Gets all the ratings of the given documentDocumentService.getRatings
(String sid, long docId) Gets all the ratings of the given documentDocumentService.getRecentDocuments
(String sid, Integer maxHits) Lists of last modified documents by current user.DocumentService.getRecentDocuments
(String sid, Integer maxHits) Lists of last modified documents by current user.javax.activation.DataHandler
DocumentService.getResource
(String sid, long docId, String fileVersion, String suffix) Gets the content of a resource associated to the given document.javax.activation.DataHandler
DocumentService.getResource
(String sid, long docId, String fileVersion, String suffix) Gets the content of a resource associated to the given document.javax.activation.DataHandler
DocumentService.getResource
(String sid, long docId, String fileVersion, String suffix) Gets the content of a resource associated to the given document.javax.activation.DataHandler
DocumentService.getResource
(String sid, long docId, String fileVersion, String suffix) Gets the content of a resource associated to the given document.FolderService.getRootFolder
(String sid) Gets root metadataTagService.getTagCloud
(String sid) Retrieves all tag clouds in the repository.Retrieves all the tags in the repositoryTagService.getTagsPreset
(String sid) Retrieves all the tags in the preset(if the input mode is preset).Gets user metadata of an existing user with the given identifierSecurityService.getUserByUsername
(String sid, String username) Gets user metadata of an existing user with the given usernameDocumentService.getVersion
(String sid, long docId, String version) Gets a specific versionDocumentService.getVersion
(String sid, long docId, String version) Gets a specific versionDocumentService.getVersion
(String sid, long docId, String version) Gets a specific versionjavax.activation.DataHandler
DocumentService.getVersionContent
(String sid, long docId, String version) Gets the content of a specific version of a documentjavax.activation.DataHandler
DocumentService.getVersionContent
(String sid, long docId, String version) Gets the content of a specific version of a documentjavax.activation.DataHandler
DocumentService.getVersionContent
(String sid, long docId, String version) Gets the content of a specific version of a documentDocumentService.getVersions
(String sid, long docId) Gets the version history of an existing document with the given identifierDocumentService.getVersions
(String sid, long docId) Gets the version history of an existing document with the given identifierboolean
DocumentService.isDownload
(String sid, long docId) Tests if a document is downloadableboolean
Tests if the current user has a specific permission on a documentboolean
Tests if the current user has a specific permission on a documentboolean
Tests if the current user has a specific permission on a folderboolean
Tests if the current user has a specific permission on a folderboolean
Tests if a document is readable.boolean
DocumentMetadataService.isReadable
(String sid, long templateId) Tests if a template is readable.boolean
FolderService.isReadable
(String sid, long folderId) Tests if a folder is readable.boolean
DocumentMetadataService.isWritable
(String sid, long templateId) Tests if a template is writableboolean
FolderService.isWritable
(String sid, long folderId) Tests if a folder is writableboolean
Tests if a document is writableCreates a new link between two documents.Creates a new link between two documents.Creates a new link between two documents.Creates a new link between two documents.DocumentService.list
(String sid, long folderId, String fileName, String sort, Integer page, Integer max) Gets the documents in a specific folderDocumentService.list
(String sid, long folderId, String fileName, String sort, Integer page, Integer max) Gets the documents in a specific folderDocumentService.list
(String sid, long folderId, String fileName, String sort, Integer page, Integer max) Gets the documents in a specific folderDocumentService.list
(String sid, long folderId, String fileName, String sort, Integer page, Integer max) Gets the documents in a specific folderDocumentService.list
(String sid, long folderId, String fileName, String sort, Integer page, Integer max) Gets the documents in a specific folderLists all direct folders of a parent folder.
Attention: readable sub-folders only are returned.Lists all direct folders of a parent folder.
Attention: readable sub-folders only are returned.Lists all direct folders of a parent folder.
Attention: readable sub-folders only are returned.Lists all direct folders of a parent folder.
Attention: readable sub-folders only are returned.FolderService.listChildren
(String sid, long folderId) Lists all direct folders of a parent folder.
Attention: readable only sub-folders are returned.DocumentService.listDocuments
(String sid, long folderId, String fileName) Gets the documents in a specific folderDocumentService.listDocuments
(String sid, long folderId, String fileName) Gets the documents in a specific folderSecurityService.listGroups
(String sid) Gets group metadata of all existing groups.Gets metadata of all existing usersGets metadata of all existing usersFolderService.listWorkspaces
(String sid) Retrieves the list of all workspaces.void
Locks an existing document with the given identifier.void
Locks an existing document with the given identifier.void
Closes a session.void
Merges the contents of folder into a targetvoid
Moves an existing document with the given identifier.void
Moves an existing document with the given identifier.void
Moves an existing document with the given identifier.void
Moves an existing folder with the given identifier.void
Moves an existing folder with the given identifier.void
DocumentService.promoteVersion
(String sid, long docId, String version) Promotes an old version to the current default one.void
DocumentService.promoteVersion
(String sid, long docId, String version) Promotes an old version to the current default one.DocumentService.rateDocument
(String sid, long docId, int vote) Puts a new rating on the given documentDocumentService.rateDocument
(String sid, long docId, int vote) Puts a new rating on the given documentvoid
Re-indexes(or indexes from scratch) a documentvoid
Re-indexes(or indexes from scratch) a documentvoid
Re-indexes(or indexes from scratch) a documentvoid
Renames the title of an existing document with the given identifier.void
Renames the title of an existing document with the given identifier.void
Renames an existing folder.void
Renames an existing folder.void
Renews a sessionvoid
DocumentService.replaceFile
(String sid, long docId, String fileVersion, String comment, javax.activation.DataHandler content) Replaces the file associated to a given version.void
DocumentService.replaceFile
(String sid, long docId, String fileVersion, String comment, javax.activation.DataHandler content) Replaces the file associated to a given version.void
Restores a deleted documentvoid
Restores a deleted documentvoid
Restores a deleted documentAdds a new note for the given documentAdds a new note for the given documentvoid
DocumentService.sendEmail
(String sid, List<Long> docIds, String recipients, String subject, String message) Sends a set of documents as mail attachmentsvoid
DocumentService.sendEmail
(String sid, List<Long> docIds, String recipients, String subject, String message) Sends a set of documents as mail attachmentsvoid
DocumentMetadataService.setAccessControlList
(String sid, long templateId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
DocumentMetadataService.setAccessControlList
(String sid, long templateId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
DocumentService.setAccessControlList
(String sid, long docId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
DocumentService.setAccessControlList
(String sid, long docId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
FolderService.setAccessControlList
(String sid, long folderId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
FolderService.setAccessControlList
(String sid, long folderId, List<WSAccessControlEntry> acl) Sets the Access Control Listvoid
TagService.setDocumentTags
(String sid, long docId, List<String> tags) Sets the tags of a documentvoid
TagService.setDocumentTags
(String sid, long docId, List<String> tags) Sets the tags of a documentvoid
TagService.setFolderTags
(String sid, long folderId, List<String> tags) Sets the tags of a foldervoid
DocumentService.setPassword
(String sid, long docId, String password) Puts a password protection to the documentvoid
DocumentService.setPassword
(String sid, long docId, String password) Puts a password protection to the documentlong
SecurityService.storeGroup
(String sid, WSGroup group) Creates/Updates a group.long
Creates/Updates a user.void
Unlocks an existing document with the given identifier.void
Unlocks an existing document with the given identifier.boolean
Unprotects a document that is password protected.boolean
Unprotects a document that is password protected.void
DocumentService.unsetPassword
(String sid, long docId, String currentPassword) Removes the password protection from the documentvoid
DocumentService.unsetPassword
(String sid, long docId, String currentPassword) Removes the password protection from the documentvoid
DocumentService.update
(String sid, WSDocument document) Updates an existing document with the value object containing the document's metadatavoid
Updates an existing folder.long
DocumentService.upload
(String sid, Long docId, Long folderId, boolean release, String filename, String language, javax.activation.DataHandler content) Creates a new document or updates an existing one.long
DocumentService.upload
(String sid, Long docId, Long folderId, boolean release, String filename, String language, javax.activation.DataHandler content) Creates a new document or updates an existing one.long
DocumentService.upload
(String sid, Long docId, Long folderId, boolean release, String filename, String language, javax.activation.DataHandler content) Creates a new document or updates an existing one.long
DocumentService.upload
(String sid, Long docId, Long folderId, boolean release, String filename, String language, javax.activation.DataHandler content) Creates a new document or updates an existing one.long
DocumentService.upload
(String sid, Long docId, Long folderId, boolean release, String filename, String language, javax.activation.DataHandler content) Creates a new document or updates an existing one.long
DocumentService.upload
(String sid, Long docId, Long folderId, boolean release, String filename, String language, javax.activation.DataHandler content) Creates a new document or updates an existing one.void
DocumentService.uploadResource
(String sid, long docId, String fileVersion, String suffix, javax.activation.DataHandler content) Uploads a new resource attached to the given document.void
DocumentService.uploadResource
(String sid, long docId, String fileVersion, String suffix, javax.activation.DataHandler content) Uploads a new resource attached to the given document.void
DocumentService.uploadResource
(String sid, long docId, String fileVersion, String suffix, javax.activation.DataHandler content) Uploads a new resource attached to the given document.void
DocumentService.uploadResource
(String sid, long docId, String fileVersion, String suffix, javax.activation.DataHandler content) Uploads a new resource attached to the given document.void
DocumentService.uploadResource
(String sid, long docId, String fileVersion, String suffix, javax.activation.DataHandler content) Uploads a new resource attached to the given document.boolean
Checks if a SID is valid