1. Home
  2. SDK for Java
  3. Changelog v4.x
  1.  

SDK for Java
Changelog v5.x
Changelog v4.x
Changelog v3.x
Changelog v2.x
Changelog v1.x
Migration

SDK for Java v4.x

v4.15

  • Updated:
    • InsertPages in PdfService has been redesigned in order to be more useful and understandable. It now uses PageInsertOperations to perform the inserts

v4.14

  • 2025-07-08
  • PDFService
    • List<Document> split(String uuid, String dstId, String baseName, List<Integer> pages) now returns a list of documents
    • Document remove(String uuid, String dstId, String name, List<Integer> pages) now returns a document
    • Document rotate(String uuid, String dstId, String name, Integer angle, List<Integer> pages) now returns a document

v4.13

  • 2025-05-29
  • Fixed:
    • Corrected mapping issues in the FormElementComplex component
    • Resolved variable handling in the Select and FormElementComplex classes
  • Updated:
    • Enhanced the ProfileMisc class with new aiVisible and identityVisible variables for improved visibility control
    • Added multiple attribute support for Upload fields in workflow forms

v4.12

  • 2025-04-09
  • AuthService
    • Removed method
      • boolean hasSecurityRecursive()
      • boolean hasTaskManagerAdmin()
      • boolean isAdmin()
      • boolean isPasswordExpired()
  • RepositoryService
    • Removed method
      • boolean getIsFilePlan();
  • SearchService
    • Removed method
      • List<MimeType> getMimeTypes()
      • SearchPluginList getSearchPlugins()
  • DocumentService
    • Removed method
      • List<String> getLiveEditRestrictedMimeTypes()
  • NodeService
    • Removed method
      • NodePaginatorConfig getPaginatorConfig(String pluginName)
      • PaginatorPluginList getPaginatorPlugins()
  • Fixed: the PrincipalAdapterException is now named AuthException

v4.11

  • 2025-02-14
  • Changes in the NodePaginatorConfig class.
  • New variable shard in the Document class.
  • New variable shard in the Mail class.
  • New variable shardVisible in the ProfileDocProperties class.
  • New variable shardVisible in the ProfileMailProperties class.
  • ReportService
    • Added method
      • InputStream executeSql(long rpId)
      • Document saveSql(long rpId, Map<String, String> params, String dstId, String docName)
      • List<SqlReport> getSqlReports(boolean active)

v4.10

  • 2024-12-04
  • New variable timeZone in the UserConfig class.
  • New variable onlineEditor in the UserConfig class.
  • New variable htmlEditor in the UserConfig class.
  • New variable liveEdit in the UserConfig class.
  • New variable stepIntoCreatedNode in the UserConfig class.
  • New variable previewMode in the UserConfig class.
  • New variable type in the TextArea class.
  • Deleted variable linkTarget  in the Node class.
  • Deleted variable restricted in the Node class.
  • AuthService
    • Added method
      • String createPersonalAccessToken(String name, Calendar expiration)
  • MailService
    • Added method
      • void sendMail(String to, String subject, String body)
  • Import Service
    • Added method
      • String importDocument(String uuid, Calendar date, String author, File file)
      • String importFolder(String uuid, String name, Calendar date, String author)
      • String importRecord(String uuid, String name, Calendar date, String author)
    • Deprecated methods
      • String importDocument(String uuid, File file)
      • String importFolder(String uuid, String name)
      • String importRecord(String uuid, String name)

v4.9

  • 2024-09-09
  • AuthService
    • Added method
      • String getRefreshToken()
  • MailService
    • Changed the internal implementation
      • The method getMailsPaginated now returns an object of type SimpleNodeBaseResultSet

v4.8

  • 2024-06-12
  • PdfService
    • Added method
      • boolean optimize(String uuid)
  • Fixed an issue with the login method regarding expiration and restrict by IP. It always created a token with the expiration set to 1 and restrict by IP set to false.

