Ir al contenido
Otras versiones

Cargando…

Node samples

Aspectos básicos

Sección titulada «Aspectos básicos»

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 usar todos los métodos de Node desde la clase “node”, tal y como se muestra a continuación:

Ventana de terminal
ws.node.getNodeByUuid("29a22996-0e3b-421e-8759-c24ea41c1ebb")

Métodos

Sección titulada «Métodos»

getVersionHistory

Sección titulada «getVersionHistory»

Descripción:

Método Valores de retorno Descripción
getVersionHistory(String uuid) List Devuelve una lista con el histórico de versiones de un documento.

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<Version> versions = ws.node.getVersionHistory("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

restoreVersion

Sección titulada «restoreVersion»

Descripción:

Método Valores de retorno Descripción
restoreVersion(String uuid, String versionName) void Restaura un documento a una versión específica.

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);
                ws.node.restoreVersion("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7","1.0");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteVersion

Sección titulada «deleteVersion»

Descripción:

Método Valores de retorno Descripción
deleteVersion(String uuid, String versionName) void Elimina una versión específica.

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);
                ws.node.deleteVersion("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7","1.0");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purgeVersionHistory

Sección titulada «purgeVersionHistory»

Descripción:

Método Valores de retorno Descripción
purgeVersionHistory(String uuid) void Purga el histórico de versiones de un documento.

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.node.purgeVersionHistory("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

subscribe

Sección titulada «subscribe»

Descripción:

Método Valores de retorno Descripción
subscribe(String uuid) void Añade una suscripción a un nodo.

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.node.subscribe("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

unsubscribe

Sección titulada «unsubscribe»

Descripción:

Método Valores de retorno Descripción
unsubscribe(String uuid) void Elimina una suscripción a un nodo.

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.node.unsubscribe("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

importZip

Sección titulada «importZip»

Descripción:

Método Valores de retorno Descripción
importZip(String uuid, FileStream content) void Importa un fichero zip.

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);                String folderId = "70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7";
                FileStream zipFile = new FileStream("D:\\Test.zip", FileMode.Open, FileAccess.Read);                ws.node.importZip(folderId, zipFile);                zipFile.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

exportZip

Sección titulada «exportZip»

Descripción:

Método Valores de retorno Descripción
exportZip(List uuids, bool withPath, bool background) Stream Exporta como fichero zip.

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);                List<string> uuids = new List<string>();                uuids.Add("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7");                uuids.Add("82555dd1-bcc2-4e64-81cb-5f7c2b0d7801");                // Get strem exportZip                Stream s = ws.node.exportZip(uuids, true, true);                // Save as zip file                FileStream zipFile = new FileStream("D:\\Testing\\Test.zip", FileMode.OpenOrCreate, FileAccess.ReadWrite);                s.CopyTo(zipFile);                zipFile.Close();                s.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

unZip

Sección titulada «unZip»

Descripción:

Método Valores de retorno Descripción
unZip(String uuid, String dstId) void Descomprime un fichero.

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);                String zipFileId = "82555dd1-bcc2-4e64-81cb-5f7c2b0d7801";                String folderId = "70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7";
                ws.node.unZip(zipFileId, folderId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNodeByUuid

Sección titulada «getNodeByUuid»

Descripción:

Método Valores de retorno Descripción
getNodeByUuid(String uuid) Node Obtiene un nodo por UUID.

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);
                Node node = ws.node.getNodeByUuid("82555dd1-bcc2-4e64-81cb-5f7c2b0d7801");                System.Console.WriteLine(node.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenNodesPaginated

Sección titulada «getChildrenNodesPaginated»

Descripción:

Método Valores de retorno Descripción
getChildrenNodesPaginated(String uuid, int offset, int limit, String filter, String orderByField, bool orderAsc, List filteredTypes) SimpleNodeBaseList Obtiene los nodos hijo paginados.

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);
                List<int> filteredTypes = new List<int>();                filteredTypes.Add(1);                String folderId = "82555dd1-bcc2-4e64-81cb-5f7c2b0d7801";                ChildNodeList nodeList = ws.node.getChildrenNodesPaginated(folderId, 0, 10, "", NodesPaginationInfo.ORDER_BY_NAME, true, filteredTypes);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenNodesPaginated

Sección titulada «getChildrenNodesPaginated»

Descripción:

Método Valores de retorno Descripción
getChildrenNodesPaginated(String uuid, int offset, int limit, String filter, String orderByField, bool orderAsc, List filteredTypes,  String pluginName) SimpleNodeBaseList Obtiene los nodos hijos de forma paginada.

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);
                List<int> filteredTypes = new List<int>();                filteredTypes.Add(1);                String folderId = "82555dd1-bcc2-4e64-81cb-5f7c2b0d7801";                ChildNodeList nodeList = ws.node.getChildrenNodesPaginated(folderId, 0, 10, "", NodesPaginationInfo.ORDER_BY_NAME, true, filteredTypes, "");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenNodesByCategoryPaginated

