Repository samples
Methods
getRootFolder
Description:
Method | Return values | Description |
---|---|---|
getRootFolder() |
Folder |
Returns the object Folder of node "/okm:root" |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getRootFolder());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getTrashFolder
Description:
Method | Return values | Description |
---|---|---|
getTrashFolder() |
Folder |
Returns the object Folder of node "/okm:trash/{userId}" |
The returned folder will be the user trash folder. For example if the method is executed by "okmAdmin" user then the folder returned will be "/okm:trash/okmAdmin". |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getTrashFolder());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getTemplatesFolder
Description:
Method | Return values | Description |
---|---|---|
getTemplatesFolder() |
Folder |
Returns the object Folder of node "/okm:templates" |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getTemplatesFolder());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getPersonalFolder
Description:
Method | Return values | Description |
---|---|---|
getPersonalFolder() |
Folder |
Returns the object Folder of node "/okm:personal/{userId}" |
The returned folder will be the user personal folder. For example if the method is executed by "okmAdmin" user then the folder returned will be "/okm:personal/okmAdmin". |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getPersonalFolder());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getMailFolder
Description:
Method | Return values | Description |
---|---|---|
getMailFolder() |
Folder |
Returns the object Folder of node "/okm:mail/{userId}" |
The returned folder will be the user mail folder. For example if the method is executed by "okmAdmin" user then the folder returned will be "/okm:mail/okmAdmin". |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getMailFolder());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getThesaurusFolder
Description:
Method | Return values | Description |
---|---|---|
getThesaurusFolder() |
Folder |
Returns the object Folder of node "/okm:thesaurus" |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getThesaurusFolder());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getCategoriesFolder
Description:
Method | Return values | Description |
---|---|---|
getCategoriesFolder() |
Folder |
Returns the object Folder of node "/okm:categories" |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getCategoriesFolder());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
purgeTrash
Description:
Method | Return values | Description |
---|---|---|
purgeTrash() |
void |
Definitively remove from repository all nodes into "/okm:trash/{userId}" |
For example if the method is executed by "okmAdmin" user then the purged trash will be "/okm:trash/okmAdmin". When a node is purged it will only be able to be restored from a previous repository backup. The purge action remove the node definitely from the repository.
|
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
ws.purgeTrash();
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getUpdateMessage
Description:
Method | Return values | Description |
---|---|---|
getUpdateMessage() |
String |
Retrieves a message when a new OpenKM release is available. |
There's an official OpenKM update message service available which is based on your local OpenKM version. The most common message is that a new OpenKM version has been released. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8180/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getUpdateMessage());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getRepositoryUuid
Description:
Method | Return values | Description |
---|---|---|
getRepositoryUuid() |
String |
Retrieves an installation unique identifier. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getRepositoryUuid());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
hasNode
Description:
Method | Return values | Description |
---|---|---|
hasNode(String nodeId) |
Boolean |
Returns a node that indicate if a node exists or not. |
The value of the parameter nodeId can be a valid UUID or path. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine("Exists node:" + ws.hasNode("064ff51a-b815-4f48-a096-b4946876784f"));
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getNodePath
Description:
Method | Return values | Description |
---|---|---|
getNodePath(String uuid) |
String |
Converts a node UUID to path. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getNodePath("e339f14b-4d3a-489c-91d3-05e4575709d2"));
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getNodeUuid
Description:
Method | Return values | Description |
---|---|---|
getNodeUuid(String path) |
String |
Converts a node path to UUID. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getNodeUuid("/okm:root/tmp"));
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getAppVersion
Description:
Method | Return values | Description |
---|---|---|
getAppVersion() |
AppVersion |
Returns information about OpenKM version. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
System.Console.WriteLine(ws.getAppVersion());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
executeSqlQuery
Description:
Method | Return values | Description |
---|---|---|
executeSqlQuery(FileStream fs) |
SqlQueryResults |
Executes SQL sentences. |
The test.sql script used in the sample below:
The SQL script can only contain a single SQL sentence. This action can only be done by a superuser ( user with ROLE_ADMIN ). |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using System.IO;
using com.openkm.sdk4csharp.bean;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
FileStream fs = new FileStream("E:\\test.sql", FileMode.Open);
SqlQueryResults result = ws.executeSqlQuery(fs);
foreach (SqlQueryResultColumns row in result.sqlQueryResults)
{
System.Console.WriteLine("uuid:" + row.sqlQueryResultColumn[0] + ", name:" + row.sqlQueryResultColumn[1]);
}
fs.Dispose();
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
executeHqlQuery
Description:
Method | Return values | Description |
---|---|---|
executeHqlQuery(FileStream fs) |
HqlQueryResults |
Execute HQL sentences. |
The test.sql script used in the sample below:
The HQL script can only contain a single HQL sentence. This action can only be done by a superuser ( user with ROLE_ADMIN ). |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using System.IO;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
FileStream fs = new FileStream(@"C:\Desktop\test.sql", FileMode.Open);
HqlQueryResults result = ws.executeHqlQuery(fs);
foreach (HqlQueryResultColumns row in result.hqlQueryResults)
{
foreach (string column in row.hqlQueryResultColumn)
{
System.Console.WriteLine(column);
}
}
fs.Dispose();
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
executeScript
Description:
Method | Return values | Description |
---|---|---|
executeScript(FileStream fs) |
ScriptExecutionResult |
Execute an script. |
The local script - test.bsh - used in the sample below:
This action can only be done by a superuser ( user with ROLE_ADMIN ). |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using System.IO;
using com.openkm.sdk4csharp.bean;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "okmAdmin";
String password = "admin";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
FileStream fs = new FileStream("E:\\test.bsh", FileMode.Open);
ScriptExecutionResult result = ws.executeScript(fs);
System.Console.WriteLine(result.result);
System.Console.WriteLine(result.stdout);
if (!result.stderr.Equals(""))
{
System.Console.WriteLine("Error happened");
System.Console.WriteLine(result.stderr);
}
fs.Dispose();
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getConfiguration
Description:
Method | Return values | Description |
---|---|---|
getConfiguration(String key) |
Configuration |
Retrieve the value of a configuration parameter. |
If your OpenKM version have the configuration parameter named "webservices.visible.properties", will be restricted for non Administrator users what parameters are accessible. That means any non Administrator use who will try accessing across the webservices to configuration parameters not set into the list of values of "webservices.visible.properties" will get an access denied exception. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/OpenKM";
String username = "user1";
String password = "pass1";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
try
{
Configuration configuration = ws.getConfiguration("system.ocr");
System.Console.WriteLine(configuration);
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}