v4.7

  • 2024-06-12
  • Warning: The internal change in the functions indicates their parameters are now sent in JSON format. This is a major API change.
  • New variable name in the WizardNode class.
  • New variable path in the WizardNode class.
  • New variable mailSent in the SimpleNodeBase class.
  • The variable styleVisible has been removed from the ProfileFldProperties class.
  • The variable style has been removed from the Folder class.
  • DocumentService
    • Added method
      • void liveEditCancelCheckout(String uuid)
      • void liveEditForceCancelCheckout(String uuid)
    • Changed the internal implementation
      • void forceCancelCheckout(String uuid)
      • void cancelCheckout(String uuid)
      • void setIndexable(String uuid, boolean enabled)
  • SearchService
    • Deleted method
      • ResultSet findPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin)
      • ResultSet findPaginated(QueryParams queryParams, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin)
      • ResultSet findByQueryPaginated(String query, int offset, int limit, String propertiesPlugin)
      • ResultSet findByQueryPaginated(String query, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin)
  • WizardService
    • Added method
      • List<WizardNode> findAllByUser()
      • void cancelPostponedNode(String uuid)
      • void deleteByNode(String uuid)
    • Changed the internal implementation
      • addDigitalSignature(String uuid, int order)
      • addShowWizardCategories(String uuid, int order)
      • addShowWizardKeywords(String uuid, int order)
      • addShowWizardOCRDataCapture(String uuid, int order)
  • FolderService
    • Added method
      • Folder create(String uuid, String name, long nodeClass)
  • ImportService
    • Changed the internal implementation
      • String importFolder(String uuid, String name)
      • String importRecord(String uuid, String name)
  • MailService
    • Changed the internal implementation
      • void deleteAttachment(String uuid, String docId)
  • NodeService
    • Changed the internal implementation
      • void unZip(String uuid, String dstId)
      • String generateDownloadToken(String uuid, boolean preview, boolean oneTimeUse, Calendar validUntil)
  • PropertyService
    • Changed the internal implementation
      • void removeKeyword(String uuid, String keyword)
  • StampService
    • Changed internal implementation
      • void stampImageManually(String uuid, long id, String exprX, String exprY, String range, String personalStampUuid)
      • void stampTextCustom(String uuid, long stampTextId, String text, String exprX, String exprY, String range)

v4.6

  • 2024-04-17
  • Added the variable pooledActors to the ITaskInstance class.
  • Fixed most of the bean classes to ignore missing variables during JSON deserialization.

