SDK for .NET

Changelog of version 4.x

Changelog of version 3.x

Changelog of version 2.x

Changelog of version 1.x

Downloads

Changelog of version 2.x

SDK for .NET 2.x

v2.7.0

Released 2020-05-21
Update of the RestSharp library to version 106.10.1.
Document
- Added methods:
  - stamp(String docId, int type, long stId)
  - stampImage(String docId, long stId, String range, String exprX, String exprY, FileStream image)
Plugins
- Added methods:
  - Stream executePluginPostReturnFile(String className, Dictionary<String, String> parameters, FileStream fs)
  - Stream executePluginGetReturnFile(String className, Dictionary<String, String> parameters)
Bugs
- Improvement in the Serializations and Deserializations of the objects: Document, Folder, Mail, Record, FormElementComplex, ProcessInstance, TaskInstance, Token, ProcessDefinition and MapParams.

v2.6.3

Released 2020-04-17
Bugs
- The method "findPaginated" returns a null value for the property "actualVersion"
- Fix when copying a FormElementComplex to FormElement skip the array validator.
- Bug to upload documents with accented names. Affected methods ( createDocument, checkin, createAttachment, importMSG, importEML and doc2txt)
- Bug with deserialization on findMoreLikeThis and findByQueryPaginated.

v2.6.2

Released 2019-04-05
Bugs
- General
  - Validation of the host URL for methods using System.Net.Http. Affected methods: createDocumentSimple, check-in, createAttachment, importEml , importMsg and doc2txt.
- Auth
  - Correction in the value assignment of the password parameter. Affected methods: updateUser.
  - Error in the serialization of the changesecurity. Affected methods:changeSecurity.
- Document
  - Download large files. Affected methods: getContentByVersion and getDifferences.
  - Correction in the URL of the service. Affected methods: getAnnotations.
- Mail
  - Replacement of the internal data type "byte array" by a "StreamContent". Affected methods:importMsg, importEml and createAttachment.
- Report
  - Error when generating the report file. Affected methods:executeReport.
- Search
  - Correction in the value assignment of the query parameter. Affected methods: FindByQueryPaginated.
  - Correction in the deserialization of the QueryParams type with respect to the Operator property. Affected methods: updateSearch.
  - Correction of the parameter "qpId" as type "UrlSegment". Affected methods: deleteSearch.

v2.6.1

Released 2018-11-16
Updated tools:
- Net Framework 4.5.2
- Restsharp 105.2.3.0
- System.Net.Http
Bugs
- Upload, download and update large files. Affected methods: createDocumetSimple, getContent and check-in.

v2.6.0

Released 2018-09-14
Search changes:
- The method findByQueryPaginated does not capture a parameter.
- Added method findByQueryPaginated.
- Manual serialization of the type query params.
Repository changes:
- Added method getServerTime to get the current server time.
Mail changes:
- The method sendMailWithAttachments now have a field named from
Because we have introduced Swagger support the WS library has been updated and thebehaviour of some methods have been changed. That means if you use version 2.5 or older with OpenKM version 6.4.45 or upper it will be raised and error. The methods affected are what return boolean or long values :
- isCheckedOut
- isLocked
- getVersionHistorySize
- isValidDocument
- isValidFolder
- isValidMail
- isValidRecord
- hasGroup
- hasNode
- saveSearch

v2.5.2

Released 2018-07-17
Bugs:
- Relation:
  - Method getRelationGroups have been modified. Have been applied change for deserialization of RelationGroup type.
  - Method findGroup, change the URL service "services/rest/relation/getRelationGroups" to "services/rest/relation/findGroup".
- Search:
  - Method find has been modified. Have been applied change for deserialization of Record type.

v2.5.1

Released 2017-08-28
Auth changes:
- In loging method, has been include error message. Now is indicated when the error is caused by wrong URL connection.
Search changes:
- Methods find, findPaginated and findSimpleQueryPaginated have been modified. Have been applied core changed for deserialization of resultset, queryresult, and node types.
- Added List<string> suggestions property in ResulSet class.

v2.5.0

Released 2017-02-24
Auth changes:
- Added methods:
  - public void login()
Repository changes:
- Added methods:
  - public List<ChangeLogged> getChangeLog(String nodePath, Calendar modificationsFrom)
- Changes
  - method executePlugin(String className, Map<String, String> parameters, Class<?> clazz, InputStream is) now allows to uploading a document.
Document changes
- Added methods:
  - public InputStream getDifferences(String docId, String v1, String v2)
  - public List<Document> getCheckedOut()
  - public Version checkin(String docId, InputStream is, String comment, int increment)
Workflow changes
- Added methods:
  - public Map<String, List<FormElement>> getProcessDefinitionForms(long pdId)

Propertygroup changes
- Changes
  - method getPropertyGroupForm raises PluginNotFoundException
Folder changes
- Added methods:
  - public void createMissingFolders(String fldPath)
Improvements
- Added support for Reports.
- Added variable hasRelation in class Node ( Document, Folder, Record and Mail related ).
- The object HqlQueryResults now has a variables HqlQueryResultColumns what contains a list of columns ( related with method executeHqlQuery ).
Bugs
- FormElement parentValue mapping solved ( only applicable for Select type ).
- Changed variable named "role" in favour of name "user" in the method grantUser.

