Skip to content

Changelog v4.x

v 4.20

Section titled “v 4.20”
  • In progress

v4.19

Section titled “v4.19”
  • 2026-07-21
  • RepositoryService
    • New methods:
      • Added createShortenUrl(String name, String url) method that returns a shortened URL.

v4.18

Section titled “v4.18”
  • 2026-04-17
  • Updated:
    • InsertPages in PDFService has been redesigned in order to be more useful and understandable. It now uses PageInsertOperations to perform the inserts.
    • PDFService
      • The extract() method now returns a Document object.
  • Fixed
    • Improved error messages during the login stage.

v4.17

Section titled “v4.17”
  • 2026-03-12
  • Fixed
    • Fixed metadata description field that was not mapped correctly.

v4.16.0

Section titled “v4.16.0”
  • 2026-01-28
  • WorkflowService
    • New methods:
      • Allows starting a workflow without an associated node using the new method runProcessDefinition(long pdId, Dictionary<String, String> propertiesMap)
      • Added searchAssignedTasks(DateTime? start, DateTime? end, String status, long procDefId, int offset, int limit), a method that returns workflow tasks assigned to the logged-in user filtered by date range, status, and process definition, with pagination parameters.
      • Added searchStartedByMe(DateTime? start, DateTime? end, String status, long procDefId, int offset, int limit), a method that returns workflow tasks started by the logged-in user filtered by date range, status, and process definition, with pagination parameters.
      • Added searchOverview(DateTime? start, DateTime? end, String status, long procDefId, String initiator, String taskUser, int offset, int limit), a method that returns a general overview of all users’ workflow tasks filtered by date range, status, process definition, initiator, and task user, with pagination parameters.
  • SearchService
    • Changed method:
      • Updated csvExport(String lang, QueryParams queryParams, List propertyGroups, bool compact)  to support metadata groups.

v4.15.0

Section titled “v4.15.0”
  • 2025-11-21
  • Fixed
    • Fixed a serialization error for JSON-formatted values in plugin parameters
  • Updated:
    • The method getAllGroups now has an optional parameter, uuid.

v4.14.0

Section titled “v4.14.0”
  • 2025-07-08
  • PDFService
    • List split(String uuid, String dstId, String baseName, List pages) now returns a list of documents
    • Document remove(String uuid, String dstId, String name, List pages) now returns a document
    • Document rotate(String uuid, String dstId, String name, int angle, List pages) now returns a document

v4.13.0

Section titled “v4.13.0”
  • 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.0

Section titled “v4.12.0”

  • 2025-04-10

  •  AuthService

    • Removed methods
      • boolean hasSecurityRecursive()
      • boolean hasTaskManagerAdmin()
      • boolean isAdmin()
      • boolean isPasswordExpired()

  •  RepositoryService

    • Removed methods
      • boolean getIsFilePlan();

  •  SearchService

    • Removed methods
      • List getMimeTypes()
      • SearchPluginList getSearchPlugins()

  • DocumentService

    • Removed methods
      • List getLiveEditRestrictedMimeTypes()

  • NodeService

    • Removed methods
      • NodePaginatorConfig getPaginatorConfig(String pluginName)
      • PaginatorPluginList getPaginatorPlugins()

  • Fixed the PrincipalAdapterException; it is now named AuthException.

v4.11.0

Section titled “v4.11.0”
  • 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
      • List getSqlReports(bool active); 
      • Stream executeSql(long rpId)
      • Document saveSql(long rpId, Dictionary<String, String> _params, String dstId, String docName)

v4.10.0

Section titled “v4.10.0”
  • 2024-12-05
  • 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 type in the TextArea class.
  • Deleted variable linkTarget in the Node class.
  • Deleted variable restricted in the Node class.
  • AuthService
    • Added method
      • String login(String personalAccessToken)
      • String createPersonalAccessToken(String name, DateTime expiration)
  • MailService
    • Added method
      • void sendMail(String to, String subject, String body)
  • ImportService
    • Added methods
      • String importDocument(String uuid, DateTime? date, String author, FileInfo file);
      • String importFolder(String uuid, String name, DateTime? date, String author);
      • String importRecord(String uuid, String name, DateTime? date, String author);

v4.9.0

Section titled “v4.9.0”
  • 2024-09-10
  • AuthService
    • Added method
      • String getRefreshToken()
  •  MailService
    • Changed the internal implementation
      • The method getMailsPaginated now returns an object of type SimpleNodeBaseResultSet

v4.8.0

Section titled “v4.8.0”
  • Released 2024-07-18
  • PDFService
    • Added method
      • bool optimize(String uuid)

v4.7.0