v4.5

  • 2024-03-07
  • Deleted AutoCadService
  • SearchService
    • Deleted method
      • Map<String, Integer> getKeywordMap(List<String> filter)
  • DocumentService
    • Added method
      • List<XRef> getXrefs(String uuid)
      • void refresh(String uuid)
  • Warning: this is a major update to the REST API that affects most PUT and POST implementations. Users who access the REST API directly without the SDK should check whether they are using one of the methods below:
    • AuthService
      • void revokeRole(String uuid, String roleId, int permissions, boolean recursive)
      • void revokeUser(String uuid, String userId, int permissions, boolean recursive)
      • void grantRole(String uuid, String roleId, int permissions, boolean recursive)
      • void grantUser(String uuid, String userId, int permissions, boolean recursive)
      • void deleteUser(String userId)
      • void updateUser(String userId, String password, String email, String name, boolean active)
      • void updateRole(String roleId, boolean active)
      • void assignRole(String userId, String roleId)
      • void setUserProfile(String userId, long profileId)
      • void setUserPermissions(String uuid, String userId, int permissions, boolean recursive)
      • void setRolePermissions(String uuid, String roleId, int permissions, boolean recursive)
      • void setUserTenant(long tenantId)
      • InputStream getTwoFactorQR(String secret)
      • String validate2FAAndSaveSecret(String secret, int code)
      • String disable2FA()
    • AutomationService
      • void create(String name, String event, String at, int order, String evaluation, boolean exclusive, boolean active, String description,long nodeClass)
      • void update(long ruleId, String name, String event, int order, String evaluation, boolean exclusive, boolean active, String description)
      • void createAction(long ruleId, String className, int order, boolean active, String amParam00, String amParam01, String amParam02)
      • void updateAction(long ruleId, long actionId, int order, boolean active, String amParam00, String amParam01, String amParam02)
      • void createValidation(long ruleId, String className, int order, boolean active, String amParam00, String amParam01, String amParam02)
      • void updateValidation(long ruleId, long validationId, int order, boolean active, String amParam00, String amParam01, String amParam02)
    • BookmarkService
      • void create(String uuid, String name)
      • void rename(int bookmarkId, String name)
    • DocumentService
      • Document rename(String uuid, String newName)
      • void setProperties(String uuid, String title, String description, String lang, List<String> keywords, List<String> categories)
      • void setLanguage(String uuid, String lang)
      • void setTitle(String uuid, String title)
      • void setNodeClass(String uuid, long ncId)
      • void setDispositionStage(String uuid, long stage)
      • Document copy(String uuid, String dstId, String newName)
      • Document extendedCopy(String uuid, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)
      • void setDescription(String uuid, String description)
      • String mergePdf(String destinationUuid, String docName, List<String> uuids)
      • Document saveAsPdf(String uuid, String newName, boolean propertyGroups, boolean security)
      • void liveEditCheckin(String uuid, String comment, int increment)
    • FolderService
      • Folder rename(String uuid, String newName)
      • Folder copy(String uuid, String dstId, String newName)
      • Folder extendedCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)
      • void setStyle(String uuid, long styleId)
      • void createMissingFolders(String fldPath)
      • void setDescription(String uuid, String description)
    • MailService
      • void rename(String uuid, String newName)
      • Mail copy(String uuid, String dstId, String newName)
      • Mail extendedCopy(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security, String newName)
      • void setNodeClass(String uuid, long ncId)
      • void setDispositionStage(String uuid, long stage)
      • void setTitle(String uuid, String title)
      • void setDescription(String uuid, String description)
      • void addAccount(MailAccount mailAccount)
      • void updateAccount(MailAccount mailAccount)
      • void importMessages(long mailAccountId, List<Long> messageIds)
      • void createFilter(long mailAccountId, MailFilter mailFilter)
      • void updateFilter(MailFilter mailFilter)
      • void createRule(long filterId, MailFilterRule rule)
      • void updateRule(MailFilterRule rule)
      • void forwardEmail(String uuid, List<String> users, List<String> roles, List<String> mails, String message)
      • Document saveAsPdf(String uuid, String newName, boolean propertyGroups, boolean security)
    • NodeService
      • void renameVersion(String uuid, String versionName, String newName)
      • void setComment(String uuid, String versionName, String comment)
    • NoteService
      • Note add(String uuid, String text)
      • void set(String noteId, String text)
    • NotificationService
      • void notify(List<String> uuids, List<String> users, List<String> roles, List<String> mails, String message, boolean attachment)
    • OcrService
      • void createField(long templateId, String name, String className, String propertyGroupName, String pattern, int rotation, String custom, String ocr, boolean control, int x1, int y1, int x2, int y2)
      • void updateField(long templateId, long fieldId, String name, String className, String propertyGroupName, String pattern, int rotation, String custom, String ocr, boolean control, int x1, int y1, int x2, int y2)
      • void createControlField(long templateId, String name, String className, String pattern, String value, int rotation, String custom, String ocr, int order, boolean emptyAllowed, int x1, int y1, int x2, int y2)
      • void updateControlField(long templateId, long controlFieldId, String name, String className, String pattern, String value, int rotation, String custom, String ocr, int order, boolean emptyAllowed, int x1, int y1, int x2, int y2)
    • PropertyService
      • void addCategory(String uuid, String catId)
      • void addKeyword(String uuid, String keyword)
      • void setEncryption(String uuid, String cipherName)
      • void setSigned(String uuid, boolean signed)
    • RecordService
      • Record create(String uuid, String name, String title, long nodeClass)
      • Record rename(String uuid, String newName)
      • Record copy(String uuid, String dstId, String newName)
      • void setTitle(String uuid, String title)
      • void setNodeClass(String uuid, long ncId)
      • void setDispositionStage(String uuid, long stage)
      • void setDescription(String uuid, String description)
      • Record extendedCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)
      • WizardNode createWizard(String uuid, String name, String title, long nodeClass)
      • void createMissingRecords(String recPath)
    • RelationService
      • void add(String nodeAId, String nodeBId, long relTypeId)
      • void addGroup(String uuid, String groupName, long type)
      • void addNodeToGroup(String uuid, long groupId)
      • void setGroupName(long groupId, String groupName)
    • RepositoryService
      • void copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes)
    • TaskService
      • Task 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)
      • Task 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)
      • TaskProject createProject(String name, boolean active, String description)
      • TaskProject updateProject(long projectId, boolean active, String name, String description)
      • TaskType createType(String name, boolean active, String description)
      • TaskType updateType(long typeId, boolean active, String name, String description)
      • TaskStatus createStatus(String name, boolean finish)
      • TaskStatus createStatus(String nam
      • New variable roles in the StampImage class.
      • e, boolean finish)
      • TaskStatus updateStatus(long statusId, String name, boolean finish)
      • TaskNote createNote(long taskId, String text)
      • TaskNote updateNote(long noteId, String text)
    • UserConfigService
      • void setHome(String uuid)
    • WizardService
      • void postponeNode(String uuid, Calendar date)
      • void addGroup(String uuid, String group, int order)
      • void removeGroup(String uuid, String group)
      • void addWorkflow(String uuid, String workflow, int order)
      • void removeWorkflow(String uuid, String workflow)
    • WorkflowService
      • void setTaskInstanceActorId(long tiId, String actorId)
      • void endTaskInstance(long tiId, String transName)

