Note |
BaseNote.add(String uuid,
String text) |
Add a note to a node
|
void |
BaseRelation.add(String nodeAId,
String nodeBId,
long relTypeId) |
Add relation.
|
void |
BaseMail.addAccount(MailAccount mailAccount) |
Add mail account.
|
void |
BaseProperty.addCategory(String uuid,
String catId) |
Add category.
|
void |
BasePropertyGroup.addGroup(String uuid,
String grpName,
Map<String,String> propertiesMap) |
Add group.
|
void |
BaseProperty.addKeyword(String uuid,
String keyword) |
Add keyword.
|
void |
BaseRelation.addNodeToGroup(String uuid,
long groupId) |
Add node to group.
|
StampImageSize |
BaseStamp.calculateFlyImageDimensions(String uuid,
long imgToStampWidth,
long imgToStampHeight,
long floatingImageWidth,
long floatingImageHeight,
int pageNumber) |
Calculate fly image dimensions stamp image size.
|
StampCoordinates |
BaseStamp.calculateStampCoordinates(long imgToStampWidth,
long imgToStampHeight,
long floatingDivWidth,
long floatingDivHeight,
String exprX,
String exprY,
String stampType,
String stampAlign) |
Calculate stamp coordinates stamp coordinates.
|
StampExpressions |
BaseStamp.calculateStampExpressions(long imgToStampWidth,
long imgToStampHeight,
long posX,
long posY) |
Calculate stamp expressions stamp expressions.
|
void |
BaseDocument.cancelCheckout(String uuid) |
Cancel a previous checked out state in a document.
|
void |
BaseDocument.captureData(String uuid,
long templateId) |
Proceed to the OCR data capture using OCR template identified by templateId.
|
void |
BaseAuth.changeSecurity(String uuid,
ChangeSecurity changeSecurity) |
Change several security permissions in the same call.
|
void |
BaseShard.changeShard(String uuid,
long shardId) |
Change shard.
|
Version |
BaseDocument.checkin(String uuid,
InputStream is,
String comment) |
Check in the document to create a new version.
|
Version |
BaseDocument.checkin(String uuid,
InputStream is,
String comment,
int increment) |
Check in the document to create a new version.
|
void |
BaseDocument.checkout(String uuid) |
Checkout the document to edit it.
|
Document |
BaseDocument.copy(String uuid,
String dstId,
String newName) |
Copy a document to another location in the repository.
|
Folder |
BaseFolder.copy(String uuid,
String dstId,
String newName) |
Copy folder.
|
Mail |
BaseMail.copy(String uuid,
String dstId,
String newName) |
Copy mail mail.
|
Record |
BaseRecord.copy(String uuid,
String dstId,
String newName) |
Copy record record.
|
void |
BaseRepository.copyAttributes(String uuid,
String dstId,
boolean categories,
boolean keywords,
boolean propertyGroups,
boolean notes) |
Copy attributes.
|
Bookmark |
BaseBookmark.create(String uuid,
String name) |
Add a new bookmark which points to this document.
|
Document |
BaseDocument.create(String uuid,
File file) |
Creates a new document
|
Document |
BaseDocument.create(String uuid,
String name,
InputStream is) |
Creates a new document
|
Document |
BaseDocument.create(String uuid,
String name,
InputStream is,
long nodeClass) |
Creates a new document
|
Folder |
BaseFolder.create(String uuid,
String name) |
Create folder.
|
Folder |
BaseFolder.create(String uuid,
String name,
long nodeClass) |
Create folder.
|
Record |
BaseRecord.create(String uuid,
String name,
String title,
long nodeClass) |
Create record record.
|
Task |
BaseTask.create(String subject,
String start,
String end,
String description,
long statusId,
long projectId,
long typeId,
String user,
List<String> notificationUsers,
List<String> externalUsers,
List<String> relatedDocuments,
List<String> relatedFolders,
List<String> relatedRecords,
List<String> relatedMails,
String repeatExpression,
String repeatUntil,
String formatDate,
int repeatTimes,
String reminderStartUnit,
int reminderStartValue,
String reminderEndUnit,
int reminderEndValue) |
Create task task.
|
void |
BaseAutomation.createAction(long ruleId,
String className,
int order,
boolean active,
String param00,
String param01,
String param02) |
|
Document |
BaseMail.createAttachment(String uuid,
String docName,
InputStream is) |
Create attachment document.
|
void |
BaseMail.createFilter(long mailAccountId,
MailFilter mailFilter) |
Create mail filter.
|
Document |
BaseDocument.createFromTemplate(String uuid,
String dstPath,
boolean categories,
boolean keywords,
boolean notes,
boolean security,
Map<String,String> properties) |
Create from template document.
|
Document |
BaseDocument.createFromTemplate(String uuid,
String dstPath,
boolean categories,
boolean keywords,
boolean notes,
Map<String,String> properties) |
Deprecated.
|
Folder |
BaseFolder.createFromTemplate(String uuid,
String dstPath,
boolean categories,
boolean keywords,
boolean notes,
boolean propertyGroups,
boolean security,
Map<String,String> properties) |
Create from template folder.
|
Folder |
BaseFolder.createFromTemplate(String uuid,
String dstPath,
boolean categories,
boolean keywords,
boolean notes,
Map<String,String> properties) |
Deprecated.
|
Record |
BaseRecord.createFromTemplate(String uuid,
String dstPath,
boolean categories,
boolean keywords,
boolean notes,
boolean propertyGroups,
boolean security,
Map<String,String> properties) |
Create from template record.
|
Record |
BaseRecord.createFromTemplate(String uuid,
String dstPath,
boolean categories,
boolean keywords,
boolean notes,
Map<String,String> properties) |
Deprecated.
|
void |
BaseFolder.createMissingFolders(String fldPath) |
Create missing folders.
|
void |
BaseRecord.createMissingRecords(String recPath) |
Create missing records.
|
TaskNote |
BaseTask.createNote(long taskId,
String text) |
Create note.
|
TaskProject |
BaseTask.createProject(String name,
boolean active,
String description) |
Create task project task project.
|
void |
BaseMail.createRule(long filterId,
MailFilterRule rule) |
Create mail rule.
|
TaskStatus |
BaseTask.createStatus(String name,
boolean finish) |
Create status.
|
TaskType |
BaseTask.createType(String name,
boolean active,
String description) |
Create type.
|
void |
BaseAutomation.createValidation(long ruleId,
boolean negate,
String className,
int order,
boolean active,
String param00,
String param01,
String param02) |
|
WizardNode |
BaseDocument.createWizard(String uuid,
String name,
long nodeClass,
InputStream is) |
Create a new document with wizard.
|
WizardNode |
BaseMail.createWizard(String uuid,
String title,
InputStream is,
String type) |
Create wizard mail wizard node.
|
WizardNode |
BaseRecord.createWizard(String uuid,
String name,
String title,
long nodeClass) |
Create wizard record wizard node.
|
InputStream |
BaseSearch.csvExport(String lang,
QueryParams queryParams,
List<String> propertyGroups,
boolean compact) |
Csv export input stream.
|
void |
BaseBookmark.delete(long bookmarkId) |
Remove a bookmark.
|
void |
BaseDocument.delete(String uuid) |
Deletes a document from the repository.
|
void |
BaseFolder.delete(String uuid) |
Delete folder.
|
void |
BaseMail.delete(String uuid) |
Delete mail.
|
void |
BaseNote.delete(String noteId) |
Remove a note from a node
|
void |
BaseRecord.delete(String uuid) |
Delete record.
|
void |
BaseRelation.delete(long relationId) |
Delete relation.
|
void |
BaseTask.delete(long taskId) |
Delete task.
|
void |
BaseMail.deleteAccount(long mailAccountId) |
Delete mail account.
|
void |
BaseMail.deleteAttachment(String uuid,
String docId) |
Delete attachment.
|
void |
BaseMail.deleteFilter(long mailFilterId) |
Delete mail filter.
|
void |
BaseRelation.deleteGroup(long groupId) |
Delete group.
|
void |
BaseRelation.deleteItemFromGroup(String uuid,
long groupId) |
Delete item from group.
|
void |
BaseTask.deleteNote(long noteId) |
Delete task note.
|
void |
BaseWorkflow.deleteProcessDefinition(long pdId) |
Delete process definition.
|
void |
BaseTask.deleteProject(long projectId) |
Delete task project.
|
void |
BaseMail.deleteRule(long ruleId) |
Delete mail rule.
|
void |
BaseSearch.deleteSearch(int qpId) |
Delete search.
|
void |
BaseTask.deleteStatus(long statusId) |
Delete status.
|
void |
BaseTask.deleteType(long typeId) |
Delete type.
|
void |
BaseNode.deleteVersion(String uuid,
String versionName) |
Delete version.
|
void |
BaseWorkflow.endTaskInstance(long tiId,
String transName) |
End task instance.
|
InputStream |
BaseNode.exportZip(List<String> uuids,
boolean withPath,
boolean background) |
Export zip input stream.
|
Document |
BaseDocument.extendedCopy(String uuid,
String dstId,
String newName,
boolean categories,
boolean keywords,
boolean propertyGroups,
boolean notes,
boolean security) |
Copy a document to another location in the repository.
|
Folder |
BaseFolder.extendedCopy(String uuid,
String dstId,
String newName,
boolean categories,
boolean keywords,
boolean propertyGroups,
boolean notes,
boolean security) |
Extended folder copy folder.
|
Mail |
BaseMail.extendedCopy(String uuid,
String dstId,
boolean categories,
boolean keywords,
boolean propertyGroups,
boolean notes,
boolean security,
String newName) |
Extended mail copy mail.
|
Record |
BaseRecord.extendedCopy(String uuid,
String dstId,
String newName,
boolean categories,
boolean keywords,
boolean propertyGroups,
boolean notes,
boolean security) |
Extended record copy record.
|
Document |
BasePdf.extract(String uuid,
String dstId,
String name,
List<Integer> pages) |
Extract pages from a document.
|
List<QueryResult> |
BaseSearch.find(QueryParams queryParams,
String propertiesPlugin) |
Find list.
|
List<QueryResult> |
BaseSearch.find(QueryParams queryParams,
String sortField,
boolean sortReverse,
String propertiesPlugin) |
Find list.
|
ActivityList |
BaseActivity.findActivityLog(int page,
int length,
Calendar beginDate,
Calendar endDate,
String user,
String action,
String item) |
Returns a list of all activity log by date, user, action and item.
|
List<QueryParams> |
BaseSearch.findAllDefaultByNodeClass(long ncId) |
Find all default by node class list.
|
List<ProcessDefinition> |
BaseWorkflow.findAllProcessDefinitions() |
Find all process definitions list.
|
List<QueryResult> |
BaseSearch.findByQuery(String query,
String propertiesPlugin) |
Find by query list.
|
List<QueryResult> |
BaseSearch.findByQuery(String query,
String sortField,
boolean sortReverse,
String propertiesPlugin) |
Find by query list.
|
ProcessDefinition |
BaseWorkflow.findLastProcessDefinition(String name) |
Find last process definition process definition.
|
List<ProcessDefinition> |
BaseWorkflow.findLatestProcessDefinitions() |
Find latest process definitions list.
|
TaskInstanceResultSet |
BaseWorkflow.findPooledTaskInstances(int offset,
int limit) |
Find pooled task instances task instance result set.
|
List<ProcessInstance> |
BaseWorkflow.findProcessInstances(long pdId) |
Find process instances list.
|
List<ProcessInstance> |
BaseWorkflow.findProcessInstancesByNode(String uuid) |
Find process instances list by node
|
SimpleNodeBaseResultSet |
BaseSearch.findSimpleNodeBaseByQueryPaginated(String query,
int offset,
int limit) |
Find simple node base by query paginated simple node base result set.
|
SimpleNodeBaseResultSet |
BaseSearch.findSimpleNodeBaseByQueryPaginated(String query,
String sortField,
boolean sortReverse,
int offset,
int limit) |
Find simple node base by query paginated simple node base result set.
|
SimpleNodeBaseResultSet |
BaseSearch.findSimpleNodeBasePaginated(QueryParams queryParams,
int offset,
int limit) |
Find simple node base paginated simple node base result set.
|
SimpleNodeBaseResultSet |
BaseSearch.findSimpleNodeBasePaginated(QueryParams queryParams,
String sortField,
boolean sortReverse,
int offset,
int limit) |
Find simple node base paginated simple node base result set.
|
SimpleNodeBaseResultSet |
BaseSearch.findSimpleNodeBasePaginated(QueryParams queryParams,
String sortField,
boolean sortReverse,
int offset,
int limit,
String pluginName) |
Find simple node base paginated simple node base result set.
|
List<TaskInstance> |
BaseWorkflow.findTaskInstances(long piId) |
Find task instances list.
|
List<DashboardNodeResult> |
BaseDashboard.findUserSearches(long ncId) |
Find user searches list.
|
TaskInstanceResultSet |
BaseWorkflow.findUserTaskInstances(int offset,
int limit) |
Find user task instances task instance result set.
|
List<QueryResult> |
BaseSearch.findWithMetadata(QueryParams params,
String sortField,
boolean sortReverse,
String propertiesPlugin,
List<String> groups) |
Find with metadata list.
|
List<QueryResult> |
BaseSearch.findWithMetadata(QueryParams params,
String propertiesPlugin,
List<String> groups) |
Find with metadata list.
|
ResultSet |
BaseSearch.findWithMetadataPaginated(QueryParams queryParams,
int offset,
int limit,
String propertiesPlugin,
List<String> groups) |
Find with metadata paginated result set.
|
ResultSet |
BaseSearch.findWithMetadataPaginated(QueryParams queryParams,
String sortField,
boolean sortReverse,
int offset,
int limit,
String propertiesPlugin,
List<String> groups) |
Find with metadata paginated result set.
|
void |
BaseDocument.forceCancelCheckout(String uuid) |
Force to cancel a previous checked out state in a document.
|
LockInfo |
BaseNode.forceLock(String uuid) |
Force lock node lock info.
|
void |
BaseNode.forceUnlock(String uuid) |
Force unlock node.
|
void |
BaseMail.forwardEmail(String uuid,
List<String> users,
List<String> roles,
List<String> mails,
String message) |
Forward email.
|
String |
BaseNode.generateDownloadToken(String uuid,
boolean preview,
boolean oneTimeUse,
Calendar validUntil) |
Generate download token string.
|
Note |
BaseNote.get(String nodeId) |
Get note from node
|
List<MailAccount> |
BaseMail.getAccounts() |
Gets mail accounts.
|
TaskList |
BaseTask.getActive(long projectId,
long typeId,
long statusId,
String orderColumn,
boolean orderAsc,
int offset,
int limit,
String subject) |
Gets active tasks.
|
TaskList |
BaseTask.getActive(long projectId,
long typeId,
long statusId,
String orderColumn,
boolean orderAsc,
int offset,
int limit,
Calendar from,
Calendar to,
String subject) |
Gets active tasks.
|
long |
BaseTask.getActiveCount(long statusId,
long projectId,
long typeId) |
Gets active tasks count.
|
List<String> |
BaseActivity.getActivityActions() |
Returns a list of all the activity log actions.
|
List<PropertyGroup> |
BasePropertyGroup.getAllGroups() |
Gets all property groups.
|
List<PropertyGroup> |
BasePropertyGroup.getAllGroups(String uuid) |
Gets all property groups.
|
List<QueryParams> |
BaseSearch.getAllSearches() |
Gets all searches.
|
List<StampItem> |
BaseStamp.getAllStamps() |
Gets all stamps.
|
AppVersion |
BaseRepository.getAppVersion() |
Gets app version.
|
TaskList |
BaseTask.getAssigned(long projectId,
long typeId,
long statusId,
String orderColumn,
boolean orderAsc,
int offset,
int limit,
String subject) |
Gets assigned tasks.
|
TaskList |
BaseTask.getAssigned(long projectId,
long typeId,
long statusId,
String orderColumn,
boolean orderAsc,
int offset,
int limit,
Calendar from,
Calendar to,
String subject) |
Gets assigned tasks.
|
long |
BaseTask.getAssignedCount(long statusId,
long projectId,
long typeId) |
Gets assigned tasks count.
|
List<Document> |
BaseMail.getAttachments(String uuid) |
Gets attachments.
|
Map<String,String> |
BaseRepository.getAvailableLocales(String locale) |
Gets available locales.
|
List<BreadCrumbItem> |
BaseNode.getBreadcrumb(String uuid) |
Gets breadcrumb.
|
Folder |
BaseRepository.getCategoriesFolder() |
Gets categories folder.
|
List<Document> |
BaseSearch.getCategorizedDocuments(String categoryId) |
Gets categorized documents.
|
List<Document> |
BaseDocument.getCheckedOut() |
Get checked out documents
|
List<Document> |
BaseDocument.getChildren(String uuid) |
Gets children.
|
List<Folder> |
BaseFolder.getChildren(String uuid) |
Gets children.
|
List<Mail> |
BaseMail.getChildren(String uuid) |
Gets mail children.
|
List<Record> |
BaseRecord.getChildren(String uuid) |
Gets record children.
|
SimpleNodeBaseList |
BaseNode.getChildrenNodesByCategoryPaginated(String uuid,
int offset,
int limit,
String filter,
String orderByField,
boolean orderAsc,
List<Integer> filteredTypes) |
Gets children nodes by category paginated.
|
SimpleNodeBaseList |
BaseNode.getChildrenNodesByCategoryPaginated(String uuid,
int offset,
int limit,
String filter,
String orderByField,
boolean orderAsc,
List<Integer> filteredTypes,
String pluginName) |
Gets children nodes by category paginated.
|
SimpleNodeBaseList |
BaseNode.getChildrenNodesPaginated(String uuid,
int offset,
int limit,
String filter,
String orderByField,
boolean orderAsc,
List<Integer> filteredTypes) |
Gets children nodes paginated.
|
SimpleNodeBaseList |
BaseNode.getChildrenNodesPaginated(String uuid,
int offset,
int limit,
String filter,
String orderByField,
boolean orderAsc,
List<Integer> filteredTypes,
String pluginName) |
Gets children nodes paginated.
|
String |
BaseRepository.getClusterUuid() |
Gets cluster uuid.
|
UserConfig |
BaseUserConfig.getConfig() |
Gets config.
|
InputStream |
BaseDocument.getContent(String uuid) |
Obtain document content from the repository.
|
InputStream |
BaseMail.getContent(String uuid) |
Gets mail content.
|
InputStream |
BaseDocument.getContentByVersion(String uuid,
String versionName) |
Obtain document content from the repository.
|
ContentInfo |
BaseFolder.getContentInfo(String uuid) |
Gets content info.
|
List<String> |
BaseDocument.getDetectedLanguages() |
Retrieve a list of language.
|
InputStream |
BaseDocument.getDifferences(String uuid,
String versionName1,
String versionName2) |
Get differences between two document versions.
|
Record |
BaseNode.getElectronicRecordInPath(String uuid) |
Gets electronic record in path.
|
String |
BaseDocument.getExtractedText(String uuid) |
Obtain the document extracted text.
|
String |
BaseMail.getExtractedText(String uuid) |
Obtain the mail extracted text.
|
List<MailFilterRule> |
BaseMail.getFilterRules(long filterId) |
Gets mail filter rules.
|
TaskList |
BaseTask.getFinished(long projectId,
long typeId,
long statusId,
String orderColumn,
boolean orderAsc,
int offset,
int limit,
String subject) |
Gets finished tasks.
|
TaskList |
BaseTask.getFinished(long projectId,
long typeId,
long statusId,
String orderColumn,
boolean orderAsc,
int offset,
int limit,
Calendar from,
Calendar to,
String subject) |
Gets finished tasks.
|
long |
BaseTask.getFinishedCount(long statusId,
long projectId,
long typeId) |
Gets finished tasks count.
|
Map<String,Integer> |
BaseAuth.getGrantedRoles(String uuid) |
Get roles permissions from am item (document or folder).
|
Map<String,Integer> |
BaseAuth.getGrantedUsers(String uuid) |
Get user permissions from am item (document or folder).
|
GrantedUsersAndRolesItem |
BaseAuth.getGrantedUsersAndRoles(String uuid) |
Get granted users and roles
|
PropertyGroup |
BasePropertyGroup.getGroup(String grpName) |
Gets group.
|
RelationGroup |
BaseRelation.getGroup(long groupId) |
Get group.
|
List<PropertyGroup> |
BasePropertyGroup.getGroups(String uuid) |
Gets groups.
|
List<PropertyGroup> |
BasePropertyGroup.getGroupsByVersion(String uuid,
String versionName) |
Gets groups by version.
|
InputStream |
BasePdf.getImage(String uuid,
int page,
String size) |
Gets image.
|
LicenseInfo |
BaseRepository.getLicenseInfo() |
Gets license info.
|
LockInfo |
BaseNode.getLockInfo(String uuid) |
Gets lock info.
|
Folder |
BaseRepository.getMailFolder() |
Gets mail folder.
|
Folder |
BaseRepository.getMailFolderBase() |
Gets mail folder base.
|
MailServerMessages |
BaseMail.getMailMessages(long accountId,
long start) |
Gets mail messages.
|
SimpleNodeBaseResultSet |
BaseMail.getMailsPaginated(String context,
int offset,
int limit,
MailFilterQuery filter,
String orderColumn,
boolean orderAsc) |
Gets mails paginated.
|
Node |
BaseNode.getNodeByUuid(String uuid) |
Gets node by uuid.
|
String |
BaseRepository.getNodePath(String uuid) |
Gets node path.
|
String |
BaseRepository.getNodeUuid(String nodePath) |
Gets node uuid.
|
List<NoteHistory> |
BaseNote.getNoteHistories(String uuid) |
Retrieve a list of notes history from a node
|
List<TaskNote> |
BaseTask.getNotes(long taskId) |
Gets notes.
|
TaskList |
BaseTask.getNotified(long projectId,
long typeId,
long statusId,
String orderColumn,
boolean orderAsc,
int offset,
int limit,
String subject) |
Gets notified tasks.
|
TaskList |
BaseTask.getNotified(long projectId,
long typeId,
long statusId,
String orderColumn,
boolean orderAsc,
int offset,
int limit,
Calendar from,
Calendar to,
String subject) |
Gets notified tasks.
|
long |
BaseTask.getNotifiedCount(long statusId,
long projectId,
long typeId) |
Gets notified tasks count.
|
int |
BaseDocument.getNumberOfPages(String uuid) |
Get the number of pages of a document.
|
String |
BaseDocument.getPageAsImage(String uuid,
int pageNumber,
int maxWidth,
int maxHeight) |
Get page as image.
|
String |
BaseDocument.getPath(String uuid) |
Get the document path from a UUID
|
String |
BaseFolder.getPath(String uuid) |
Gets path.
|
String |
BaseMail.getPath(String uuid) |
Gets mail path.
|
String |
BaseRecord.getPath(String uuid) |
Gets record path.
|
InputStream |
BaseDocument.getPdf(String uuid) |
PDF of the document.
|
InputStream |
BaseMail.getPdf(String uuid) |
Gets pdf.
|
Folder |
BaseRepository.getPersonalFolder() |
Gets personal folder.
|
Folder |
BaseRepository.getPersonalFolderBase() |
Gets personal folder base.
|
StampPersonalImage |
BaseStamp.getPersonalStampImage(String uuid,
String imageUuid,
long id) |
Gets personal stamp image.
|
List<Document> |
BaseStamp.getPersonalStamps() |
Gets personal stamps.
|
ProcessDefinition |
BaseWorkflow.getProcessDefinition(long pdId) |
Gets process definition.
|
Map<String,List<FormElement>> |
BaseWorkflow.getProcessDefinitionForms(long pdId) |
Gets process definition forms.
|
String |
BaseWorkflow.getProcessDefinitionImage(long pdId,
String uuid) |
Gets process definition image.
|
ProcessInstance |
BaseWorkflow.getProcessInstance(long piId) |
Gets process instance.
|
TaskProject |
BaseTask.getProject(long projectId) |
Gets task project.
|
List<TaskProject> |
BaseTask.getProjects(boolean filterActive) |
Gets projects.
|
Document |
BaseDocument.getProperties(String uuid) |
Obtain document properties from the repository.
|
Folder |
BaseFolder.getProperties(String uuid) |
Gets properties.
|
Mail |
BaseMail.getProperties(String uuid) |
Gets mail properties.
|
Map<String,String> |
BasePropertyGroup.getProperties(String uuid,
String grpName) |
Gets properties.
|
Record |
BaseRecord.getProperties(String uuid) |
Gets record properties.
|
Map<String,String> |
BasePropertyGroup.getPropertiesByVersion(String uuid,
String grpName,
String versionName) |
Gets properties by version.
|
List<FormElement> |
BasePropertyGroup.getPropertiesByVersionForm(String uuid,
String grpName,
String versionName) |
Gets properties by version form.
|
List<FormElement> |
BasePropertyGroup.getPropertyGroupForm(String uuid,
String grpName) |
Gets property group form.
|
List<FormElement> |
BasePropertyGroup.getPropertyGroupFormDefinition(String grpName) |
Gets property group form.
|
List<FormElement> |
BasePropertyGroup.getPropertyGroupFormDefinition(String uuid,
String grpName) |
Gets property group form.
|
TaskList |
BaseTask.getRelatedTasks(String uuid) |
Gets related tasks.
|
String |
BaseRepository.getRepositoryUuid() |
Gets repository uuid.
|
List<String> |
BaseAuth.getRoles(boolean showAll) |
Retrieves a list of repository roles.
|
List<String> |
BaseAuth.getRolesByUser(String userId) |
Retrieves a list of roles by user.
|
Folder |
BaseRepository.getRootFolder() |
Gets root folder.
|
QueryParams |
BaseSearch.getSearch(int qpId) |
Gets search.
|
List<Shard> |
BaseShard.getShards() |
Gets shards.
|
StampBarcode |
BaseStamp.getStampBarcodeByPk(long id,
String uuid) |
Gets stamp barcode by pk.
|
StampImage |
BaseStamp.getStampImageByPk(long id,
String uuid) |
Gets stamp image by pk.
|
StampText |
BaseStamp.getStampTextByPk(long id,
String uuid) |
Gets stamp text by pk.
|
List<TaskStatus> |
BaseTask.getStatus() |
Gets status.
|
TaskStatus |
BaseTask.getStatus(long statusId) |
Gets status.
|
Task |
BaseTask.getTask(long taskId) |
Gets task.
|
TaskInstance |
BaseWorkflow.getTaskInstance(long tiId) |
Gets task instance.
|
Folder |
BaseRepository.getTemplatesFolder() |
Gets templates folder.
|
InputStream |
BaseDocument.getThumbnail(String uuid,
ThumbnailType type) |
Returns thumbnail image data.
|
InputStream |
BaseMail.getThumbnail(String uuid,
ThumbnailType type) |
Gets mail thumbnail.
|
Folder |
BaseRepository.getTrashFolder() |
Gets trash folder.
|
Folder |
BaseRepository.getTrashFolderBase() |
Gets trash folder base.
|
TaskType |
BaseTask.getType(long typeId) |
Gets type.
|
List<TaskType> |
BaseTask.getTypes(boolean filterActive) |
Gets types.
|
String |
BaseRepository.getUpdateMessage() |
Gets update message.
|
CommonUser |
BaseAuth.getUser(String userId) |
Retrieve information of a given user
|
List<Bookmark> |
BaseBookmark.getUserBookmarks() |
Retrive an user bookmark collection.
|
DashboardResultSet |
BaseDashboard.getUserCheckedOutDocuments(int offset,
int limit) |
Gets user checked out documents.
|
DashboardResultSet |
BaseDashboard.getUserLastCreatedDocuments(int offset,
int limit) |
Gets user last created documents.
|
DashboardResultSet |
BaseDashboard.getUserLastCreatedFolders(int offset,
int limit) |
Gets user last created folders.
|
DashboardResultSet |
BaseDashboard.getUserLastCreatedRecords(int offset,
int limit) |
Gets user last created records.
|
DashboardResultSet |
BaseDashboard.getUserLastDocumentsNotesCreated(int offset,
int limit) |
Gets user last documents notes created.
|
DashboardResultSet |
BaseDashboard.getUserLastDownloadedDocuments(int offset,
int limit) |
Gets user last downloaded documents.
|
DashboardResultSet |
BaseDashboard.getUserLastFoldersNotesCreated(int offset,
int limit) |
Gets user last folders notes created.
|
DashboardResultSet |
BaseDashboard.getUserLastImportedMailAttachments(int offset,
int limit) |
Gets user last imported mail attachments.
|
DashboardResultSet |
BaseDashboard.getUserLastImportedMails(int offset,
int limit) |
Gets user last imported mails.
|
DashboardResultSet |
BaseDashboard.getUserLastMailsNotesCreated(int offset,
int limit) |
Gets user last mails notes created.
|
DashboardResultSet |
BaseDashboard.getUserLastModifiedDocuments(int offset,
int limit) |
Gets user last modified documents.
|
DashboardResultSet |
BaseDashboard.getUserLastRecordsNotesCreated(int offset,
int limit) |
Gets user last records notes created.
|
DashboardResultSet |
BaseDashboard.getUserLockedDocuments(int offset,
int limit) |
Gets user locked documents.
|
DashboardResultSet |
BaseDashboard.getUserLockedFolders(int offset,
int limit) |
Gets user locked folders.
|
DashboardResultSet |
BaseDashboard.getUserLockedMails(int offset,
int limit) |
Gets user locked mails.
|
DashboardResultSet |
BaseDashboard.getUserLockedRecords(int offset,
int limit) |
Gets user locked records.
|
List<CommonUser> |
BaseAuth.getUsers(boolean showAll) |
Retrieve information of a given user
|
List<CommonUser> |
BaseAuth.getUsersByRole(String roleId) |
Retrieves a list of users by role.
|
DashboardResultSet |
BaseDashboard.getUserSubscribedDocuments(int offset,
int limit) |
Gets user subscribed documents.
|
DashboardResultSet |
BaseDashboard.getUserSubscribedFolders(int offset,
int limit) |
Gets user subscribed folders.
|
DashboardResultSet |
BaseDashboard.getUserSubscribedRecords(int offset,
int limit) |
Gets user subscribed records.
|
List<Tenant> |
BaseAuth.getUserTenants() |
Get a list of available tenants for a user.
|
List<Version> |
BaseNode.getVersionHistory(String uuid) |
Gets version history.
|
long |
BaseDocument.getVersionHistorySize(String uuid) |
Get the versions size of a Document.
|
List<XRef> |
BaseDocument.getXrefs(String uuid) |
Returns a list of the document references of a Autocad document
|
void |
BaseAuth.grantRole(String uuid,
String roleId,
int permissions,
boolean recursive) |
Grant role permissions for a node.
|
void |
BaseAuth.grantUser(String uuid,
String userId,
int permissions,
boolean recursive) |
Add user permissions to a node.
|
boolean |
BasePropertyGroup.hasGroup(String uuid,
String grpName) |
Has group boolean.
|
boolean |
BaseRepository.hasNode(String nodeId) |
Has node boolean.
|
Mail |
BaseMail.importEml(String uuid,
String title,
InputStream is) |
Import eml mail.
|
void |
BaseMail.importMessages(long mailAccountId,
List<Long> messageIds) |
Import mail messages.
|
Mail |
BaseMail.importMsg(String uuid,
String title,
InputStream is) |
Import msg mail.
|
void |
BaseNode.importZip(String uuid,
InputStream is) |
Import zip.
|
Document |
BasePdf.insertPages(String uuid,
InsertPagesRequest request) |
Insert pages boolean.
|
boolean |
BaseDocument.isAttachment(String uuid) |
Indicates if the node is a mail attachment or not.
|
boolean |
BaseDocument.isCheckedOut(String uuid) |
Test if a node has been already checked out.
|
boolean |
BaseDocument.isConvertibleToPDF(String uuid) |
Is convertible to pdf
|
boolean |
BaseNode.isLocked(String uuid) |
Is locked boolean.
|
boolean |
BaseDocument.isOCRDataCaptureSupported(String uuid) |
Check if the node supports an OCR data capture.
|
boolean |
BaseDocument.isValid(String uuid) |
Test if a document path exists and is readable.
|
boolean |
BaseFolder.isValid(String uuid) |
Is valid folder boolean.
|
boolean |
BaseMail.isValid(String uuid) |
Is valid mail boolean.
|
boolean |
BaseRecord.isValid(String uuid) |
Is valid record boolean.
|
List<Note> |
BaseNote.list(String uuid) |
Retrieve a list of notes from a node.
|
void |
BaseDocument.liveEditCancelCheckout(String uuid) |
Live edit cancel checkout.
|
void |
BaseDocument.liveEditCheckin(String uuid,
String comment,
int increment) |
It does a live edit checkin.
|
void |
BaseDocument.liveEditForceCancelCheckout(String uuid) |
Live edit force cancel checkout.
|
void |
BaseDocument.liveEditSetContent(String uuid,
InputStream is) |
Update the content of the document edited with live edit feature.
|
LockInfo |
BaseNode.lock(String uuid) |
Lock node lock info.
|
String |
BaseDocument.mergePdf(String dstId,
String docName,
List<String> uuids) |
Merge PDF documents.
|
void |
BaseDocument.move(String uuid,
String dstId) |
Move a document to another location in the repository.
|
void |
BaseFolder.move(String uuid,
String dstId) |
Move folder.
|
void |
BaseMail.move(String uuid,
String dstId) |
Move mail.
|
void |
BaseRecord.move(String uuid,
String dstId) |
Move record.
|
void |
BaseNotification.notify(List<String> uuids,
List<String> users,
List<String> roles,
List<String> mails,
String message,
boolean attachment) |
Notify.
|
boolean |
BasePdf.optimize(String uuid) |
|
void |
BaseAuth.overwriteSecurity(String uuid,
ChangeSecurity changeSecurity) |
Change several security permissions in the same call.
|
void |
BaseDocument.purge(String uuid) |
Deletes definitively a document from the repository.
|
void |
BaseFolder.purge(String uuid) |
Purge folder.
|
void |
BaseMail.purge(String uuid) |
Purge mail.
|
void |
BaseRecord.purge(String uuid) |
Purge record.
|
void |
BaseRepository.purgeTrash() |
Purge trash.
|
void |
BaseNode.purgeVersionHistory(String uuid) |
Purge version history.
|
OCRRecognise |
BaseDocument.recognize(String uuid) |
Recognize
|
void |
BaseDocument.refresh(String uuid) |
Refresh references of an Autocad document
|
void |
BaseWorkflow.registerProcessDefinition(InputStream is) |
Register process definition.
|
Document |
BasePdf.remove(String uuid,
String dstId,
String name,
List<Integer> pages) |
Remove pages of a document
|
void |
BaseProperty.removeCategory(String uuid,
String catId) |
Remove category.
|
void |
BasePropertyGroup.removeGroup(String uuid,
String grpName) |
Remove group.
|
void |
BaseProperty.removeKeyword(String uuid,
String keyword) |
Remove keyword.
|
void |
BaseBookmark.rename(long bookmarkId,
String name) |
Rename a previous stored bookmark.
|
Document |
BaseDocument.rename(String uuid,
String newName) |
Rename a document in the repository.
|
Folder |
BaseFolder.rename(String uuid,
String newName) |
Rename folder.
|
void |
BaseMail.rename(String uuid,
String newName) |
Rename mail.
|
Record |
BaseRecord.rename(String uuid,
String newName) |
Rename record.
|
void |
BaseNode.renameVersion(String uuid,
String versionName,
String newName) |
Rename version.
|
Node |
BaseNode.restore(String uuid) |
Restore node.
|
void |
BaseNode.restoreVersion(String uuid,
String versionName) |
Restore version.
|
void |
BaseAuth.revokeRole(String uuid,
String roleId,
int permissions,
boolean recursive) |
Revoke role permissions from a node.
|
void |
BaseAuth.revokeUser(String uuid,
String userId,
int permissions,
boolean recursive) |
Revoke user permissions from a node.
|
Document |
BasePdf.rotate(String uuid,
String dstId,
String name,
Integer angle,
List<Integer> pages) |
Rotate pages of a document.
|
ProcessInstance |
BaseWorkflow.runProcessDefinition(long pdId,
String uuid,
Map<String,String> propertiesMap) |
Run process definition process instance.
|
Document |
BaseDocument.saveAsPdf(String uuid,
String newName,
boolean propertyGroups,
boolean security) |
Save the document as PDF in the OpenKM repository.
|
Document |
BaseMail.saveAsPdf(String uuid,
String newName,
boolean propertyGroups,
boolean security) |
Save mail as pdf document.
|
long |
BaseSearch.saveSearch(QueryParams params) |
Save search long.
|
ProcessInstanceResultSet |
BaseWorkflow.searchAssignedTasks(Calendar start,
Calendar end,
String status,
Long procDefId,
int offset,
int limit) |
Search assigned tasks.
|
ProcessInstanceResultSet |
BaseWorkflow.searchOverview(Calendar start,
Calendar end,
String status,
Long procDefId,
String initiator,
String taskUser,
int offset,
int limit) |
Search overview.
|
ProcessInstanceResultSet |
BaseWorkflow.searchStartedByMe(Calendar start,
Calendar end,
String status,
Long procDefId,
int offset,
int limit) |
Search started by me.
|
Mail |
BaseMail.sendMailWithAttachments(String from,
List<String> to,
List<String> cc,
List<String> bcc,
List<String> replyTo,
String subject,
String body,
List<String> docsId,
String uuid) |
Send mail with attachments mail.
|
void |
BaseNote.set(String noteId,
String text) |
Set a new text to node note.
|
void |
BaseShard.setCurrentShard(long shardId) |
Sets current shard.
|
void |
BaseDocument.setDescription(String uuid,
String description) |
Set document description.
|
void |
BaseMail.setDescription(String uuid,
String description) |
Sets mail description.
|
void |
BaseRecord.setDescription(String uuid,
String description) |
Sets record description.
|
void |
BaseProperty.setEncryption(String uuid,
String cipherName) |
Sets encryption.
|
void |
BaseUserConfig.setHome(String uuid) |
Sets home.
|
void |
BaseDocument.setIndexable(String uuid,
boolean enabled) |
Sets indexable.
|
void |
BaseDocument.setLanguage(String uuid,
String lang) |
Set document language.
|
void |
BaseDocument.setNodeClass(String uuid,
long nodeClass) |
Set document node class
|
void |
BaseMail.setNodeClass(String uuid,
long nodeClass) |
Sets mail node class.
|
void |
BaseRecord.setNodeClass(String uuid,
long nodeClass) |
Sets record node class.
|
void |
BaseDocument.setProperties(String uuid,
String title,
String description,
String lang,
List<String> keywords,
List<String> categories) |
Set document properties in the repository.
|
void |
BasePropertyGroup.setProperties(String uuid,
String grpName,
Map<String,String> properties) |
Sets properties.
|
void |
BaseAuth.setRolePermissions(String uuid,
String roleId,
int permissions,
boolean recursive) |
Set role permissions for a node.
|
void |
BaseProperty.setSigned(String uuid,
boolean signed) |
Sets signed.
|
void |
BaseWorkflow.setTaskInstanceActorId(long tiId,
String actorId) |
Sets task instance actor id.
|
void |
BaseWorkflow.setTaskInstanceValues(long pdId,
long tiId,
String tiName,
String transName,
Map<String,String> properties) |
Sets task instance values.
|
void |
BaseDocument.setTitle(String uuid,
String title) |
Set document title.
|
void |
BaseMail.setTitle(String uuid,
String title) |
Sets mail title.
|
void |
BaseRecord.setTitle(String uuid,
String title) |
Sets record title.
|
void |
BaseAuth.setUserPermissions(String uuid,
String userId,
int permissions,
boolean recursive) |
Set user permissions to a node
|
void |
BaseAuth.setUserTenant(long tenantId) |
Update user tenant.
|
List<Document> |
BasePdf.split(String uuid,
String dstId,
String baseName,
List<Integer> pages) |
Split document.
|
void |
BaseDocument.stamp(String uuid,
int type,
long stampId) |
Stamp.
|
void |
BaseStamp.stampBarcode(String uuid,
long id) |
Stamp barcode.
|
void |
BaseStamp.stampImage(String uuid,
long id) |
Stamp image.
|
void |
BaseStamp.stampImageCustom(String uuid,
long stampImageId,
String exprX,
String exprY,
String range,
double ratio,
InputStream is) |
Stamp image custom.
|
void |
BaseStamp.stampImageManually(String uuid,
long id,
String exprX,
String exprY,
String range,
String personalStampUuid) |
Stamp image manually.
|
void |
BaseStamp.stampText(String uuid,
long id) |
Stamp text.
|
void |
BaseStamp.stampTextCustom(String uuid,
long stampTextId,
String text,
String exprX,
String exprY,
String range) |
Stamp text custom.
|
void |
BaseWorkflow.startTaskInstance(long tiId) |
Start task instance.
|
void |
BaseNode.subscribe(String uuid) |
Subscribe.
|
void |
BaseMail.testAccount(MailAccount mailAccount) |
Test mail account.
|
void |
BaseNode.unlock(String uuid) |
Unlock node.
|
void |
BaseProperty.unsetEncryption(String uuid) |
Unset encryption.
|
void |
BaseNode.unsubscribe(String uuid) |
Unsubscribe.
|
void |
BaseNode.unZip(String uuid,
String dstId) |
Un zip.
|
Task |
BaseTask.update(long taskId,
String subject,
String start,
String end,
String description,
long statusId,
long projectId,
long typeId,
String user,
List<String> notificationUsers,
List<String> externalUsers,
List<String> relatedDocuments,
List<String> relatedFolders,
List<String> relatedRecords,
List<String> relatedMails,
String owner,
String repeatExpression,
String repeatUntil,
String formatDate,
int repeatTimes,
int progress,
String reminderStartUnit,
int reminderStartValue,
String reminderEndUnit,
int reminderEndValue) |
Update task task.
|
void |
BaseMail.updateAccount(MailAccount mailAccount) |
Update mail account.
|
void |
BaseAutomation.updateAction(long ruleId,
long actionId,
int order,
boolean active,
String param00,
String param01,
String param02) |
|
void |
BaseMail.updateFilter(MailFilter mailFilter) |
Update mail filter.
|
void |
BaseDocument.updateFromTemplate(String uuid,
String dstId,
Map<String,String> properties) |
Update from template
|
TaskNote |
BaseTask.updateNote(long noteId,
String text) |
Update note.
|
TaskProject |
BaseTask.updateProject(long projectId,
boolean active,
String name,
String description) |
Update project.
|
void |
BaseMail.updateRule(MailFilterRule rule) |
Update mail rule.
|
void |
BaseSearch.updateSearch(QueryParams params) |
Update search.
|
TaskStatus |
BaseTask.updateStatus(long statusId,
String name,
boolean finish) |
Update status.
|
TaskType |
BaseTask.updateType(long typeId,
boolean active,
String name,
String description) |
Update type.
|
void |
BaseAutomation.updateValidation(long ruleId,
long validationId,
boolean negate,
int order,
boolean active,
String param00,
String param01,
String param02) |
|