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 expediente o de 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 los servicios web, 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.createRecord("ada67d44-b081-4b23-bdc1-74181cafbc5d", "PKI-100200", "new title", 0)

Métodos

createRecord

Descripción:

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

Precaución

Opcionalmente puede establecerse un título; el resto de variables del objeto Record (record) no tendrán ningún efecto en la creación del 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);
                ws.record.createRecord(fldId, "PKI-100200", "some title", 0);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRecordProperties

Descripción:

Método	Valores de retorno	Descripción
getRecordProperties(String recId)	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.getRecordProperties("50b7a5b9-89d2-430e-bbc9-6a6e01662a71").path);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteRecord

Descripción:

Método	Valores de retorno	Descripción
deleteRecord(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.deleteRecord("50b7a5b9-89d2-430e-bbc9-6a6e01662a71");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purgeRecord

Descripción:

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

Precaución

Cuando se purga un expediente, solo puede restaurarse desde una copia de seguridad anterior del repositorio. La acción de purgar elimina el expediente permanentemente del repositorio.

• Normalmente los expedientes se purgan a /okm:trash/userId - la ubicación personal de la papelera del usuario -, pero es posible purgar directamente cualquier expediente desde cualquier punto del repositorio.

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.purgeRecord("50b7a5b9-89d2-430e-bbc9-6a6e01662a71");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

renameRecord

Descripción:

Método	Valores de retorno	Descripción
renameRecord(String recId, 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.renameRecord("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "PKI-100201");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

moveRecord

Descripción:

Método	Valores de retorno	Descripción
moveRecord(String recId, String dstId)	void	Mueve un expediente a una carpeta o a otro 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.moveRecord("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "055e4384-7c70-4456-b32b-f5a55a79861f");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

copyRecord

Descripción:

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

Precaución

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

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente.
• Cuando el valor del parámetro newName es null, el expediente conservará el mismo nombre.

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.copyRecord("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "055e4384-7c70-4456-b32b-f5a55a79861f", "PKI-100200");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isValidRecord

Descripción:

Método	Valores de retorno	Descripción
isValidRecord(String recId)	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.isValidRecord("50b7a5b9-89d2-430e-bbc9-6a6e01662a71").ToString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRecordChildren

Descripción:

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

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.getRecordChildren("055e4384-7c70-4456-b32b-f5a55a79861f"))
                {
                    System.Console.WriteLine(rec);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setRecordTitle

Descripción:

Método	Valores de retorno	Descripción
setRecordTitle(String recId, 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.setRecordTitle("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "some title");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRecordPath

Descripción:

Método	Valores de retorno	Descripción
getRecordPath(String uuid)	String	Convierte un UUID de expediente en una ruta de 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.getRecordPath("50b7a5b9-89d2-430e-bbc9-6a6e01662a71"));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setRecordDescription

Descripción:

Método	Valores de retorno	Descripción
setRecordDescription(String recId, String description)	void	Establece la descripción 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);
                ws.record.setRecordDescription("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "some description");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createWizardRecord

Descripción:

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

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.createWizardRecord("f123a950-0329-4d62-8328-0ff500fd42db", "REC-001", "Any title", 0);                System.Console.WriteLine(wnode.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createRecordFromTemplate

Descripción:

Método	Valores de retorno	Descripción
createRecordFromTemplate(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 una plantilla y devuelve un objeto Record.

Nota

Para más información sobre plantillas y metadatos, consulte: 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.

• El parámetro uuid es el UUID de la plantilla del expediente.
• El dstPath puede ser una ruta 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.

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.createRecordFromTemplate("9fa9787e-d8b0-4ff7-905a-a89f0b228ec8", "/okm:root/test/dst", true, true, false, false, false, properties);
                }
                catch (Exception e)
                {
                    System.Console.WriteLine(e.ToString());
                }
           }
      }
}

extendedRecordCopy

Descripción:

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

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.

• Los valores del parámetro dstId deben ser el UUID de una carpeta o expediente.
• Cuando el valor del parámetro newName es null, el expediente conservará el mismo nombre.

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.extendedRecordCopy("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 faltantes.

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