Ir al contenido
Otras versiones

Cargando…

Search samples

Aspectos básicos

Sección titulada «Aspectos básicos»

La mayoría de los métodos usan QueryParams. Aquí tiene algunos consejos sobre cómo usarlos.

Variables Tipo Permite comodines Restricciones Descripción
domain long No. Valores disponibles:
- QueryParams.DOCUMENT
- QueryParams.FOLDER
- QueryParams.MAIL
- QueryParams.RECORD
Por defecto, el valor es QueryParams.DOCUMENT.
Para buscar documentos y carpetas, use el valor:
<br>(QueryParams.DOCUMENT | QueryParams.FOLDER) <br>		 Restringe la búsqueda a un tipo de nodo.
author String No. El valor debe ser un ID de usuario válido. Filtra por el usuario creador.
name String Sí. Filtra por el nombre del nodo.
title String Sí. Filtra por título.
keywords List Sí. Filtra por palabras clave.
categories List No. Los valores deben ser UUIDs de categoría; no use valores de ruta. Filtra por categorías.
content Sí. Filtra por contenido binario.
mimeType No. El valor debe ser un tipo MIME válido y registrado.
Solo se aplica a nodos de tipo documento.		 Filtra por el tipo MIME del documento.
language No. El valor debe ser un idioma válido.
Solo se aplica a nodos de tipo documento.		 Filtra por el idioma del documento.
folder No. Cuando está vacío, se usa por defecto el nodo “/okm:root”.
El valor debe ser un UUID válido; no use un valor de ruta.		 Filtra por una carpeta.
folderRecursive Boolean No. Solo tiene sentido establecer esta variable a true cuando la variable folder no está vacía. Activa el filtrado recursivo por una carpeta.
lastModifiedFrom Calendar No. Filtra por nodos creados después de una fecha.
lastModifiedTo Calendar No. Filtra por nodos creados antes de una fecha.
mailSubject String Sí. Solo se aplica a nodos de tipo correo. Filtra por el campo asunto del correo.
mailFrom String Sí. Solo se aplica a nodos de tipo correo. Filtra por el campo From del correo.
mailTo Sí. Solo se aplica a nodos de tipo correo. Filtra por el campo To del correo.
notes Sí. Filtra por notas.
properties Dictionary<String, String> Sí, en la mayoría de los casos. Los comodines no pueden aplicarse a valores de campos de metadatos como “date”.
El diccionario de propiedades se compone de pares:
(‘nombre_campo_metadatos’,‘valor_campo_metadatos’)
Por ejemplo:
<br>Dictionary<String, String> properties = new Dictionary<String, String>();<br>properties.Add("okp:consulting.name", "name value")<br>
 Filtrando por un rango de fechas:
<br> DateTime date = DateTime.Now;// today<br> DateTime to = new DateTime(date.Year, date.Month, date.Day, date.Hour, date.Minute, date.Second, date.Millisecond); <br> DateTime from = to.AddDays(-3);// three days before<br> Dictionary<String,String> properties = new Dictionary<String,String>();<br> properties.Add("okp:consulting.date", ISO8601.formatBasic(from)+","+ISO8601.formatBasic(to));<br>
Al filtrar por un rango de fechas, debe establecer ambos valores (from y to); de lo contrario, OpenKM ignorará el filtro.
 Para filtrar por un campo de metadatos de tipo “multiple” como este:
<br><select label="Multiple" name="okp:consulting.multiple" type="multiple"><br> <option label="One" value="one"/><br> <option label="Two" value="two"/><br> <option label="Three" value="three" /><br></select><br>
 Debe hacer:
<br>properties.Add("okp:consulting.multiple", "one;two");<br>
 Donde “one” y “two” son valores válidos, y el carácter “;” se usa como separador.		 Filtra por valores de un grupo de metadatos.

Ejemplos de comodines:

Variable Ejemplo Descripción
name test*.html Cualquier documento que empiece por los caracteres “test” y termine por los caracteres “.html”
name test?.html Cualquier documento que empiece por los caracteres “test” seguidos de un único carácter y termine por los caracteres “.html”
name ?test* Cualquier documento en el que el primer carácter no importa, pero va seguido de los caracteres “test”.

Ejemplo de código sugerido

Sección titulada «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);

Llegados a este punto puede utilizar todos los métodos de Search desde la clase “search” como se muestra a continuación:

ws.search.find(qParams, null)

Métodos

Sección titulada «Métodos»

find

Sección titulada «find»

Descripción:

Método Valores de retorno Descripción
find(QueryParams queryParams, String propertiesPlugin) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

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);
                QueryParams qParams = new QueryParams();
                qParams.domain = QueryParams.DOCUMENT;
                qParams.name = "test*.html";
                foreach (QueryResult qr in ws.search.find(qParams, null))
                {
                    System.Console.WriteLine(qr);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

find

Sección titulada «find»

Descripción:

Método Valores de retorno Descripción
find(QueryParams queryParams, String sortField, bool sortReverse, String propertiesPlugin) List Devuelve una lista de resultados filtrados por los valores del parámetro queryParams.

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);
                QueryParams _params = new QueryParams();                _params.domain = QueryParams.DOCUMENT + QueryParams.FOLDER;                _params.name = "test*";                foreach (QueryResult qr in ws.search.find(_params, SearchSortField.LAST_MODIFIED, true, null))                {                     Console.WriteLine(qr.toString());                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findPaginated

Sección titulada «findPaginated»

Descripción:

Método Valores de retorno Descripción
findPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro queryParams.

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);
                QueryParams qParams = new QueryParams();
                qParams.domain = QueryParams.DOCUMENT;
                qParams.name = "test*.html";
                ResultSet rs = ws.search.findPaginated(qParams, 0, 10, null);
                System.Console.WriteLine("Total results:" + rs.total);


                foreach (QueryResult qr in rs.results)
                {
                    System.Console.WriteLine(qr);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findPaginated

Sección titulada «findPaginated»

Descripción:

Método Valores de retorno Descripción
findPaginated(QueryParams queryParams, String sortField, bool sortReverse, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro queryParams.

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);
                QueryParams qParams = new QueryParams();
                qParams.domain = QueryParams.DOCUMENT + QueryParams.FOLDER;
                qParams.name = "test*";
                ResultSet rs = ws.search.findPaginated(params, SearchSortField.LAST_MODIFIED, true, 20, 10, null);
                System.Console.WriteLine("Total results:" + rs.total);


                foreach (QueryResult qr in rs.results)
                {
                    System.Console.WriteLine(qr);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findSimpleNodeBasePaginated

Sección titulada «findSimpleNodeBasePaginated»

Descripción:

Método Valores de retorno Descripción
findSimpleNodeBasePaginated(QueryParams queryParams, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados de tipo SimpleNodeBase filtrados por los valores del parámetro queryParams.

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);
                QueryParams qParams = new QueryParams();
                qParams.domain = QueryParams.DOCUMENT;
                qParams.name = "test*";
                SimpleNodeBaseResultSet snbrs = ws.search.findSimpleNodeBasePaginated(qp, 0, 10);
                System.Console.WriteLine("Total results:" + snbrs.total);


                foreach (SimpleNodeBase snb in snbrs.results)
                {
                    System.Console.WriteLine(snb.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findSimpleNodeBasePaginated

Sección titulada «findSimpleNodeBasePaginated»

Descripción:

Método Valores de retorno Descripción
findSimpleNodeBasePaginated(QueryParams queryParams, String sortField, boolean sortReverse, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados de tipo SimpleNodeBase filtrados por los valores del parámetro queryParams.

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);
                QueryParams qParams = new QueryParams();
                qParams.domain = QueryParams.DOCUMENT;
                qParams.name = "test*";
                SimpleNodeBaseResultSet snbrs = ws.search.findSimpleNodeBasePaginated(params, SearchSortField.AUTHOR, true, 0, 10);
                System.Console.WriteLine("Total results:" + snbrs.total);


                foreach (SimpleNodeBase snb in snbrs.results)
                {
                    System.Console.WriteLine(snb.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getKeywordMap

Sección titulada «getKeywordMap»

Descripción:

Método Valores de retorno Descripción
getKeywordMap(String[] filter) Dictionary<String, int> Devuelve un mapa de palabras clave con su contador, filtrado por otras palabras clave.

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);
                // All keywords without filtering
                System.Console.WriteLine("Without filtering");
                Dictionary<String, int> keywords = ws.search.getKeywordMap(new String[]{"test", "test2"});
                foreach (KeyValuePair<string,int> kvp in keywords)
                {
                     System.Console.WriteLine(kvp.Key + " is used :" + kvp.Value);
                }
                // Keywords filtered
                System.Console.WriteLine("Filtering");
                keywords = ws.search.getKeywordMap(new String[]{"test"});
                foreach (KeyValuePair<string,int> kvp in keywords)
                {
                    System.Console.WriteLine(kvp.Key + " is used :" + kvp.Value);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getCategorizedDocuments

Sección titulada «getCategorizedDocuments»

Descripción:

Método Valores de retorno Descripción
getCategorizedDocuments(String categoryId) List Recupera una lista de todos los documentos relacionados con una categoría.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                foreach (Document doc in ws.search.getCategorizedDocuments("50b7a5b9-89d2-430e-bbc9-6a6e01662a71"))
                {
                     System.Console.WriteLine(doc);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

saveSearch

Sección titulada «saveSearch»

Descripción:

Método Valores de retorno Descripción
saveSearch(QueryParams params) Long Guarda parámetros de búsqueda.

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);
                QueryParams qParams = new QueryParams();
                qParams.domain = QueryParams.DOCUMENT;
                qParams.name = "test*.html";
                foreach (QueryResult qr in ws.search.find(qParams))
                {
                    System.Console.WriteLine(qr);
                }
                // Save the search to be used later
                qParams.queryName = "sample search";
                ws.search.saveSearch(qParams);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateSearch

Sección titulada «updateSearch»

Descripción:

Método Valores de retorno Descripción
updateSearch(QueryParams params) void Actualiza unos parámetros de búsqueda guardados previamente.

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 (QueryParams qParams in ws.search.getAllSearchs())
                {
                    if (qParams.queryName.Equals("sample search"))
                    {
                        // Change some value.
                        qParams.name = "admin*.html";
                        ws.search.updateSearch(qParams);
                    }
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getSearch

Sección titulada «getSearch»

Descripción:

Método Valores de retorno Descripción
getSearch(int qpId) QueryParams Obtiene los parámetros de las búsquedas guardadas.

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);
                int qpId = 1; // Some valid search id
                QueryParams qParams = ws.search.getSearch(qpId);
                System.Console.WriteLine(qParams);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getAllSearchs

Sección titulada «getAllSearchs»

Descripción:

Método Valores de retorno Descripción
getAllSearchs() List Recupera una lista de todos los parámetros de búsqueda guardados.

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 (QueryParams qParams in ws.search.getAllSearchs())
                {
                    System.Console.WriteLine(qParams.queryName);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteSearch

Sección titulada «deleteSearch»

Descripción:

Método Valores de retorno Descripción
deleteSearch(int qpId) void Elimina unos parámetros de búsqueda guardados.

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);
                int qpId = 1; // Some valid search id
                ws.search.deleteSearch(qpId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findByQueryPaginated

Sección titulada «findByQueryPaginated»

Descripción:

Método Valores de retorno Descripción
findByQueryPaginated(String query, String sortField, boolean sortReverse, int offset, int limit, String propertiesPlugin) ResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro query.

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);
                 ResultSet rs = ws.search.findByQueryPaginated("text:grial AND name:t*.pdf", SearchSortField.NAME, true, 0, 10, null);                 Console.WriteLine("Total results:" + rs.total.ToString());                 foreach (QueryResult qr in rs.results)                 {                     Console.WriteLine(qr.toString());                 }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findSimpleNodeBaseByQueryPaginated

Sección titulada «findSimpleNodeBaseByQueryPaginated»

Descripción:

Método Valores de retorno Descripción
findSimpleNodeBaseByQueryPaginated(String query, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista de resultados paginados filtrados por los valores del parámetro query.

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);
                 SimpleNodeBaseResultSet snbr = ws.search.findSimpleNodeBaseByQueryPaginated("text:grial AND name:t*.pdF", 0, 10);                 foreach (SimpleNodeBase nodeBase in snbr.results)                 {                     if(nodeBase != null)                     {                         System.Console.WriteLine(nodeBase.toString());                     }                 }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findSimpleNodeBaseByQueryPaginated

Sección titulada «findSimpleNodeBaseByQueryPaginated»

Descripción:

Método Valores de retorno Descripción
findSimpleNodeBaseByQueryPaginated(String query, String sortField, bool sortReverse, int offset, int limit) SimpleNodeBaseResultSet Devuelve una lista paginada de resultados filtrados por los valores del parámetro query.

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);                 SimpleNodeBaseResultSet snbr= ws.search.findSimpleNodeBaseByQueryPaginated("text:grial AND name:t*.pdF", SearchSortField.NAME, true, 0, 10);                 foreach (SimpleNodeBase nodeBase in snbr.results)                 {                     if(nodeBase != null)                     {                         System.Console.WriteLine(nodeBase.toString());                     }                 }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findByQuery

Sección titulada «findByQuery»

Descripción:

Método Valores de retorno Descripción
findByQuery(String query, String propertiesPlugin) List Devuelve una lista de resultados filtrados por los valores del parámetro query.

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 (QueryResult qr in ws.search.findByQuery("keyword:test AND name:t*.pdf", null))
                {
                    System.Console.WriteLine(qr);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findByQuery

Sección titulada «findByQuery»

Descripción:

Método Valores de retorno Descripción
findByQuery(String query, String sortField, bool sortReverse, String propertiesPlugin) List Devuelve una lista de resultados filtrados por el parámetro query.

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 (QueryResult qr in ws.search.findByQuery("keyword: test", SearchSortField.NAME, true, null))
                {
                    System.Console.WriteLine(qr);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findWithMetadata

Sección titulada «findWithMetadata»

Descripción:

Método Valores de retorno Descripción
findWithMetadata(QueryParams _params, String propertiesPlugin, List groups) List Devuelve una lista de resultados con valores de metadatos filtrados por el parámetro queryParams.

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);                // QueryParams                QueryParams qp = new QueryParams();                qp.folderRecursive = true;                qp.domain = QueryParams.DOCUMENT | QueryParams.FOLDER | QueryParams.RECORD | QueryParams.MAIL;                qp.name = "test*";                // Properties                Dictionary<string, string> properties = new Dictionary<string, string>();                properties.Add("okp:consulting.name", "test");                qp.properties = properties;                // Groups                List<string> groups = new List<string>();                groups.Add("okg:consulting");                List<QueryResult> queryResults = ws.search.findWithMetadata(qp, null, groups);                foreach (QueryResult qResult in queryResults)                {                    System.Console.WriteLine(qResult.toString());                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findWithMetadata

Sección titulada «findWithMetadata»

Descripción:

Método Valores de retorno Descripción
findWithMetadata(QueryParams queryParams, String sortField, bool sortReverse, String propertiesPlugin, List groups) List Devuelve una lista de resultados con valores de metadatos filtrados por el parámetro queryParams.

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);                // QueryParams                QueryParams qp = new QueryParams();                qp.folderRecursive = true;                qp.domain = QueryParams.DOCUMENT | QueryParams.FOLDER | QueryParams.RECORD | QueryParams.MAIL;                qp.name = "test*";                // Properties                Dictionary<string, string> properties = new Dictionary<string, string>();                properties.Add("okp:consulting.name", "test");                qp.properties = properties;                // Groups                List<string> groups = new List<string>();                groups.Add("okg:consulting");                List<QueryResult> queryResults = ws.search.findWithMetadata(qp, SearchSortField.NAME, true, null, groups);                foreach (QueryResult qr in queryResults)                {                    Console.WriteLine(qr.toString());                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findWithMetadataPaginated

Sección titulada «findWithMetadataPaginated»

Descripción:

Método Valores de retorno Descripción
findWithMetadataPaginated(QueryParams queryParams, int offset, int limit, String propertiesPlugin, List groups) ResultSet Devuelve una lista de resultados paginados con valores de metadatos filtrados por el parámetro queryParams.

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);                // QueryParams                QueryParams qp = new QueryParams();                qp.domain = QueryParams.DOCUMENT | QueryParams.FOLDER | QueryParams.RECORD | QueryParams.MAIL;                qp.name = "test*";                // Properties                Dictionary<string, string> properties = new Dictionary<string, string>();                properties.Add("okp:consulting.name", "test");                qp.properties = properties;                // Groups                List<string> groups = new List<string>();                groups.Add("okg:consulting");                ResultSet resulSet = ws.search.findWithMetadataPaginated(qp, 0, 10, null, groups);                System.Console.WriteLine("Total results: " + rs.total.ToString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findWithMetadataPaginated

Sección titulada «findWithMetadataPaginated»

Descripción:

Método Valores de retorno Descripción
findWithMetadataPaginated(QueryParams queryParams, String sortField, bool sortReverse, int offset, int limit, String propertiesPlugin, List groups) ResultSet Devuelve una lista paginada de resultados con valores de metadatos filtrados por el parámetro queryParams.

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);                // QueryParams                QueryParams qp = new QueryParams();                qp.domain = QueryParams.DOCUMENT | QueryParams.FOLDER | QueryParams.RECORD | QueryParams.MAIL;                qp.name = "test*";                // Properties                Dictionary<string, string> properties = new Dictionary<string, string>();                properties.Add("okp:consulting.name", "test");                qp.properties = properties;                // Groups                List<string> groups = new List<string>();                groups.Add("okg:consulting");                ResultSet rs = ws.search.findWithMetadataPaginated(qp, SearchSortField.AUTHOR, true, 0, 10, null, groups);                Console.WriteLine("Total results: " + rs.total.ToString());                foreach (QueryResult qr in rs.results)                {                    Console.WriteLine(qr.toString());                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMimeTypes

Sección titulada «getMimeTypes»

Descripción:

Método Valores de retorno Descripción
getMimeTypes() List Recupera una lista de tipos MIME.

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 (MimeType mimeType in ws.search.getMimeTypes())                {                    System.Console.WriteLine(mimeType.toString());                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

csvExport

Sección titulada «csvExport»

Descripción:

Método Valores de retorno Descripción
csvExport(String lang, QueryParams queryParams, bool compact) InputStream Exporta una lista de resultados como fichero CSV filtrada por los valores del parámetro queryParams.
  • El parámetro lang debe cumplir con ISO 639-1.

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);                QueryParams _params = new QueryParams();                _params.domain = QueryParams.DOCUMENT + QueryParams.FOLDER;                _params.name = "test*";                Stream stream = ws.search.csvExport("es-ES", _params, false);                FileStream destFile = new FileStream("C:\\Testing\\export.csv", FileMode.OpenOrCreate);                stream.CopyTo(destFile);                destFile.Dispose();                stream.Dispose();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}