Import samples

 Basic

We suggest executing the methods below for large imports or for simple creation cases.

These methods execute fewer steps in the background, as described in Document samples and Folder samples. This means you will get better performance because less logic is executed on the server side.

Example of UUID:

  • Using UUID -> "f123a950-0329-4d62-8328-0ff500fd42db";

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

Then you should log in using the method "login". You can access the "login" method from the web service object "ws" as shown below:

ws.login(user, password);

Once you are logged in with the web service, the session is kept in the web service object. Then you can use the other API methods.

At this point you can use all the import methods from the "quickImport" class as shown below:

ws.quickImport.importDocument("1be884f4-5758-4985-94d1-f18bfe004db8", fileInfo);

Methods 

importDocument

Description:

MethodReturn valuesDescription

importDocument(String uuid, FileInfo fi)

String

Creates a new document and returns the UUID of the document.

The value of the uuid parameter should be a folder or record node UUID.

Example:

using System; using System.Collections.Generic;
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 = "okmAdmin";
String password = "admin";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

try
{
ws.login(user, password);  
FileInfo fileInfo = new FileInfo("E:\\doc.docx");
String uuid = ws.quickImport.importDocument("22c1d190-f798-489d-b420-2008cb38705b", fileInfo);
System.Console.WriteLine("UUID ="+ uuid);
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());

}
}
}
}

importFolder

Description:

MethodReturn valuesDescription

importFolder(String uuid, String name)

String

Creates a new folder and returns the UUID of the folder.

The value of the uuid parameter should be a folder or record node UUID.

Example:

using System; using System.Collections.Generic;
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 = "okmAdmin";
String password = "admin";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

try
{
ws.login(user, password);  
String uuid = ws.quickImport.importFolder("22c1d190-f798-489d-b420-2008cb38705b", "Folder-Name");
System.Console.WriteLine("UUID ="+ uuid);
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());

}
}
}
}