v2.4.0

Released 2016-02-24
Auth changes:
- Added methods:
  - public void createUser(String user, String password, String email, String name, boolean active)
  - public void deleteUser(String user)
  - public void updateUser(String user, String password, String email, String name, boolean active)
  - public void createRole(String role, boolean active)
  - public void deleteRole(String role)
  - public void updateRole(String role, boolean active)
  - public void assignRole(String user, String role)
  - public void removeRole(String user, String role)
  - public void changeSecurity(ChangeSecurity changeSecurity)

Document changes:
- Added methods:
  - public List<String> getDetectedLanguages()
  - public String getAnnotations(String docId, String verName)
- Changes:
  - Now renameDocument(String docId, String newName) returns Document object.
  - Method "setTitle" has been renamed in favour "setDocumentTitle" name.
Mail changes:
- Added methods:
  - public Mail importEml(String dstId, String title, InputStream is)
  - public Mail importMsg(String dstId, String title, InputStream is)
  - public void setMailTitle(String mailId, String title)
  - public void sendMail(List<String> recipients, String subject, String body)
- Changes:
  - Added variable "newName" in extendedMailCopy method.
Reporsitory changes:
- Added methods:
  - public Configuration getConfiguration(String key)
  - public Object executePlugin(String className, Dictionary<String, String> parameters)
Search changes:
- Changes:
  - Added variable "propertiesPlugin" in method find.
  - Added variable "propertiesPlugin" in method findPaginated.
Workflow:
- Changes
  - Changed "FormElementComplexList values" in favour "List<FormElement> values" in method runProcessDefinition.
  - Changed "FormElementComplexList values" in favour "List<FormElement> values" in method setTaskInstanceValues.
Added variables "language" and "title" in Document object.
Added Conversion support:
- Added Methods:
  - public InputStream doc2pdf(FileStream is, String fileName)
  - public InputStream pdf2swf(FileStream is, String fileName)
  - public InputStream imageConvert(FileStream is, String fileName, List<String> params, String dstMimeType)
  - public InputStream html2pdf(String url)
  - public String doc2txt(InputStream is, String fileName)
  - public String img2txt(InputStream is, String fileName)
  - public String barcode2txt(InputStream is, String fileName)

v2.3.1

Released 2015-11-18
Fixed problem with MessageBox present in some methods.

Table of contents [ Hide Show ]

SDK for .NET 2.x

v2.7.0
v2.6.3
v2.6.2
v2.6.1
v2.6.0
v2.5.2
v2.5.1
v2.5.0
v2.4.0
v2.3.1

Changelog of version 2.x

SDK for .NET 2.x

v2.7.0

Released 2020-05-21
Update of the RestSharp library to version 106.10.1.
Document
- Added methods:
  - stamp(String docId, int type, long stId)
  - stampImage(String docId, long stId, String range, String exprX, String exprY, FileStream image)
Plugins
- Added methods:
  - Stream executePluginPostReturnFile(String className, Dictionary<String, String> parameters, FileStream fs)
  - Stream executePluginGetReturnFile(String className, Dictionary<String, String> parameters)
Bugs
- Improvement in the Serializations and Deserializations of the objects: Document, Folder, Mail, Record, FormElementComplex, ProcessInstance, TaskInstance, Token, ProcessDefinition and MapParams.

v2.6.3

Released 2020-04-17
Bugs
- The method "findPaginated" returns a null value for the property "actualVersion"
- Fix when copying a FormElementComplex to FormElement skip the array validator.
- Bug to upload documents with accented names. Affected methods ( createDocument, checkin, createAttachment, importMSG, importEML and doc2txt)
- Bug with deserialization on findMoreLikeThis and findByQueryPaginated.

v2.6.2

Released 2019-04-05
Bugs
- General
  - Validation of the host URL for methods using System.Net.Http. Affected methods: createDocumentSimple, check-in, createAttachment, importEml , importMsg and doc2txt.
- Auth
  - Correction in the value assignment of the password parameter. Affected methods: updateUser.
  - Error in the serialization of the changesecurity. Affected methods:changeSecurity.
- Document
  - Download large files. Affected methods: getContentByVersion and getDifferences.
  - Correction in the URL of the service. Affected methods: getAnnotations.
- Mail
  - Replacement of the internal data type "byte array" by a "StreamContent". Affected methods:importMsg, importEml and createAttachment.
- Report
  - Error when generating the report file. Affected methods:executeReport.
- Search
  - Correction in the value assignment of the query parameter. Affected methods: FindByQueryPaginated.
  - Correction in the deserialization of the QueryParams type with respect to the Operator property. Affected methods: updateSearch.
  - Correction of the parameter "qpId" as type "UrlSegment". Affected methods: deleteSearch.

v2.6.1

Released 2018-11-16
Updated tools:
- Net Framework 4.5.2
- Restsharp 105.2.3.0
- System.Net.Http
Bugs
- Upload, download and update large files. Affected methods: createDocumetSimple, getContent and check-in.

