FilePlan samples

Básico

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 del servicio web “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en los servicios web, la sesión se mantiene en el objeto del servicio web. 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 FilePlan desde la clase “filePlan”, tal y como se muestra a continuación:

ws.filePlan.getRootSections();

Métodos

getRootSections

Descripción:

Método	Valores de retorno	Descripción
getRootSections()	List	Devuelve una lista de NodeClassSectionDefinition.

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);
                List<NodeClassSectionDefinition> results = ws.filePlan.getRootSections();
                foreach (NodeClassSectionDefinition ncsd in results)
                {
                     System.Console.WriteLine(ncsd.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRootSectionsFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
getRootSectionsFilteredBySecurity(int permissions)	List	Devuelve una lista de NodeClassSectionDefinition filtrada por permisos.

Nota

La clase com.openkm.sdk4csharp.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que modifican u obtienen permisos de seguridad.

Ejemplo:

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

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

            try
            {
                ws.login(user, password);
List<NodeClassSectionDefinition> results = ws.filePlan.getRootSectionsFilteredBySecurity(permissions);
                foreach (NodeClassSectionDefinition ncsd in results)
                {
                     System.Console.WriteLine(ncsd.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenSections

Descripción:

Método	Valores de retorno	Descripción
getChildrenSections(long parentId)	List	Devuelve una lista de NodeClassSectionDefinition filtrada por sección padre.

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);
                long parentId = 1;
                List<NodeClassSectionDefinition> results = ws.filePlan.getChildrenSections(parentId);
                foreach (NodeClassSectionDefinition ncsd in results)
                {
                     System.Console.WriteLine(ncsd.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenSectionsFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
getChildrenSectionsFilteredBySecurity(long parentId, int permissions)	List	Devuelve una lista de NodeClassSectionDefinition filtrada por sección padre y permisos.

Nota

La clase com.openkm.sdk4csharp.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que modifican u obtienen permisos de seguridad.

Ejemplo:

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

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

            try
            {
                ws.login(user, password);
                long parentId = 1;
                int permissions = Permission.ALL_GRANTS;
                List<NodeClassSectionDefinition> results = ws.filePlan.getChildrenSectionsFilteredBySecurity(parentId, permissions);
                foreach (NodeClassSectionDefinition ncsd in results)
                {
                     System.Console.WriteLine(ncsd.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenClasses

Descripción:

Método	Valores de retorno	Descripción
getChildrenClasses(long sectionId)	List	Devuelve una lista de NodeClass filtrada por sección.

Ejemplo:

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

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

            try
            {
                ws.login(user, password);
long sectionId = 1;
                List<NodeClass> results = ws.filePlan.getChildrenClasses(sectionId);
                foreach (NodeClass nc in results)
                {
                     System.Console.WriteLine(nc.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenClassesFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
getChildrenClassesFilteredBySecurity(long sectionId, int permissions)	List	Devuelve una lista de NodeClass filtrada por sección y permisos.

Nota

La clase com.openkm.sdk4csharp.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que modifican u obtienen permisos de seguridad.

Ejemplo:

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

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

            try
            {
                ws.login(user, password);
                long sectionId = 1;
                int permissions = Permission.ALL_GRANTS;
                List<NodeClass> results = ws.filePlan.getChildrenClassesFilteredBySecurity(sectionId, permissions);
                foreach (NodeClass nc in results)
                {
                     System.Console.WriteLine(nc.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findNodeClassByPk

Descripción:

Método	Valores de retorno	Descripción
findNodeClassByPk(long id)	NodeClass	Devuelve un NodeClass.

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);
                long id = 0;
                NodeClass nodeClass= ws.filePlan.findNodeClassByPk(id);
                System.Console.WriteLine(nodeClass.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findElectronicRecordClasses

Descripción:

Método	Valores de retorno	Descripción
findElectronicRecordClasses()	List	Devuelve una lista de NodeClass que son Electronic Records.

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);
                List<NodeClass> results = ws.filePlan.findElectronicRecordClasses();
                foreach (NodeClass nc in results)
                {
                     System.Console.WriteLine(nc.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findElectronicRecordClassesFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
findElectronicRecordClassesFilteredBySecurity(int permissions)	List	Devuelve una lista de NodeClass, filtrada por sección y permisos, que son Electronic Records.

Nota

La clase com.openkm.sdk4csharp.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que modifican u obtienen permisos de seguridad.

Ejemplo:

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

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

            try
            {
                ws.login(user, password);
                int permissions = Permission.ALL_GRANTS;
                List<NodeClass> results = ws.filePlan.findElectronicRecordClassesFilteredBySecurity(permissions);
                foreach (NodeClass nc in results)
                {
                     System.Console.WriteLine(nc.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findFilteredByCodeOrNameFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
findFilteredByCodeOrNameFilteredBySecurity(String code, String name, int permissions)	List	Devuelve una lista de NodeClass filtrada por código, nombre y permisos.

Nota

La clase com.openkm.sdk4csharp.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que modifican u obtienen permisos de seguridad.

Ejemplo:

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

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

            try
            {
                ws.login(user, password);
                String code = string.Empty;
                String name = "test";
                int permissions = Permission.ALL_GRANTS;
                List<NodeClass> results = ws.filePlan.findFilteredByCodeOrNameFilteredBySecurity(code, name, permissions);
                foreach (NodeClass nc in results)
                {
                     System.Console.WriteLine(nc.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findSectionFiltered

Descripción:

Método	Valores de retorno	Descripción
findSectionFiltered(String code, String name, int permissions)	List	Devuelve una lista de NodeClassSectionDefinition filtrada por código, nombre y permisos.

Nota

La clase com.openkm.sdk4csharp.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que modifican u obtienen permisos de seguridad.

Ejemplo:

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

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

            try
            {
                ws.login(user, password);
                String code = string.Empty;
                String name = "test";
                int permissions = Permission.ALL_GRANTS;
                List<NodeClassSectionDefinition> results = ws.filePlan.findSectionFiltered(code, name, permissions);
                foreach (NodeClassSectionDefinition ncsd in results)
                {
                     System.Console.WriteLine(ncsd.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNodeClassBreadcrumb

Descripción:

Método	Valores de retorno	Descripción
getNodeClassBreadcrumb(long sectionId)	List	Devuelve una lista de NodeClassSectionDefinition que son Electronic Records.

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);
long sectionId = 1;
                List<NodeClassSectionDefinition> results = ws.filePlan.getNodeClassBreadcrumb(sectionId);
                foreach (NodeClassSectionDefinition ncsd in results)
                {
                     System.Console.WriteLine(ncsd.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findAllNodeClasses

Descripción:

Método	Valores de retorno	Descripción
findAllNodeClasses()	List	Devuelve una lista de NodeClass.

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);
                List<NodeClass> results = ws.filePlan.findAllNodeClasses();
                foreach (NodeClass nc in results)
                {
                     System.Console.WriteLine(nc.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRootSectionsIdWithChildren

Descripción:

Método	Valores de retorno	Descripción
getRootSectionsIdWithChildren()	List	Devuelve una lista con los identificadores de sección que tienen hijos y cuyo padre es la raíz.

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);
                List<long> results = ws.filePlan.getRootSectionsIdWithChildren();
                foreach (var id in results)
                {
                     System.Console.WriteLine(id.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getChildrenSectionsIdByTenantWithChildren

Descripción:

Método	Valores de retorno	Descripción
getChildrenSectionsIdByTenantWithChildren(long parentId)	List	Devuelve una lista con los identificadores de sección que tienen hijos con padre igual a parentId, filtrada por tenant.

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);
                long parentId = 1;
                List<long> result = ws.filePlan.getChildrenSectionsIdByTenantWithChildren(parentId);
                foreach (var id in result)
                {
                     System.Console.WriteLine(id.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}