Repository samples

Aspectos básicos

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 Repository desde la clase “repository”, tal y como se muestra a continuación:

ws.repository.getAppVersion();

Métodos

getRootFolder

Descripción:

Método	Valores de retorno	Descripción
getRootFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:root”

Ejemplo:

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.impl;

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.repository.getRootFolder());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getTrashFolder

Descripción:

Método	Valores de retorno	Descripción
getTrashFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:trash/{userId}”

La carpeta devuelta será la papelera del usuario.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:trash/okmAdmin”.

Ejemplo:

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

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.repository.getTrashFolder());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getTrashFolderBase

Descripción:

Método	Valores de retorno	Descripción
getTrashFolderBase()	Folder	Devuelve el objeto Folder del nodo “/okm:trash”

Ejemplo:

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

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.repository.getTrashFolderBase());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getTemplatesFolder

Descripción:

Método	Valores de retorno	Descripción
getTemplatesFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:templates”

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.repository.getTemplatesFolder());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getPersonalFolder

Descripción:

Método	Valores de retorno	Descripción
getPersonalFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:personal/{userId}”

La carpeta devuelta será la carpeta personal del usuario.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:personal/okmAdmin”.

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.repository.getPersonalFolder());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getPersonalFolderBase

Descripción:

Método	Valores de retorno	Descripción
getPersonalFolderBase()	Folder	Devuelve el objeto Folder del nodo “/okm:personal”

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.repository.getPersonalFolderBase());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailFolder

Descripción:

Método	Valores de retorno	Descripción
getMailFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:mail/{userId}”

La carpeta devuelta será la carpeta de correo del usuario.

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la carpeta devuelta será “/okm:mail/okmAdmin”.

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.repository.getMailFolder());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailFolderBase

Descripción:

Método	Valores de retorno	Descripción
getMailFolderBase()	Folder	Devuelve el objeto Folder del nodo “/okm:mail”

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.repository.getMailFolderBase());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getCategoriesFolder

Descripción:

Método	Valores de retorno	Descripción
getCategoriesFolder()	Folder	Devuelve el objeto Folder del nodo “/okm:categories”

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.repository.getCategoriesFolder());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purgeTrash

Descripción:

Método	Valores de retorno	Descripción
purgeTrash()	void	Elimina permanentemente del repositorio todos los nodos de “/okm:trash/{userId}”

Nota

Por ejemplo, si el método lo ejecuta el usuario “okmAdmin”, la papelera purgada será “/okm:trash/okmAdmin”.

Precaución

Cuando un nodo se purga, solo puede restaurarse a partir de una copia de seguridad anterior del repositorio. La acción de purgar elimina el nodo de forma permanente 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.repository.purgeTrash();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUpdateMessage

Descripción:

Método	Valores de retorno	Descripción
getUpdateMessage()	String	Recupera un mensaje cuando hay disponible una nueva versión de OpenKM.

Existe un servicio oficial de mensajes de actualización de OpenKM que se basa en su versión local de OpenKM.

Nota

El mensaje más común es que se ha publicado una nueva versión de OpenKM.

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

            try
            {
               ws.login(user, password);
               System.Console.WriteLine(ws.repository.getUpdateMessage());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRepositoryUuid

Descripción:

Método	Valores de retorno	Descripción
getRepositoryUuid()	String	Recupera el identificador único de la instalació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);
                 System.Console.WriteLine(ws.repository.getRepositoryUuid());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

hasNode

Descripción:

Método	Valores de retorno	Descripción
hasNode(String nodeId)	Boolean	Devuelve un booleano que indica si un nodo existe.

El valor del parámetro nodeId puede ser un UUID o una ruta válidos.

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("Exists node:" + ws.repository.hasNode("064ff51a-b815-4f48-a096-b4946876784f"));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNodePath

Descripción:

Método	Valores de retorno	Descripción
getNodePath(String uuid)	String	Convierte un UUID de nodo en su ruta.

Ejemplo:

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

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.repository.getNodePath("e339f14b-4d3a-489c-91d3-05e4575709d2"));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNodeUuid

Descripción:

Método	Valores de retorno	Descripción
getNodeUuid(String path)	String	Convierte una ruta de nodo en un UUID.

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.repository.getNodeUuid("/okm:root/tmp"));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getAppVersion

Descripción:

Método	Valores de retorno	Descripción
getAppVersion()	AppVersion	Devuelve información sobre la versión de OpenKM.

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.repository.getAppVersion().toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

copyAttributes

Descripción:

Método	Valores de retorno	Descripción
copyAttributes(String uuid, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes)	void	Copia atributos de un nodo a otro.

El valor del parámetro dstId debe ser un UUID o una ruta de nodo.

Nota

• Cuando el parámetro categories 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.

Ejemplo:

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

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

executeScript

Descripción:

Método	Valores de retorno	Descripción
executeScript(FileStream fs)	ScriptExecutionResult	Ejecuta un script.

