OKMRest
2.6.0
OpenKM Rest
|
Public Member Functions | |
void | refreshConfiguration (String host, String userName, String password) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseConversion | |
Stream | doc2pdf (FileStream fileStream, String fileName) |
Stream | pdf2swf (FileStream fileStream, String fileName) |
Stream | imageConvert (FileStream fileStream, String fileName, List< String > paramss, String dstMimeType) |
Stream | html2pdf (String url) |
string | doc2txt (FileStream fileStream, String fileName) |
string | img2txt (FileStream fileStream, String fileName) |
string | barcode2txt (FileStream fileStream, String fileName) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseDocument | |
Document | createDocumentSimple (String docPath, FileStream fileStream) |
void | deleteDocument (String docId) |
Document | getDocumentProperties (String docId) |
Stream | getContent (String docId) |
Stream | getContentByVersion (String docId, String versionId) |
String | getExtractedText (String docId) |
Stream | getThumbnail (String docId, String type) |
List< Document > | getDocumentChildren (String fldId) |
Document | renameDocument (String docId, String newName) |
void | setProperties (Document doc) |
void | setLanguage (String docId, String lang) |
void | setDocumentTitle (String docId, String title) |
void | checkout (String docId) |
void | cancelCheckout (String docId) |
void | forceCancelCheckout (String docId) |
Boolean | isCheckedOut (String docId) |
com.openkm.sdk4csharp.bean.Version | checkin (String docId, String comment, Stream fileStream) |
com.openkm.sdk4csharp.bean.Version | checkin (String docId, String comment, Stream fileStream, int increment) |
LockInfo | lockDocument (String docId) |
void | unlock (String docId) |
void | forceUnlock (String docId) |
Boolean | isLocked (String docId) |
LockInfo | getLockInfo (String docId) |
void | purgeDocument (String docId) |
void | moveDocument (String docId, String dstId) |
void | copyDocument (String docId, String dstId, String newName) |
long | getVersionHistorySize (String docId) |
Boolean | isValidDocument (String docId) |
String | getDocumentPath (String uuid) |
List< String > | getDetectedLanguages () |
void | extendedCopy (String docId, String dstId, String name, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki) |
Document | createFromTemplate (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, List< FormElement > properties) |
void | updateFromTemplate (String docId, String dstId, List< FormElement > properties) |
List< com.openkm.sdk4csharp.bean.Version > | getDocumentVersionHistory (String docId) |
void | restoreDocumentVersion (String docId, String versionId) |
void | purgeDocumentVersionHistory (String docId) |
Document | createFromTemplateSimple (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, Dictionary< String, String > properties) |
void | updateFromTemplateSimple (String docId, String dstId, Dictionary< String, String > properties) |
String | getAnnotations (String docId, String verName) |
Stream | getDifferences (String docId, String v1, String v2) |
List< Document > | getCheckedOut () |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseAuth | |
void | login () |
Dictionary< String, int > | getGrantedRoles (String nodeId) |
Dictionary< String, int > | getGrantedUsers (String nodeId) |
List< String > | getRoles () |
List< String > | getUsers () |
String | getMail (String user) |
String | getName (String user) |
List< String > | getUsersByRole (String role) |
List< String > | getRolesByUser (String user) |
List< Profile > | getProfiles (Boolean filterByActive) |
Profile | getUserProfile (String userId) |
void | setUserProfile (String userId, long profileId) |
void | grantRole (String nodeId, String role, int permissions, Boolean recursive) |
void | grantUser (String nodeId, String user, int permissions, Boolean recursive) |
void | revokeRole (String nodeId, String role, int permissions, Boolean recursive) |
void | revokeUser (String nodeId, String user, int permissions, Boolean recursive) |
void | createUser (String user, String password, String email, String name, Boolean active) |
void | updateUser (String user, String password, String email, String name, Boolean active) |
void | updateRole (String role, Boolean active) |
void | assignRole (String user, String role) |
void | removeRole (String user, String role) |
void | createRole (String role, Boolean active) |
void | deleteUser (String user) |
void | deleteRole (String role) |
void | changeSecurity (ChangeSecurity changeSecurity) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseFolder | |
Folder | createFolder (Folder fld) |
Folder | createFolderSimple (String fldPath) |
void | deleteFolder (String fldId) |
Folder | getFolderProperties (String fldId) |
Folder | renameFolder (String fldId, String newName) |
void | moveFolder (String fldId, String dstId) |
List< Folder > | getFolderChildren (String fldId) |
Boolean | isValidFolder (String fldId) |
String | getFolderPath (String uuid) |
void | copyFolder (String fldId, String dstId) |
void | extendedFolderCopy (String fldId, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki) |
ContentInfo | getContentInfo (String fldId) |
void | purgeFolder (String fldId) |
void | setStyle (String fldId, long styleId) |
void | createMissingFolders (String fldPath) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseMail | |
createMail (Mail mail) | |
getMailProperties (String mailId) | |
void | deleteMail (String mailId) |
renameMail (String mailId, String newName) | |
void | moveMail (String mailId, String dstId) |
Boolean | isValidMail (String mailId) |
String | getMailPath (String uuid) |
Document | createAttachment (String mailId, String docName, FileStream fileStream) |
void | deleteAttachment (String mailId, String docId) |
List< Document > | getAttachments (String mailId) |
void | purgeMail (String mailId) |
void | copyMail (String mailId, String dstId, String newName) |
void | extendedMailCopy (String mailId, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, String newName) |
List< Mail > | getMailChildren (String fldId) |
void | sendMailWithAttachments (String from, List< String > to, List< String > cc, List< String > bcc, String subject, String body, List< String > docsId, String dstId) |
importEml (String dstId, String title, FileStream fileStream) | |
importMsg (String dstId, String title, FileStream fileStream) | |
void | setMailTitle (String mailId, String title) |
void | sendMail (List< String > recipient, String subject, String body) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseNote | |
Note | addNote (String nodeId, String text) |
Note | getNote (String noteId) |
void | deleteNote (String noteId) |
void | setNote (String noteId, String text) |
List< Note > | listNotes (String nodeId) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseNode | |
VersionList | getVersionHistory (String nodeId) |
void | restoreVersion (String nodeId, String versionName) |
void | purgeVersionHistory (String nodeId) |
PromoteAsRecordEvaluation | mayBePromotedAsRecordNode (String nodeId) |
void | promoteAsRecord (String nodeId) |
Boolean | isElectronicRecordPath (String nodeId) |
void | degradeRecord (String nodeId) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseProperty | |
void | addCategory (String nodeId, String catId) |
void | removeCategory (String nodeId, String catId) |
void | addKeyword (String nodeId, String keyword) |
void | removeKeyword (String nodeId, String keyword) |
void | setEncryption (String nodeId, String cipherName) |
void | unsetEncryption (String nodeId) |
void | setSigned (String nodeId, Boolean signed) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BasePropertyGroup | |
void | addGroup (String nodeId, String grpName) |
void | removeGroup (String nodeId, String grpName) |
List< PropertyGroup > | getGroups (String nodeId) |
List< PropertyGroup > | getAllGroups () |
List< FormElement > | getPropertyGroupProperties (String nodeId, String grpName) |
Dictionary< String, String > | getPropertyGroupPropertiesSimple (String nodeId, String grpName) |
List< FormElement > | getPropertyGroupForm (String grpName) |
void | setPropertyGroupProperties (String nodeId, String grpName, List< FormElement > properties) |
void | setPropertyGroupPropertiesSimple (String nodeId, String grpName, Dictionary< String, String > properties) |
Boolean | hasGroup (String nodeId, String grpName) |
String | getRegisteredDefinition () |
List< string > | getSuggestions (String nodeId, String grpName, String propName) |
void | registerDefinition (FileStream fileStream) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRecord | |
Record | createRecord (Record rec) |
Record | getRecordProperties (String recId) |
void | deleteRecord (String recId) |
void | purgeRecord (String recId) |
void | renameRecord (String recId, String newName) |
void | moveRecord (String recId, String dstId) |
void | copyRecord (String recId, String dstId, String newName) |
Boolean | isValidRecord (String recId) |
List< Record > | getRecordChildren (String fldId) |
LockInfo | lockRecord (String recId) |
void | unlockRecord (String recId) |
void | forceUnlockRecord (String recId) |
void | setRecordTitle (String recId, String title) |
String | getRecordPath (String uuid) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRepository | |
Folder | getRootFolder () |
Folder | getTrashFolder () |
Folder | getTrashFolderBase () |
Folder | getTemplatesFolder () |
Folder | getPersonalFolder () |
Folder | getPersonalFolderBase () |
Folder | getMailFolder () |
Folder | getMailFolderBase () |
Folder | getThesaurusFolder () |
Folder | getCategoriesFolder () |
void | purgeTrash () |
String | getUpdateMessage () |
String | getRepositoryUuid () |
Boolean | hasNode (String nodeId) |
String | getNodePath (String uuid) |
String | getNodeUuid (String nodePath) |
AppVersion | getAppVersion () |
void | copyAttributes (String nodeId, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki) |
ScriptExecutionResult | executeScript (FileStream fileStream) |
SqlQueryResults | executeSqlQuery (FileStream fileStream) |
HqlQueryResults | executeHqlQuery (FileStream fileStream) |
Dictionary< string, string > | getTranslations (String lang, String module) |
Configuration | getConfiguration (String key) |
string | executePlugin (String className, Dictionary< String, String > param, FileStream fileStream) |
List< ChangeLogged > | getChangeLog (String nodePath, DateTime modificationsFrom) |
String | getServerTime () |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseSearch | |
List< QueryResult > | findByContent (String content) |
List< QueryResult > | findByName (String name) |
List< QueryResult > | findByKeywords (List< String > keywords) |
List< QueryResult > | find (QueryParams qp, String propertiesPlugin) |
ResultSet | findPaginated (QueryParams queryParams, int offset, int limit, String propertiesPlugins) |
ResultSet | findSimpleQueryPaginated (int offset, int limit, String statement) |
ResultSet | findMoreLikeThis (String uuid, int max) |
Dictionary< string, int > | getKeywordMap (String[] filter) |
List< Document > | getCategorizedDocuments (String categoryId) |
long | saveSearch (QueryParams Params) |
void | updateSearch (QueryParams Params) |
QueryParams | getSearch (int qpId) |
List< QueryParams > | getAllSearchs () |
void | deleteSearch (int qpId) |
QueryResultList | findByQuery (String query) |
ResultSet | findByQueryPaginated (int offset, int limit, String query, String propertiesPlugin) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRelation | |
List< RelationType > | getRelationTypes (String type) |
void | addRelation (String nodeAId, String nodeBId, long relTypeId) |
void | deleteRelation (long relationId) |
List< Relation > | getRelations (String nodeId) |
List< RelationGroup > | getRelationGroups (String nodeId) |
void | addRelationGroup (String nodeId, String groupName, long type) |
void | addNodeToGroup (String nodeId, long groupId) |
void | deleteRelationGroup (String nodeId, long groupId) |
RelationGroup | findRelationGroup (long groupId) |
void | setRelationGroupName (long groupId, String groupName) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseWorkflow | |
void | registerProcessDefinition (FileStream fileStream) |
void | deleteProcessDefinition (long pdId) |
ProcessDefinition | getProcessDefinition (long pdId) |
ProcessInstance | runProcessDefinition (long pdId, String uuid, List< FormElement > values) |
List< ProcessInstance > | findProcessInstances (long pdId) |
List< ProcessDefinition > | findAllProcessDefinitions () |
List< ProcessDefinition > | findLatestProcessDefinitions () |
ProcessDefinition | findLastProcessDefinition (String name) |
ProcessInstance | getProcessInstance (long piId) |
List< TaskInstance > | findUserTaskInstances () |
List< TaskInstance > | findTaskInstances (long piId) |
void | setTaskInstanceValues (long tiId, String transName, List< FormElement > values) |
TaskInstance | getTaskInstance (long tiId) |
void | setTaskInstanceActorId (long tiId, String actorId) |
void | startTaskInstance (long tiId) |
void | endTaskInstance (long tiId, String transName) |
Dictionary< String, List< FormElement > > | getProcessDefinitionForms (long pdId) |
Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseReport | |
List< Report > | getReports (bool active) |
Report | getReport (long rpId) |
Stream | executeReport (long rpId, string format, Dictionary< string, string > param) |
void com.openkm.sdk4csharp.OKMWebservice.refreshConfiguration | ( | String | host, |
String | userName, | ||
String | password | ||
) |
Implemented in com.openkm.sdk4csharp.OKMWebservice20.