Record samples

En la mayoría de los métodos verá los parámetros llamados “recId” y “fldId”. El valor de estos parámetros puede ser un UUID válido de un expediente o de una carpeta.

Consejo

Ejemplo de recId:

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

Ejemplo de código sugerido

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en el webservice, la sesión se mantiene en el objeto webservice. A partir de ahí puede usar el resto de métodos de la API

Llegados a este punto, puede usar todos los métodos de Record desde la clase “record”, tal y como se muestra a continuación:

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

Métodos

create

Descripción:

Método	Valores de retorno	Descripción
create(String fldId, String name, String title, long nodeClass)	Record	Crea un nuevo expediente y devuelve un objeto Record.

Precaución

Opcionalmente se puede establecer un título; el resto de variables del expediente (record) no tendrán ningún efecto en su creación.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
createWithPropertyGroup(String uuid, String name, String title, long nodeClass, String grpName, Dictionary<String, String> properties)	Record	Crea un nuevo expediente y establece las propiedades de un grupo de metadatos en la misma llamada. Devuelve un objeto Record.

El parámetro uuid debe ser un UUID válido de carpeta o expediente.

El parámetro grpName debe ser un nombre de grupo de metadatos válido.

Nota

A diferencia de llamar a create seguido de un propertyGroup.addGroup independiente, lo que generaría dos versiones consecutivas, este método aplica la creación del expediente y los valores del grupo de metadatos como una única operación atómica, generando solo una versión.

No es obligatorio establecer todos los valores de campo en el parámetro properties; solo se aplican las propiedades pertenecientes a grpName.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
getProperties(String uuid)	Record	Devuelve las propiedades del expediente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
delete(String recId)	void	Elimina un expediente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
purge(String recId)	void	Los expedientes se eliminan permanentemente del repositorio.

Habitualmente, los expedientes se purgan en /okm:trash/userId - la papelera personal del usuario - pero es posible purgar directamente cualquier expediente desde cualquier punto del repositorio.

Precaución

Cuando se purga un expediente, solo se puede restaurar a partir de una copia de seguridad anterior del repositorio. La acción de purgado elimina el expediente del repositorio de forma permanente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
rename(String uuid, String newName)	void	Cambia el nombre de un expediente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
move(String recId, String dstId)	void	Mueve un expediente a una carpeta u otro expediente.

El valor del parámetro dstId debe ser un UUID o path de carpeta o expediente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
copy(String recId, String dstId, String newName)	Record	Copia un expediente a una carpeta u otro expediente.

El valor del parámetro dstId debe ser un UUID o path de carpeta o expediente.

Si el valor del parámetro newName es null, el expediente conservará el mismo nombre.

Precaución

Solo se copian los permisos de seguridad; los metadatos, palabras clave, etc. del expediente no se copian.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
isValid(String uuid)	Boolean	Devuelve un booleano que indica si el nodo es un expediente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
getChildren(String uuid)	List	Devuelve una lista con todos los expedientes cuyo padre es fldId.

El parámetro uuid puede ser una carpeta o un nodo de tipo expediente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
setTitle(String uuid, String title)	void	Establece el título de un expediente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
getPath(String uuid)	String	Convierte un UUID de expediente en su path.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
setNodeClass(String uuid, long ncId)	void	Establece la clase de nodo de un expediente.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
setDispositionStage(String uuid, long stage)	void	Establece la etapa de disposición.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
setDescription(String uuid, String description)	void	Establece el título.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
createWizard(String uuid, String name, String title, long nodeClass)	WizardNode	Crea un expediente usando un asistente (wizard).

Nota

El WizardNode contiene una lista de acciones pendientes que deben realizarse para completar el proceso de creación del expediente. Estas pueden ser:

• Añadir palabra clave
• Añadir categorías
• Añadir metadatos

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
createFromTemplate(String uuid, String dstPath, bool categories, bool keywords, bool notes, bool propertyGroups, bool security Dictionary<String, String> properties)	Record	Crea un nuevo expediente a partir de la plantilla y devuelve un objeto Record.

El parámetro uuid es el UUID de la plantilla del expediente.

El parámetro dstPath puede ser un path de carpeta o de expediente.

Cuando la plantilla usa grupos de metadatos para rellenar campos, estos valores son obligatorios y deben establecerse en el parámetro properties.

Nota

Encontrará más información sobre plantillas y metadatos en: Creating templates.

Nota

Adicionalmente:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
extendedCopy(String uuid, String dstId, String newName, bool categories, bool keywords, bool propertyGroups, bool notes, bool security)	Record	Copia un expediente junto con sus datos asociados a una carpeta u otro expediente.

El valor del parámetro dstId debe ser un UUID de carpeta o expediente.

Cuando el valor del parámetro newName es null, el expediente conservará el mismo nombre.

Nota

Por defecto, solo se copian los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. de la carpeta no se copian.

Adicionalmente:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.
• Cuando el parámetro security es true, se copiará el valor original de la seguridad.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
createMissingRecords(String recPath)	String	Crea los expedientes que falten.

Ejemplo:

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