Section titled “v4.7.0”
  • Released 2024-06-12
  • Warning: An internal change to the functions means that 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, bool enabled)
  • SearchService
    • Deleted methods
      • ResultSet findPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugins);
      • ResultSet findPaginated(QueryParams queryParams, String sortField, bool sortReverse, int offset, int limit, String propertiesPlugin);
      • ResultSet findByQueryPaginated(String query, int offset, int limit, String propertiesPlugin);
      • ResultSet findByQueryPaginated(String query, String sortField, bool sortReverse, int offset, int limit, String propertiesPlugin);
  • WizardService
    • Added method
      • List 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, bool preview, bool oneTimeUse, DateTime validUntil)
  • PropertyService
    • Changed the internal implementation
      • void removeKeyword(String uuid, String keyword)
  • StampService
    • Changed the 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.0

Section titled “v4.6.0”
  • Released 2024-04-23
  • Added the variable pooledActors in the ITaskInstance class.

v4.5.0

Section titled “v4.5.0”
  • Released 2024-03-11
  • Deleted AutodcadService
  • SearchService
    • Deleted method
      • Dictionary<string, int> getKeywordMap(List filter)
  • DocumentService
    • Added method
      • List getXrefs(String uuid)
      • void refresh(String uuid)
  • BookmarkService
    • Changed method
      • Bookmark create(String uuid, String name)
  • 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, bool recursive)
      • void revokeUser(String uuid, String userId, int permissions, bool recursive)
      • void grantRole(String uuid, String roleId, int permissions, bool recursive)
      • void grantUser(String uuid, String userId, int permissions, bool recursive)
      • void deleteUser(String userId)
      • void updateUser(String userId, String password, String email, String name, bool active)
      • void updateRole(String roleId, bool active)
      • void assignRole(String userId, String roleId)
      • void setUserProfile(String userId, long profileId)
      • void setUserPermissions(String uuid, String userId, int permissions, bool recursive)
      • void setRolePermissions(String uuid, String roleId, int permissions, bool recursive)
      • void setUserTenant(long tenantId)
      • InputStream getTwoFactorQR(String secret)
      • String validate2FAAndSaveSecret(String secret, int code)
      • String disable2FA()
    • 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 keywords, List 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, bool categories, bool keywords, bool propertyGroups, bool notes, bool security)
      • void setDescription(String uuid, String description)
      • String mergePdf(String destinationUuid, String docName, List uuids)
      • Document saveAsPdf(String uuid, String newName, bool propertyGroups, bool 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, bool categories, bool keywords, bool propertyGroups, bool notes, bool 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, bool categories, bool keywords, bool propertyGroups, bool notes, bool 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 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 users, List roles, List mails, String message)
      • Document saveAsPdf(String uuid, String newName, bool propertyGroups, bool 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 uuids, List users, List roles, List mails, String message, bool attachment)
    • PropertyService
      • void addCategory(String uuid, String catId)
      • void addKeyword(String uuid, String keyword)
      • void setEncryption(String uuid, String cipherName)
      • void setSigned(String uuid, bool 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, bool categories, bool keywords, bool propertyGroups, bool notes, bool 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, bool categories, bool keywords, bool propertyGroups, bool notes)
    • TaskService
      • Task create(String subject, String start, String end, String description, long statusId, long projectId,
                               long typeId, String user, List notificationUsers, List externalUsers, List relatedDocuments,
                               List relatedFolders, List relatedRecords, List 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 notificationUsers, List externalUsers,
                               List relatedDocuments, List relatedFolders, List relatedRecords, List 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, bool active, String description)
      • TaskProject updateProject(long projectId, bool active, String name, String description)
      • TaskType createType(String name, bool active, String description)
      • TaskType updateType(long typeId, bool active, String name, String description)
      • TaskStatus createStatus(String name, bool finish)
      • TaskStatus createStatus(String name, bool finish)
      • TaskStatus updateStatus(long statusId, String name, bool finish)
      • TaskNote createNote(long taskId, String text)
      • TaskNote updateNote(long noteId, String text)
    • UserConfigService
      • void setHome(String uuid)
    • WizardService
      • void postponeNode(String uuid, DateTime 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.0

Section titled “v4.4.0”
  • 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.0

Section titled “v4.3.0”
  • Released 2024-01-15
  • New variables propertyGroups and security in the TemplateParams class.
  • DocumentService
    • New method
      • Document createDocumentFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool security, Dictionary<String, String> properties);
  • FolderService
    • New method
      • Folder createFolderFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool propertyGroups, bool security, Dictionary<String, String> properties);
  • RecordService
    • New method
      • Record createRecordFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool propertyGroups, bool security, Dictionary<String, String> properties);

v4.2.0 

Section titled “v4.2.0 ”
  • Released 2023-11-23
  • 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 logging to the Auth class.
  • PDFService
    • New method
      • insertPages(String uuid, String srcId, int sourceFromPage, int sourceToPage, int insertFromPage) to insert pages in a PDF.

v4.1.0

Section titled “v4.1.0”
  • Released 2023-11-20
  • There are many changes between SDK version 3.x and 4.x; the most important considerations for migration between versions are:
    • All the methods deprecated in 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.