El script local - test.bsh - usado en el ejemplo de abajo:

import com.openkm.api.OKMFolder;
import com.openkm.bean.Folder;
import com.openkm.util.ContextWrapper;

try {
      OKMFolder okmFolder = ContextWrapper.getContext().getBean(OKMFolder.class);
      for (Folder fld : okmFolder.getChildren(null, "/okm:root")) {
         print(fld.getPath() + "\n");
      }
} catch (Exception e) {
e.printStackTrace();
}

// Some value can also be returned as string
return "test result";

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

Ejemplo:

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

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);
                FileStream fs = new FileStream("E:\\test.bsh", FileMode.Open);
                ScriptExecutionResult result = ws.repository.executeScript(fs);
                System.Console.WriteLine(result.result);
                System.Console.WriteLine(result.stdout);

                if (!result.stderr.Equals(""))
                {
                    System.Console.WriteLine("Error happened");
                    System.Console.WriteLine(result.stderr);
                }

                fs.Dispose();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

executeScript

Descripción:

Método	Valores de retorno	Descripción
executeScript(String script)	ScriptExecutionResult	Ejecuta un script.

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

Ejemplo:

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

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                String script = "import com.openkm.util.ContextWrapper;"
                            + " import org.springframework.web.context.WebApplicationContext;"
                            + " import com.openkm.api.OKMFolder;"
                            + " import com.openkm.bean.Folder;"
                            + " WebApplicationContext cc = (WebApplicationContext) ContextWrapper.getContext();"
                            + " OKMFolder okmFolder = cc.getBean(OKMFolder.class);"
                            + " for (Folder fld : okmFolder.getChildren(null,\"/okm:root\")) {"
                            + " print(fld.getPath());"
                            + "}";
                ScriptExecutionResult result = ws.repository.executeScript(script);
                Console.WriteLine(result.result);
                Console.WriteLine(result.stdout);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

executeSqlQuery

Descripción:

Método	Valores de retorno	Descripción
executeSqlQuery(FileStream fs)	SqlQueryResults	Ejecuta sentencias SQL.

El script test.sql usado en el ejemplo de abajo:

SELECT NBS_UUID, NBS_NAME FROM OKM_NODE_BASE LIMIT 10;

Precaución

El script SQL solo puede contener una única sentencia SQL.

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

Ejemplo:

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

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);
                FileStream fs = new FileStream("E:\\test.sql", FileMode.Open);
                SqlQueryResults result = ws.repository.executeSqlQuery(fs);
                fs.Dispose();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

executeSqlQuery

Descripción:

Método	Valores de retorno	Descripción
executeSqlQuery(String sql)	SqlQueryResults	Ejecuta sentencias SQL.

Precaución

El script SQL solo puede contener una única sentencia SQL.

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

