Import samples

Básico

Precaución

Recomendamos ejecutar los métodos siguientes para importaciones de gran volumen o para casos de creación sencillos.

Estos métodos ejecutan menos pasos en segundo plano que los descritos en Document samples y Folder samples. Eso significa que obtendrá un mejor rendimiento, ya que se ejecuta menos lógica en el lado del servidor.

Consejo

Ejemplo de UUID:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;

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

ws.quickImport.importDocument("1be884f4-5758-4985-94d1-f18bfe004db8", fileInfo);

Métodos

importDocument

Descripción:

Método	Valores de retorno	Descripción
importDocument(String uuid, FileInfo fi)	String	Crea un nuevo documento y devuelve el UUID del documento.

El valor del parámetro uuid debe ser un UUID de nodo de tipo carpeta o expediente.

Ejemplo:

using System; using System.Collections.Generic;
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);
                FileInfo fileInfo = new FileInfo("E:\\doc.docx");
                String uuid = ws.quickImport.importDocument("22c1d190-f798-489d-b420-2008cb38705b", fileInfo);
                System.Console.WriteLine("UUID ="+ uuid);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

importDocument

Descripción:

Método	Valores de retorno	Descripción
importDocument(String uuid, DateTime? date, String author, FileInfo file)	String	Crea un nuevo documento y devuelve el UUID del documento.

El valor del parámetro uuid debe ser un UUID de nodo de tipo carpeta o expediente.

Ejemplo:

using System; using System.Collections.Generic;
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);
                FileInfo fileInfo = new FileInfo("E:\\doc.docx");
                String uuid = ws.quickImport.importDocument("22c1d190-f798-489d-b420-2008cb38705b", new DateTime(2024, 11, 20), "Test", fileInfo);
                System.Console.WriteLine("UUID ="+ uuid);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

importFolder

Descripción:

Método	Valores de retorno	Descripción
importFolder(String uuid, String name)	String	Crea una nueva carpeta y devuelve el UUID de la carpeta.

El valor del parámetro uuid debe ser un UUID de nodo de tipo carpeta o expediente.

Ejemplo:

using System; using System.Collections.Generic;
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 uuid = ws.quickImport.importFolder("22c1d190-f798-489d-b420-2008cb38705b", "Folder-Name");
                System.Console.WriteLine("UUID ="+ uuid);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

importFolder

Descripción:

Método	Valores de retorno	Descripción
importFolder(String uuid, String name, DateTime? date, String author)	String	Crea una nueva carpeta y devuelve el UUID de la carpeta.

El valor del parámetro uuid debe ser un UUID de nodo de tipo carpeta o expediente.

Ejemplo:

using System; using System.Collections.Generic;
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 uuid = ws.quickImport.importFolder("22c1d190-f798-489d-b420-2008cb38705b", "Folder-Name", new DateTime(2024, 11, 20), "Test");
                System.Console.WriteLine("UUID ="+ uuid);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

importMail

Descripción:

Método	Valores de retorno	Descripción
importMail(String uuid, FileInfo fi)	String	Crea un nuevo correo y devuelve el UUID del correo.

El valor del parámetro uuid debe ser un UUID de nodo de tipo carpeta o expediente.

Ejemplo:

using System; using System.Collections.Generic;
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);
                FileInfo fileInfo = new FileInfo("E:\\test.eml");
                String uuid = ws.quickImport.importMail("22c1d190-f798-489d-b420-2008cb38705b", fileInfo);
                System.Console.WriteLine("UUID ="+ uuid);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

importRecord

Descripción:

Método	Valores de retorno	Descripción
importRecord(String uuid, String name)	String	Crea un nuevo expediente y devuelve el UUID del expediente.

El valor del parámetro uuid debe ser un UUID de nodo de tipo carpeta o expediente.

Ejemplo:

using System; using System.Collections.Generic;
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 uuid = ws.quickImport.importRecord("22c1d190-f798-489d-b420-2008cb38705b", "Record-Name");
                System.Console.WriteLine("UUID ="+ uuid);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}

importRecord

Descripción:

Método	Valores de retorno	Descripción
importRecord(String uuid, String name, DateTime? date, String author)	String	Crea un nuevo expediente y devuelve el UUID del expediente.

El valor del parámetro uuid debe ser un UUID de nodo de tipo carpeta o expediente.

Ejemplo:

using System; using System.Collections.Generic;
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 uuid = ws.quickImport.importRecord("22c1d190-f798-489d-b420-2008cb38705b", "Record-Name", new DateTime(2024, 11, 20), "Test");
                System.Console.WriteLine("UUID ="+ uuid);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());

            }
       }
   }
}