Record samples

On most methods, you’ll see the parameter named “recId” and “fldId”. The value of these parameters can be a valid record and folder UUID.

Tip

Example of recId:

• Using UUID -> “28bb0c8b-3701-4457-a81a-fef7bc56ff33”

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

Then you should log in using the “login” method. You can access the “login” method from the webservice object “ws” as shown below:

ws.login(user, password);

Caution

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

At this point you can use all the Record methods from the “record” class as shown below:

ws.record.create("ada67d44-b081-4b23-bdc1-74181cafbc5d", "PKI-100200", "new title", 0)

Methods

create

Description:

Method	Return values	Description
create(String fldId, String name, String title, long nodeClass)	Record	Creates a new record and returns a Record object.

Caution

Optionally, a title can be set; the other variables of the Record (record) will not have any effect on record creation.

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);

            try
            {
                ws.login(user, password);
                ws.record.create(fldId, "PKI-100200", "some title", 0);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createWithPropertyGroup

Description:

Method	Return values	Description
createWithPropertyGroup(String uuid, String name, String title, long nodeClass, String grpName, Dictionary<String, String> properties)	Record	Creates a new record and sets a property group’s properties in the same call. Returns a Record object.

The parameter uuid should be a valid folder or record UUID.

The grpName should be a valid Metadata group name.

Note

Unlike calling create followed by a separate propertyGroup.addGroup, which would generate two consecutive versions, this method applies the record creation and the property group values as a single atomic operation, generating only one version.

It is not mandatory to set all field values in the properties parameter; only the properties belonging to grpName are applied.

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);

            try
            {
                ws.login(user, password);
                Dictionary<String, String> props = new Dictionary<String, String>();
                props.Add("okp:consulting.name", "test");
                ws.record.createWithPropertyGroup(fldId, "PKI-100200", "some title", 0, "okg:consulting", props);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getProperties

Description:

Method	Return values	Description
getProperties(String uuid)	Record	Returns the record 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);

            try
            {
                ws.login(user, password);
                System.Console.WriteLine(ws.record.getProperties("50b7a5b9-89d2-430e-bbc9-6a6e01662a71").path);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

delete

Description:

Method	Return values	Description
delete(String recId)	void	Deletes a record.

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);

            try
            {
                ws.login(user, password);
                ws.record.delete("50b7a5b9-89d2-430e-bbc9-6a6e01662a71");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purge

Description:

Method	Return values	Description
purge(String recId)	void	Records are permanently removed from the repository.

Usually, you will purge records into /okm:trash/userId - the personal user trash locations - but it is possible to directly purge any record from the entire repository.

Caution

When a record is purged, it can only be restored from a previous repository backup. The purge action permanently removes the record 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);

            try
            {
                ws.login(user, password);
                ws.record.purge("50b7a5b9-89d2-430e-bbc9-6a6e01662a71");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

rename

Description:

Method	Return values	Description
rename(String uuid, String newName)	void	Renames a record.

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);

            try
            {
                ws.login(user, password);
                ws.record.rename("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "PKI-100201");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

move

Description:

Method	Return values	Description
move(String recId, String dstId)	void	Moves a record into a folder or another 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);

            try
            {
                ws.login(user, password);
                ws.record.move("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "055e4384-7c70-4456-b32b-f5a55a79861f");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

copy

Description:

Method	Return values	Description
copy(String recId, String dstId, String newName)	Record	Copies a record into a folder or another record.

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

If the newName parameter value is null, the record will preserve the same name.

Caution

Only the security grants are copied to the destination; the metadata, keywords, etc. of the record are not 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);

            try
            {
                ws.login(user, password);
                ws.record.copy("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "055e4384-7c70-4456-b32b-f5a55a79861f", "PKI-100200");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isValid

Description:

Method	Return values	Description
isValid(String uuid)	Boolean	Returns a boolean that indicates whether the node is a record.

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);

            try
            {
                ws.login(user, password);
                System.Console.WriteLine("Is a record:"+ ws.record.isValid("50b7a5b9-89d2-430e-bbc9-6a6e01662a71").ToString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildren

Description:

Method	Return values	Description
getChildren(String uuid)	List	Returns a list of all records whose parent is fldId.

The parameter uuid 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);

            try
            {
                ws.login(user, password);
                foreach (Record rec in ws.record.getChildren("055e4384-7c70-4456-b32b-f5a55a79861f"))
                {
                    System.Console.WriteLine(rec);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setTitle

Description:

Method	Return values	Description
setTitle(String uuid, String title)	void	Sets a record 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);

            try
            {
                ws.login(user, password);
                ws.record.setTitle("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "some title");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getPath

Description:

Method	Return values	Description
getPath(String uuid)	String	Converts a record UUID to a record 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);

            try
            {
                ws.login(user, password);
     System.Console.WriteLine(ws.record.getPath("50b7a5b9-89d2-430e-bbc9-6a6e01662a71"));
            }
            catch (Exception e)
            {
     System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setNodeClass

Description:

Method	Return values	Description
setNodeClass(String uuid, long ncId)	void	Sets a record node class.

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);

            try
            {
                ws.login(user, password);
                ws.record.setNodeClass("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", 0);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setDispositionStage

Description:

Method	Return values	Description
setDispositionStage(String uuid, long stage)	void	Sets the disposition stage.

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);

            try
            {
                ws.login(user, password);
                ws.record.setDispositionStage("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", 1);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setDescription

Description:

Method	Return values	Description
setDescription(String uuid, String description)	void	Sets the 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);

            try
            {
                ws.login(user, password);
                ws.record.setDescription("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "some description");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createWizard

Description:

Method	Return values	Description
createWizard(String uuid, String name, String title, long nodeClass)	WizardNode	Creates a record using a wizard.

Note

The WizardNode contains a list of pending actions that should be done to complete the process of record creation. These might be:

• Add keyword
• Add Categories
• Add Metadata

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);

            try
            {
                ws.login(user, password);
                WizardNode wnode = ws.record.createWizard("f123a950-0329-4d62-8328-0ff500fd42db", "REC-001", "Any title", 0);
                System.Console.WriteLine(wnode.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createFromTemplate

Description:

Method	Return values	Description
createFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool propertyGroups, bool security Dictionary<String, String> properties)	Record	Creates a new record from the template and returns a Record object.

The uuid parameter is the template UUID of the record.

The dstPath can be a folder or a record path.

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

Note

For more information about Templates and metadata check: Creating templates.

Note

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 notes parameter is true, the original values of the notes will be copied.

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);
                try
                {
                    ws.login(user, password);
                    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\" ]");
                    Record record = ws.record.createFromTemplate("9fa9787e-d8b0-4ff7-905a-a89f0b228ec8", "/okm:root/test/dst", true, true, false, true, true, properties);
                }
                catch (Exception e)
                {
                    System.Console.WriteLine(e.ToString());
                }
           }
      }
}

extendedCopy

Description:

Method	Return values	Description
extendedCopy(String uuid, String dstId, String newName, bool categories, bool keywords, bool propertyGroups, bool notes, bool security)	Record	Copies a record with the associated data into some folder or record.

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

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

Note

By default, only the binary data and the security grants are copied; the metadata, keywords, etc. of the folder 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 security parameter is true, the original value of the security will be copied.

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);
                try
                {
                    ws.login(user, password);
                    ws.record.extendedCopy("ada67d44-b081-4b23-bdc1-74181cafbc5d", "8599eab7-ae61-4628-8010-1103d6950c63",
                       "new name record", true, true, true, true, true, true);
                }
                catch (Exception e)
                {
                    System.Console.WriteLine(e.ToString());
                }
           }
      }
}

createMissingRecords

Description:

Method	Return values	Description
createMissingRecords(String recPath)	String	Create missing records.

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);

             try
             {
                 ws.login(user, password);
                 ws.record.createMissingRecords("/okm:root/rec001/rec0011/rec00111");
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}