Ejemplo:

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

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);
                SqlQueryResults result = ws.repository.executeSqlQuery("SELECT NBS_UUID, NBS_CONTEXT, NBS_NAME FROM OKM_NODE_BASE;");
                foreach (SqlQueryResultColumns columns in result.sqlQueryResults)
                {
                    Console.WriteLine("UUID:" + columns.sqlQueryResultColumns[0]);
                    Console.WriteLine("Context:" + columns.sqlQueryResultColumns[1]);
                    Console.WriteLine("Name:" + columns.sqlQueryResultColumns[2]);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

executeHqlQuery

Descripción:

Método	Valores de retorno	Descripción
executeHqlQuery(FileStream fs)	HqlQueryResults	Ejecuta sentencias HQL.

El script test.sql usado en el ejemplo de abajo:

SELECT uuid, name from NodeBase where name = 'okm:root';

Precaución

El script HQL solo puede contener una única sentencia HQL.

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.impl;
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);

            try
            {
                 ws.login(user, password);
     FileStream fs = new FileStream(@"C:\Desktop\test.sql", FileMode.Open);
HqlQueryResults result = ws.repository.executeHqlQuery(fs);
                 fs.Dispose();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

executeHqlQuery

Descripción:

Método	Valores de retorno	Descripción
executeHqlQuery(String hql)	HqlQueryResults	Ejecuta sentencias HQL.

Precaución

El script HQL solo puede contener una única sentencia HQL.

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.impl;
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);

            try
            {
                 ws.login(user, password);
     HqlQueryResults result = ws.repository.executeHqlQuery("SELECT uuid, name from NodeBase where name = 'okm:root';");
                 foreach (HqlQueryResultColumns row in result.hqlQueryResults)
                 {
                      Console.WriteLine("uuid: " + row.hqlQueryResultColumns[0] + ", name: " + row.hqlQueryResultColumns[1]);
                 }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getTranslations

Descripción:

Método	Valores de retorno	Descripción
getTranslations(String lang, String module)	Dictionary<String, String>	Recupera las traducciones de un módulo como un mapa de valores

Nota

Las tablas de traducciones de OpenKM pueden usarse para recuperar las traducciones actuales de OpenKM o para crear sus propias traducciones (insertando valores en el nuevo módulo).

Por defecto, los valores de módulo son:

• frontend (usado por la interfaz por defecto de OpenKM).
• extension (usado por la interfaz de extensión de OpenKM).
• mobile (usado por la interfaz móvil de OpenKM).

Ejemplo para añadir un nuevo módulo de traducción:

Sentencias SQL que deben ejecutarse desde la vista Database query:

DELETE FROM OKM_TRANSLATION WHERE TR_LANGUAGE='en-GB' and TR_MODULE='doc';
INSERT INTO OKM_TRANSLATION (TR_MODULE, TR_KEY, TR_TEXT, TR_LANGUAGE) VALUES ('doc', 'document.generator.title','Document generator', 'en-GB');
INSERT INTO OKM_TRANSLATION (TR_MODULE, TR_KEY, TR_TEXT, TR_LANGUAGE) VALUES ('doc', 'document.generator.logout','Logout', 'en-GB');

El código quedaría entonces así:

Dictionary<String, String> translations = ws.repository.getTranslations("en-GB", "doc");

Ejemplo:

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

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>translations = ws.repository.getTranslations("en-GB", "frontend");
                foreach (KeyValuePair<string, string> kvp in translations)
                {
                    Console.WriteLine("key:{0},with translation:{1}", kvp.Key, kvp.Value);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getConfiguration

Descripción:

Método	Valores de retorno	Descripción
getConfiguration(String key)	Configuration	Recupera el valor de un parámetro de configuración.

Peligro

Si su versión de OpenKM tiene el parámetro de configuración llamado “webservices.visible.properties”, el acceso a los parámetros de configuración quedará restringido para los usuarios no administradores. Eso significa que cualquier usuario no administrador que intente acceder, a través de los servicios web, a parámetros de configuración no incluidos en la lista de valores de “webservices.visible.properties”, recibirá una excepción de acceso denegado.

Ejemplo:

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.impl;

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);
                Configuration configuration = ws.repository.getConfiguration("system.ocr");
                System.Console.WriteLine(configuration.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChangeLog

Descripción:

Método	Valores de retorno	Descripción
getChangeLog(String nodePath, DateTime modificationsFrom)	List	Devuelve la lista de cambios en una ruta y sus subcarpetas.

Consejo

• El método lo usa la aplicación de sincronización de escritorio para recuperar cambios.

Ejemplo:

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.impl;

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);
                List<ChangeLogged> changeLoggedList = ws.repository.getChangeLog("/okm:root/test", DateTime.Now);
                foreach (var cl in changeLoggedList)
                {
                    System.Console.WriteLine(cl.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getServerTime()

Descripción:

Método	Valores de retorno	Descripción
getServerTime()	String	Devuelve la hora actual del servidor.

Nota

La hora del servidor devuelta está en formato ISO 8601.

Consejo

El método lo usa la aplicación de sincronización de escritorio para recuperar cambios.

Ejemplo:

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

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.repository.getServerTime());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getAvailableLocales

Descripción:

Método	Valores de retorno	Descripción
getAvailableLocales(String locale)	Dictionary<String, String>	Devuelve los idiomas disponibles.

Ejemplo:

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

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> locales = ws.repository.getAvailableLocales("en-GB");
                 foreach(KeyValuePair<String, String> local in locales)
                 {
                     Console.WriteLine("Language:" + local.Key + "," + local.Value);
                 }
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
         }
     }
}

getLicenseInfo

Descripción:

Método	Valores de retorno	Descripción
getLicenseInfo()	LicenseInfo	Devuelve información sobre la licencia.

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);
                 Console.WriteLine(ws.repository.getLicenseInfo().toString());
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
         }
     }
}

getClusterUuid

Descripción:

Método	Valores de retorno	Descripción
getClusterUuid()	String	Devuelve el UUID del clúster.

Ejemplo:

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

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);
                 Console.WriteLine("Cluster UUID =" + ws.repository.getClusterUuid());
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
         }
     }
}

getIsFilePlan

Descripción:

Método	Valores de retorno	Descripción
getIsFilePlan()	bool	True cuando el modo filePlan está activo.

Ejemplo:

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

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);
                 Console.WriteLine("FilePlan= " + ws.repository.getIsFilePlan().ToString());
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
         }
     }
}

createShortenUrl

Descripción:

Método	Valores de retorno	Descripción
createShortenUrl(String name, String url)	String	Crea una URL acortada. El parámetro name es opcional (se genera automáticamente si es null). Devuelve la URL acortada.

Ejemplo:

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

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 String shortenUrl = ws.repository.createShortenUrl(null, "https://www.example.com/very/long/url");
                 Console.WriteLine("shortenUrl");
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
         }
     }
}