v4.4

  • Released 2024-01-23
  • New variable roles in the StampImage class.
  • New variable roles in the StampText class.
  • New variable roles in the StampBarcode class.

v4.3

  • Released 2023-02-12
  • DocumentService
    • New method
      •  createDocumentFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean security, Map<String, String> properties) to create a document from a template.
  • FolderService
    • New method
      •  createFolderFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean propertyGroups, boolean security, Map<String, String>) to create a folder hierarchy from a template.
  • RecordService
    • New method
      • createRecordFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean propertyGroups, boolean security, Map<String, String> properties) to create a record hierarchy from a template.

v4.2

  • Released 2023-11-17
  • New variable publicUrlVisible in the ProfileDocProperties class.
  • New variable publicUrlVisible in the ProfileFldProperties class.
  • New variable publicUrlVisible in the ProfileMailProperties class.
  • New variable publicUrlVisible in the ProfileRecProperties class.
  • Added logs to the Auth class.
  • Automation can now be evaluated with OR or AND logic.
  • PDFService
    • New method
      • insertPages(String uuid, String srcId, int sourceFromPage, int sourceToPage, int insertFromPage) to insert pages in a PDF.

v4.1

  • Released 2023-09-26
  • There are many changes between SDK version 3.x and 4.x; the most important considerations for migration between versions are:
    • Requires Java version 11.
    • All the methods deprecated in the version 3.x have been removed.
    • Many methods have been refactored; for example, the method ws.folder.deleteFolder has been renamed to ws.folder.delete.
    • Deprecated method ws.document.lockDocument in favour of ws.node.lock.
    • Deprecated method ws.document.unlockDocument in favour of ws.node.unlock.
    • Deprecated method ws.document.forceUnlockDocument in favour of ws.node.forceUnlockDocument.
    • Deprecated method ws.document.isLocked in favour of ws.node.isLocked.
    • Deprecated method ws.document.getLockInfo in favour of ws.node.getLockInfo.
    • Deprecated method ws.document.forceLock in favour of ws.node.forceLock.
    • Deprecated method ws.record.lockRecord in favour of ws.node.lock.
    • Deprecated method ws.record.unlockRecord in favour of ws.node.unlock.
    • Deprecated method ws.record.forceUnlockRecord in favour of ws.node.forceUnlock.
    • Deprecated method ws.record.forceLockRecord in favour of ws.node.forceLock.
    • Deprecated method ws.repository.getThesaurusFolder.

 

 

© OpenKM kcenter v.1.0.0 (build: d51a7b0). All Rights Reserved. Documentation license