Document samples

Basics

On most methods you'll see parameter named "docId". The value of this parameter can be a valid document UUID or path.

Example of docId:

Using UUID -> "f123a950-0329-4d62-8328-0ff500fd42db";
Using path -> "/okm:root/logo.png"

Methods

createDocumentSimple

Description:

Method	Return values	Description
createDocumentSimple(String docPath, FileStream fs)	Document	Creates a new document and returns as a result an object Document with the properties of the created document.

Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
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 fileStream = new FileStream("E:\\logo.png", FileMode.Open);
                ws.createDocumentSimple("/okm:root/logo.png", fileStream);
                fileStream.Dispose();
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

deleteDocument

Description:

Method	Return values	Description
deleteDocument(String docId)	void	Deletes a document.
When a document is deleted it is automatically moved to /okm:trash/userId folder.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                ws.deleteDocument("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
            
            System.Console.ReadKey();
        }
    }
}

getDocumentProperties

Description:

Method	Return values	Description
getDocumentProperties(String docId)	Document	Returns the document properties.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                 System.Console.WriteLine(ws.getDocumentProperties("/okm:root/logo.png").toString());
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getContent

Description:

Method	Return values	Description
getContent(String docId)	Stream	Retrieves a document content - binary data - of the actual document version.
In case you sent the file across a Servlet response we suggest set the content lenght with: `Document doc = ws.getDocumentProperties("/okm:root/logo.png"); response.setContentLength(new Long(doc.getActualVersion().getSize()).intValue());` We've found wrong size problems while using: `response.setContentLength(is.available());`

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
            {
                Stream st = ws.getContent("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getContentByVersion

Description:

Method	Return values	Description
getContentByVersion(String docId,String versionId)	Stream	Retrieves a document content ( binary data ) of some specific document version.
In case you sent the file across a Servlet response we suggest set the content length with: `Document doc = ws.getDocumentProperties("/okm:root/logo.png"); response.setContentLength(new Long(doc.getActualVersion().getSize()).intValue());` We've found wrong size problems while using: `response.setContentLength(is.available());`

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
            {
                Stream st = ws.getContentByVersion("/okm:root/logo.png","1.1");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getDocumentChildren

Description:

Method	Return values	Description
getDocumentChildren(String fldId)	List<Document>	Returns a list of all documents which their parent is fldId.
The parameter fldId can be a folder or a record node.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                foreach (Document doc in ws.getDocumentChildren("/okm:root"))
                {
                    System.Console.WriteLine(doc);
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

renameDocument

Description:

Method	Return values	Description
renameDocument(String docId, String newName)	document	Changes the name of a document.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                 Document doc = ws.renameDocument("f123a950-0329-4d62-8328-0ff500fd42db", "logo_rename.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

setProperties

Description:

Method	Return values	Description
setProperties(Document doc)	void	Changes some document properties.
Variables allowed to be changed: Title Description Language Associated categories Associated keywords Only not null and not empty variables will be taken on consideration.

Method

Return values

Description

setProperties(Document doc)

void

Changes some document properties.

Variables allowed to be changed:

Title
Description
Language
Associated categories
Associated keywords

Only not null and not empty variables will be taken on consideration.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                Document doc = ws.getDocumentProperties("f123a950-0329-4d62-8328-0ff500fd42db");
                doc.description = "some description";
                doc.keywords.Add("test");
                ws.setProperties(doc);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

checkout

Description:

Method	Return values	Description
checkout(String docId)	void	Marks the document for edition.
Only one user can modify a document at the same time. Before starting edition you must do a check-out action that locks the edition process for other users and allows only to the user who has executed the action.

Method

Return values

Description

checkout(String docId)

void

Marks the document for edition.

Only one user can modify a document at the same time.

Before starting edition you must do a check-out action that locks the edition process for other users and allows only to the user who has executed the action.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                ws.checkout("/okm:root/logo.png");
                // At this point the document is locked for other users except for the user who executed the action
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

cancelCheckout

Description:

Method	Return values	Description
cancelCheckout(String docId)	void	Cancel a document edition.
This action can only be done by the user who previously executed the checkout action.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                // At this point the document is locked for other users except for the user who executed the action
                ws.cancelCheckout("/okm:root/logo.png");
                // At this point other users are allowed to execute a checkout and modify the document
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

forceCancelCheckout

Description:

Method	Return values	Description
forceCancelCheckout(String docId)	void	Cancels a document edition.
This method allows to cancel the edition on any document. It is not mandatory to execute this action by the same user who previously executed the checkout action. This action can only be done by a super user ( user with ROLE_ADMIN ).

Method

Return values

Description

forceCancelCheckout(String docId)

void

Cancels a document edition.

This method allows to cancel the edition on any document.

It is not mandatory to execute this action by the same user who previously executed the checkout action.

This action can only be done by a super user ( user with ROLE_ADMIN ).

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                // At this point the document is locked for other users except for the user who executed the action
                ws.forceCancelCheckout("/okm:root/logo.png");
                // At this point other users are allowed to execute a checkout and modify the document
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

isCheckedOut

Description:

Method	Return values	Description
isCheckedOut(String docId)	Boolean	Returns a boolean that indicates if the document is being edited or not.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                System.Console.WriteLine("Is the document checkout:"+ws.isCheckedOut("/okm:root/logo.png"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

checkin

Description:

Method	Return values	Description
checkin(String docId, String comment, FileStream fs)	Version	Updates a document with new version and returns an object with new Version values.
Only the user who started the edition - checkout - is allowed to update the document.

Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.IO;
using com.openkm.sdk4csharp;

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:\\logo.png", FileMode.Open);
                ws.checkin("/okm:root/logo.png","optional some comment",fs);
                fs.Dispose();
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getDocumentVersionHistory

Description:

Method	Return values	Description
getDocumentVersionHistory(String docId)	List<Version>	Returns a list of all document versions.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                foreach (Version version in ws.getVersionHistory("/okm:root/logo.png")) 
                {
                 System.Console.WriteLine(version);
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

lock

Description:

Method	Return values	Description
lock(String docId)	LockInfo	Locks a document and returns an object with the Lock information.
Only the user who locked the document is allowed to unlock. A locked document can not be modified by other users.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                ws.lockDocument("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

unlock

Description:

Method	Return values	Description
unlock(String docId)	void	Unlocks a locked document.
Only the user who locked the document is allowed to unlock.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                ws.unlock("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

forceUnlock

Description:

Method	Return values	Description
forceUnlock(String docId)	void	Unlocks a locked document.
This method allows to unlock any locked document. It is not mandatory to execute this action by the same user who previously executed the checkout lock action. This action can only be done by a super user ( user with ROLE_ADMIN ).

Method

Return values

Description

forceUnlock(String docId)

void

Unlocks a locked document.

This method allows to unlock any locked document.

It is not mandatory to execute this action by the same user who previously executed the checkout lock action.

This action can only be done by a super user ( user with ROLE_ADMIN ).

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                ws.forceUnlock("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

isLocked

Description:

Method	Return values	Description
isLocked(String docId)	Boolean	Returns a boolean that indicates if the document is locked or not.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                System.Console.WriteLine("Is document locked:" + ws.isLocked("/okm:root/logo.png"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getLockInfo

Description:

Method	Return values	Description
getLockInfo(String docId)	LockInfo	Returns an object with the Lock information

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                System.Console.WriteLine(ws.getLockInfo("/okm:root/logo.png"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

purgeDocument

Description:

Method	Return values	Description
purgeDocument(String docId)	void	Document is definitely removed from repository.
Usually you will purge documents into /okm:trash/userId - the personal trash user locations - but is possible to directly purge any document from the whole repository. When a document is purged it will only be able to be restored from a previous repository backup. The purge action removes the document definitely from the repository.

Method

Return values

Description

purgeDocument(String docId)

void

Document is definitely removed from repository.

Usually you will purge documents into /okm:trash/userId - the personal trash user locations - but is possible to directly purge any document from the whole repository.

When a document is purged it will only be able to be restored from a previous repository backup. The purge action removes the document 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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                ws.purgeDocument("/okm:trash/okmAdmin/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

moveDocument

Description:

Method	Return values	Description
moveDocument(String docId, String dstId)	void	Moves a document into a folder or record.
The values of the dstId parameter should be a folder or record 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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                ws.moveDocument("/okm:root/logo.png", "/okm:root/test");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

copyDocument

Description:

Method	Return values	Description
copyDocument(String docId, String dstId, String newName)	void	Copies a document into a folder or record.
The values of the dstId parameter should be a folder or record UUID or path. When parameter newName value is null, document will preserve the same name. Only the binary data and the security grants are copied to destionation, the metadata, keywords, etc. of the document are not copied. See "extendedDocumentCopy" method for this feature.

Method

Return values

Description

copyDocument(String docId, String dstId, String newName)

void

Copies a document into a folder or record.

The values of the dstId parameter should be a folder or record UUID or path.

When parameter newName value is null, document will preserve the same name.

Only the binary data and the security grants are copied to destionation, the metadata, keywords, etc. of the document are not copied.

See "extendedDocumentCopy" method for this feature.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                ws.copyDocument("/okm:root/logo.png", "/okm:root/temp", "new_logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

restoreVersion

Description:

Method	Return values	Description
restoreVersion(String docId, String versionId)	void	Promotes a previous document version tothe current 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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                // Actual version is 2.0
                ws.restoreVersion("/okm:root/logo.png", "1.0");
                // Actual version is 1.0
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

purgeVersionHistory

Description:

Method	Return values	Description
purgeVersionHistory(String docId)	void	Purges all document versions except the actual version.
This action compact the version history of a document. This action can not be reverted.

Method

Return values

Description

purgeVersionHistory(String docId)

void

Purges all document versions except the actual version.

This action compact the version history of a document.

This action can not be reverted.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                // Version history has version 1.3,1.2,1.1 and 1.0
                ws.purgeVersionHistory("/okm:root/logo.png");
                // Version history has only version 1.3
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getVersionHistorySize

Description:

Method	Return values	Description
getVersionHistorySize(String docId)	long	Returns the sum in bytes of all documents into documents history.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                String[] UNITS = new String[] { "B", "KB", "MB", "GB", "TB", "PB", "EB" };
                long bytes = ws.getVersionHistorySize("/okm:root/logo.png");
                String value = "";
                
                for (int i = 6; i > 0; i--) 
                {
                    double step = Math.Pow(1024, i);
                    if (bytes > step)
                        value = String.Format(Locale.ROOT, "%3.1f %s", bytes / step, UNITS[i]);
                }
                
                if (value.Equals("")) 
                {
                    value = bytes.ToString() + " " + UNITS[0];
                }
                
                System.Console.WriteLine(value);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

isLocked

Description:

Method	Return values	Description
isValidDocument(String docId)	Boolean	Returns a boolean that indicates if the node is a document or not.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);

            try
            {
                // Return true
                ws.isValidDocument("/okm:root/logo.png");

                // Return false
                ws.isValidDocument("/okm:root");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getDocumentPath

Description:

Method	Return values	Description
getDocumentPath(String uuid)	String	Converts a document UUID to a document 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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            
            try
            {
                System.Console.WriteLine(ws.getDocumentPath("e339f14b-4d3a-489c-91d3-05e4575709d2"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

extendedDocumentCopy

Description:

Method	Return values	Description
extendedDocumentCopy(String docId, String dstId, String name, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki)	void	Copies a document with associated data into a folder or record.
The values of the dstId parameter should be a folder or record UUID or path. When parameter newName value is null, document will preserve the same name. By default only the binary data and the security grants, the metadata, keywords, etc. of the document are not copied. Additional: When the category parameter is true the original values of the categories will be copied. When the keywords parameter is true the original values of the keywords will be copied. When the propertyGroups parameter is true the original values of the metadata groups will be copied. When the notes parameter is true the original values of the notes will be copied. When the wiki parameter is true the original values of the wiki will be copied.

Method

Return values

Description

extendedDocumentCopy(String docId, String dstId, String name, boolean categories, boolean keywords,
boolean propertyGroups, boolean notes, boolean wiki)

void

Copies a document with associated data into a folder or record.

The values of the dstId parameter should be a folder or record UUID or path.

When parameter newName value is null, document will preserve the same name.

By default only the binary data and the security grants, the metadata, keywords, etc. of the document are not copied.

Additional:

When the category parameter is true the original values of the categories will be copied.
When the keywords parameter is true the original values of the keywords will be copied.
When the propertyGroups parameter is true the original values of the metadata groups will be copied.
When the notes parameter is true the original values of the notes will be copied.
When the wiki parameter is true the original values of the wiki will be copied.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            
            try
            {
                ws.extendedDocumnetCopy("/okm:root/logo.png", "/okm:root/tmp", null, true, true, true, true, true);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getExtractedText

Description:

Method	Return values	Description
getExtractedText(String docId)	String	Returns an String with the extracted text by text extractor process.
When a document is uploaded into OpenKM goes into text extraction queue. There's a crontab tab that periodically process this queue and extract document contents. Unfortunately there is not a direct way to know if a document has been processed or not from the API, because this information is only stored at database level. Although this restriction, from API - only administrators users - can be done database queries to retrieve this information. Check Repository samples for accessing database level. More information at Statistics.

Method

Return values

Description

getExtractedText(String docId)

String

Returns an String with the extracted text by text extractor process.

When a document is uploaded into OpenKM goes into text extraction queue. There's a crontab tab that periodically process this queue and extract document contents.

Unfortunately there is not a direct way to know if a document has been processed or not from the API, because this information is only stored at database level.

Although this restriction, from API - only administrators users - can be done database queries to retrieve this information. Check Repository samples for accessing database level.

More information at Statistics.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            
            try
            {
                System.Console.WriteLine(ws.getExtractedText("/okm:root/document.doc"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

getThumbnail

Description:

Method	Return values	Description
getThumbnail(String docId, ThumbnailType type)	Stream	Returns a thumbnail image data.
Available types: ThumbnailType.THUMBNAIL_PROPERTIES ( shown in properties view ) ThumbnailType.THUMBNAIL_LIGHTBOX ( shown in light box ) ThumbnailType.THUMBNAIL_SEARCH ( shown in search view ) Each thumbnail type has its own image dimensions.

Method

Return values

Description

getThumbnail(String docId, ThumbnailType type)

Stream

Returns a thumbnail image data.

Available types:

ThumbnailType.THUMBNAIL_PROPERTIES ( shown in properties view )
ThumbnailType.THUMBNAIL_LIGHTBOX ( shown in light box )
ThumbnailType.THUMBNAIL_SEARCH ( shown in search view )

Each thumbnail type has its own image dimensions.

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
            {
                Stream st = ws.getThumbnail("/okm:root/document.doc", ThumbnailType.THUMBNAIL_LIGHTBOX);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

setLanguage

Description:

Method	Return values	Description
setLanguage(String docId, String lang)	void	Sets a document language.
The parameter lang must be ISO 691-1 compliant. More information at https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            
            try
            {
                ws.setLanguage("/okm:root/document.doc", "es");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

setTitle

Description:

Method	Return values	Description
setTitle(String docId, String title)	void	Sets a document title.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            
            try
            {
                ws.setTitle("/okm:root/document.doc", "Some title here");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

createFromTemplate

Description:

Method	Return values	Description
Document createFromTemplate(String docId, String dstPath, String language, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, List<FormElement> properties)	Document	Creates a new document from template and returns an object Document.
The dstPath can be a folder or a record path. The parameter language is optional. When a template uses metadata groups to fill fields into, then these values are mandatory and must be set into properties parameter. For more information about Templates and metadata take a look at Creating templates. Additional: When the category parameter is true the original values of the categories will be copied. When the keywords parameter is true the original values of the keywords will be copied. When the propertyGroups parameter is true the original values of the metadata groups will be copied. When the notes parameter is true the original values of the notes will be copied. When the wiki parameter is true the original values of the wiki will be copied.

Method

Return values

Description

Document createFromTemplate(String docId, String dstPath, String language, boolean categories, boolean keywords,
boolean propertyGroups, boolean notes, boolean wiki, List<FormElement> properties)

Document

Creates a new document from template and returns an object Document.

The dstPath can be a folder or a record path.

The parameter language is optional.

When a template uses metadata groups to fill fields into, then these values are mandatory and must be set into properties parameter.

For more information about Templates and metadata take a look at Creating templates.

Additional:

When the category parameter is true the original values of the categories will be copied.
When the keywords parameter is true the original values of the keywords will be copied.
When the propertyGroups parameter is true the original values of the metadata groups will be copied.
When the notes parameter is true the original values of the notes will be copied.
When the wiki parameter is true the original values of the wiki will be copied.

Example:

The example below is based on Creating PDF template sample.

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 = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            
            try
            {
                List<FormElement> formElements = new  List<FormElement>();
                Input name = new Input();
                name.name = "okp:tpl.name";
                name.value = "Some name";
                formElements.Add(name);
            
                Input birdDate = new Input();
                birdDate.name = "okp:tpl.bird_date";
                DateTime date = DateTime.Now;
                // Value must be converted to String ISO 8601 compliant
                birdDate.value = ISO8601.formatBasic(date);
                formElements.Add(birdDate);
            
                Select language = new Select();
                language.name = "okp:tpl.language";
                // With selected option is enought
                Option option = new Option();
                option.value = "java";
                option.selected = true;
                language.options.Add(option);
                formElements.Add(language);
                ws.createFromTemplate("/okm:templates/tpl.pdf", "/okm:root/test.pdf", null, false, false, true, false, false, formElements);
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createFromTemplateSimple

Description:

Method	Return values	Description
Document createFromTemplateSimple(String docId, String dstPath, String language, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, Map<String, String> properties)	Document	Creates a new document from a template and returns an object Document.
The dstPath can be a folder or a record path. The parameter language is optional. When template use metadata groups to fill fields into, then these values are mandatory and must be set into properties parameter. For more information about Templates and metadata take a look at Creating templates. Additional: When the category parameter is true the original values of the categories will be copied. When the keywords parameter is true the original values of the keywords will be copied. When the propertyGroups parameter is true the original values of the metadata groups will be copied. When the notes parameter is true the original values of the notes will be copied. When the wiki parameter is true the original values of the wiki will be copied.

Method

Return values

Description

Document createFromTemplateSimple(String docId, String dstPath, String language, boolean categories,
boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, Map<String, String> properties)

Document

Creates a new document from a template and returns an object Document.

The dstPath can be a folder or a record path.

The parameter language is optional.

When template use metadata groups to fill fields into, then these values are mandatory and must be set into properties parameter.

For more information about Templates and metadata take a look at Creating templates.

Additional:

When the category parameter is true the original values of the categories will be copied.
When the keywords parameter is true the original values of the keywords will be copied.
When the propertyGroups parameter is true the original values of the metadata groups will be copied.
When the notes parameter is true the original values of the notes will be copied.
When the wiki parameter is true the original values of the wiki will be copied.

Example:

The example below is based on Creating PDF template sample.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;

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
            {
                Dictionary<String, String> properties = new  Dictionary<String, String>();
                properties.Add("okp:tpl.name", "Some name");
                DateTime date = DateTime.Now;
                // Value must be converted to String ISO 8601 compliant
                properties.Add("okp:tpl.bird_date", ISO8601.formatBasic(date));
                properties.Add("okp:tpl.language", "java");
                ws.createFromTemplateSimple("/okm:templates/tpl.pdf", "/okm:root/test.pdf",null, false, false, true, false, false, properties);
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

updateFromTemplate

Description:

Method	Return values	Description
updateFromTemplate(String docId, String dstId, List<FormElement> properties)	Document	Updates a document previously created from a template and returns an object Document.
This method only has sense when template use metadata groups to fill fields into. For more information about Templates and metadata take a look at Creating templates.

Method

Return values

Description

updateFromTemplate(String docId, String dstId, List<FormElement> properties)

Document

Updates a document previously created from a template and returns an object Document.

This method only has sense when template use metadata groups to fill fields into.

For more information about Templates and metadata take a look at Creating templates.

Example:

The example below is based on Creating PDF template sample.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.bean.form;
using com.openkm.sdk4csharp.util;

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
            {
                List<FormElement> formElements = new List<FormElement>();
                Input name = new Input();
                name.name = "okp:tpl.name";
                name.value = "Some name";
                formElements.Add(name);

                Input birdDate = new Input();
                birdDate.name = "okp:tpl.bird_date";
                DateTime date = DateTime.Now;
                // Value must be converted to String ISO 8601 compliant
                birdDate.value = ISO8601.formatBasic(date);
                formElements.Add(birdDate);

                Select language = new Select();
                language.name = "okp:tpl.language";
                // With selected option is enought
                Option option = new Option();
                option.value = "java";
                option.selected = true;
                language.options.Add(option);
                formElements.Add(language);

                ws.updateFromTemplate("/okm:templates/tpl.pdf", "/okm:root/test.pdf", formElements);
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            } 
        }
    }
}

updateFromTemplateSimple

Description:

Method	Return values	Description
updateFromTemplateSimple(String docId, String dstId, Map<String, String> properties)	Document	Updates a document previously created from a template and returns an object Document.
This method only has sense when template use metadata groups to fill fields into. For more information about Templates and metadata take a look at Creating templates.

Method

Return values

Description

updateFromTemplateSimple(String docId, String dstId, Map<String, String> properties)

Document

Updates a document previously created from a template and returns an object Document.

This method only has sense when template use metadata groups to fill fields into.

For more information about Templates and metadata take a look at Creating templates.

Example:

The example below is based on Creating PDF template sample.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;

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
            {
                Dictionary<String, String> properties = new  Dictionary<String, String>();
                properties.Add("okp:tpl.name", "Some name");
                DateTime date = DateTime.Now;
                // Value must be converted to String ISO 8601 compliant
                properties.Add("okp:tpl.bird_date", ISO8601.formatBasic(date));
                properties.Add("okp:tpl.language", "java");

                ws.updateFromTemplateSimple("/okm:templates/tpl.pdf", "/okm:root/test.pdf", properties);
            } 
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

Table of contents [ Hide Show ]

Basics
Methods

createDocumentSimple
deleteDocument
getDocumentProperties
getContent
getContentByVersion
getDocumentChildren
renameDocument
setProperties
checkout
cancelCheckout
forceCancelCheckout
isCheckedOut
checkin
getDocumentVersionHistory
lock
unlock
forceUnlock
isLocked
getLockInfo
purgeDocument
moveDocument
copyDocument
restoreVersion
purgeVersionHistory
getVersionHistorySize
isLocked
getDocumentPath
extendedDocumentCopy
getExtractedText
getThumbnail
setLanguage
setTitle
createFromTemplate
createFromTemplateSimple
updateFromTemplate
updateFromTemplateSimple

SDK for .NET 2.3.1

Document samples

Basics

Methods

createDocumentSimple

deleteDocument

getDocumentProperties

getContent

getContentByVersion

getDocumentChildren

renameDocument

setProperties

checkout

cancelCheckout

forceCancelCheckout

isCheckedOut

checkin

getDocumentVersionHistory

lock

unlock

forceUnlock

isLocked

getLockInfo

purgeDocument

moveDocument

copyDocument

restoreVersion

purgeVersionHistory

getVersionHistorySize

isLocked

getDocumentPath

extendedDocumentCopy

getExtractedText

getThumbnail

setLanguage

setTitle

createFromTemplate

createFromTemplateSimple

updateFromTemplate

updateFromTemplateSimple