v2.6.0

Released 2018-09-14
Search changes:
- The method findByQueryPaginated does not capture a parameter.
- Added method findByQueryPaginated.
- Manual serialization of the type query params.
Repository changes:
- Added method getServerTime to get the current server time.
Mail changes:
- The method sendMailWithAttachments now have a field named from
Because we have introduced Swagger support the WS library has been updated and thebehaviour of some methods have been changed. That means if you use version 2.5 or older with OpenKM version 6.4.45 or upper it will be raised and error. The methods affected are what return boolean or long values :
- isCheckedOut
- isLocked
- getVersionHistorySize
- isValidDocument
- isValidFolder
- isValidMail
- isValidRecord
- hasGroup
- hasNode
- saveSearch

v2.5.2

Released 2018-07-17
Bugs:
- Relation:
  - Method getRelationGroups have been modified. Have been applied change for deserialization of RelationGroup type.
  - Method findGroup, change the URL service "services/rest/relation/getRelationGroups" to "services/rest/relation/findGroup".
- Search:
  - Method find has been modified. Have been applied change for deserialization of Record type.

v2.5.1

Released 2017-08-28
Auth changes:
- In loging method, has been include error message. Now is indicated when the error is caused by wrong URL connection.
Search changes:
- Methods find, findPaginated and findSimpleQueryPaginated have been modified. Have been applied core changed for deserialization of resultset, queryresult, and node types.
- Added List<string> suggestions property in ResulSet class.

v2.5.0

Released 2017-02-24
Auth changes:
- Added methods:
  - public void login()
Repository changes:
- Added methods:
  - public List<ChangeLogged> getChangeLog(String nodePath, Calendar modificationsFrom)
- Changes
  - method executePlugin(String className, Map<String, String> parameters, Class<?> clazz, InputStream is) now allows to uploading a document.
Document changes
- Added methods:
  - public InputStream getDifferences(String docId, String v1, String v2)
  - public List<Document> getCheckedOut()
  - public Version checkin(String docId, InputStream is, String comment, int increment)
Workflow changes
- Added methods:
  - public Map<String, List<FormElement>> getProcessDefinitionForms(long pdId)

Propertygroup changes
- Changes
  - method getPropertyGroupForm raises PluginNotFoundException
Folder changes
- Added methods:
  - public void createMissingFolders(String fldPath)
Improvements
- Added support for Reports.
- Added variable hasRelation in class Node ( Document, Folder, Record and Mail related ).
- The object HqlQueryResults now has a variables HqlQueryResultColumns what contains a list of columns ( related with method executeHqlQuery ).
Bugs
- FormElement parentValue mapping solved ( only applicable for Select type ).
- Changed variable named "role" in favour of name "user" in the method grantUser.

v2.4.0

Released 2016-02-24
Auth changes:
- Added methods:
  - public void createUser(String user, String password, String email, String name, boolean active)
  - public void deleteUser(String user)
  - public void updateUser(String user, String password, String email, String name, boolean active)
  - public void createRole(String role, boolean active)
  - public void deleteRole(String role)
  - public void updateRole(String role, boolean active)
  - public void assignRole(String user, String role)
  - public void removeRole(String user, String role)
  - public void changeSecurity(ChangeSecurity changeSecurity)

Document changes:
- Added methods:
  - public List<String> getDetectedLanguages()
  - public String getAnnotations(String docId, String verName)
- Changes:
  - Now renameDocument(String docId, String newName) returns Document object.
  - Method "setTitle" has been renamed in favour "setDocumentTitle" name.
Mail changes:
- Added methods:
  - public Mail importEml(String dstId, String title, InputStream is)
  - public Mail importMsg(String dstId, String title, InputStream is)
  - public void setMailTitle(String mailId, String title)
  - public void sendMail(List<String> recipients, String subject, String body)
- Changes:
  - Added variable "newName" in extendedMailCopy method.
Reporsitory changes:
- Added methods:
  - public Configuration getConfiguration(String key)
  - public Object executePlugin(String className, Dictionary<String, String> parameters)
Search changes:
- Changes:
  - Added variable "propertiesPlugin" in method find.
  - Added variable "propertiesPlugin" in method findPaginated.
Workflow:
- Changes
  - Changed "FormElementComplexList values" in favour "List<FormElement> values" in method runProcessDefinition.
  - Changed "FormElementComplexList values" in favour "List<FormElement> values" in method setTaskInstanceValues.
Added variables "language" and "title" in Document object.
Added Conversion support:
- Added Methods:
  - public InputStream doc2pdf(FileStream is, String fileName)
  - public InputStream pdf2swf(FileStream is, String fileName)
  - public InputStream imageConvert(FileStream is, String fileName, List<String> params, String dstMimeType)
  - public InputStream html2pdf(String url)
  - public String doc2txt(InputStream is, String fileName)
  - public String img2txt(InputStream is, String fileName)
  - public String barcode2txt(InputStream is, String fileName)

v2.3.1

Released 2015-11-18
Fixed problem with MessageBox present in some methods.