Sección titulada «getChildrenNodesByCategoryPaginated»

Descripción:

Método Valores de retorno Descripción
getChildrenNodesByCategoryPaginated(String uuid, int offset, int limit, String filter, String orderByField, bool orderAsc, List filteredTypes) SimpleNodeBaseList Obtiene los nodos hijos de una categoría de forma paginada.
Los parámetros “limit” y “offset” permiten obtener solo una parte de los resultados de una consulta.
- El parámetro “limit” limita el número de resultados devueltos.
- El parámetro “offset” indica cuántos resultados se deben omitir antes de empezar a devolver resultados.
Por ejemplo, si su consulta tiene 1000 resultados pero solo quiere devolver los primeros 10, debe usar estos valores:
- limit=10
- offset=0
Si ahora quiere mostrar los resultados del 11 al 20, debe usar estos valores:
- limit=10
- offset=10

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);
                List<int> filteredTypes = new List<int>();                filteredTypes.Add(1);                String folderId = "82555dd1-bcc2-4e64-81cb-5f7c2b0d7801";                ChildNodeList nodeList = ws.node.getChildrenNodesByCategoryPaginated(folderId, 0, 10, "", NodesPaginationInfo.ORDER_BY_NAME, true, filteredTypes);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenNodesByCategoryPaginated

Sección titulada «getChildrenNodesByCategoryPaginated»

Descripción:

Método Valores de retorno Descripción
getChildrenNodesByCategoryPaginated(String uuid, int offset, int limit, String filter, String orderByField, bool orderAsc, List filteredTypes, String pluginName) SimpleNodeBaseList Obtiene los nodos hijos de una categoría de forma paginada.
Los parámetros “limit” y “offset” permiten obtener solo una parte de los resultados de una consulta.
- El parámetro “limit” limita el número de resultados devueltos.
- El parámetro “offset” indica cuántos resultados se deben omitir antes de empezar a devolver resultados.
Por ejemplo, si su consulta tiene 1000 resultados pero solo quiere devolver los primeros 10, debe usar estos valores:
- limit=10
- offset=0
Si ahora quiere mostrar los resultados del 11 al 20, debe usar estos valores:
- limit=10
- offset=10

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);
                List<int> filteredTypes = new List<int>();                filteredTypes.Add(1);                String folderId = "82555dd1-bcc2-4e64-81cb-5f7c2b0d7801";                ChildNodeList nodeList = ws.node.getChildrenNodesByCategoryPaginated(folderId, 0, 10, "", NodesPaginationInfo.ORDER_BY_NAME, true, filteredTypes, "");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getBreadcrumb

Sección titulada «getBreadcrumb»

Descripción:

Método Valores de retorno Descripción
getBreadcrumb(String uuid) List Obtiene la ruta de navegación (breadcrumb).

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);                String folderId = "82555dd1-bcc2-4e64-81cb-5f7c2b0d7801";                List<BreadCrumbItem> list = ws.node.getBreadcrumb(folderId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNodesFiltered

Sección titulada «getNodesFiltered»

Descripción:

Método Valores de retorno Descripción
getNodesFiltered(List uuids) List Devuelve una lista de nodos.

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);                List<string> uuids = new List<string>();                uuids.Add("82555dd1-bcc2-4e64-81cb-5f7c2b0d7801");                List<Node> nodes = ws.node.getNodesFiltered(uuids);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

evaluateDownloadZip

Sección titulada «evaluateDownloadZip»

Descripción:

Método Valores de retorno Descripción
evaluateDownloadZip(List uuids) ZipDownloadEvaluationResult Devuelve un objeto ZipDownloadEvaluationResult.

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);                List<string> uuids = new List<string>();                uuids.Add("82555dd1-bcc2-4e64-81cb-5f7c2b0d7801");                ZipDownloadEvaluationResult zdeResult = ws.node.evaluateDownloadZip(uuids);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

restore

Sección titulada «restore»

Descripción:

Método Valores de retorno Descripción
restore(String uuid) Node Restaura un nodo.

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);                Node node = ws.node.restore("0f6463f3-4d36-4091-b518-4fe7c353ee70");                System.Console.WriteLine(node.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

hasNodesLockedByOtherUser

Sección titulada «hasNodesLockedByOtherUser»

Descripción:

Método Valores de retorno Descripción
hasNodesLockedByOtherUser(String uuid) bool Indica si el nodo está bloqueado por otros usuarios.

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);
                 if(ws.node.hasNodesLockedByOtherUser("1ec49da9-1746-4875-ae32-9281d7303a62"))
                 {
                    System.Console.Writeline("Is blocked");
                 }
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

setComment

Sección titulada «setComment»

Descripción:

Método Valores de retorno Descripción
setComment(String uuid, String versionName, String comment) void Establece el comentario de una versión específica de un nodo.

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);
                 ws.node.setComment("4b88cbe9-e73d-45fc-bac0-35e0d6e59e43", "1.5", "Update comment");
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}