Note samples

Aspectos básicos

En la mayoría de los métodos verá el parámetro llamado “nodeId”. El valor de este parámetro puede ser un UUID válido de documento, carpeta, correo o expediente.

Consejo

Ejemplo de nodeId:

• 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 los servicios web, 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 Note desde la clase “note”, tal y como se muestra a continuación:

ws.note.add("373bcdd0-c082-4e7b-addd-e10ef813946e", "the note text");

Métodos

add

Descripción:

Método	Valores de retorno	Descripción
add(String nodeId, String text)	Note	Añade una nota a un nodo y devuelve un objeto Note.

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.note.add("f123a950-0329-4d62-8328-0ff500fd42db", "the note text");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

get

Descripción:

Método	Valores de retorno	Descripción
get(String noteId)	Note	Obtiene la nota.

Nota

El noteId es un UUID.

El objeto Node tiene una variable llamada path; en ese caso, el path contiene un 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);
                List<Note> notes = ws.note.list("f123a950-0329-4d62-8328-0ff500fd42db");
                if (notes.Count > 0)
                {
                    System.Console.WriteLine(ws.note.get(notes[0].path));
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

delete

Descripción:

Método	Valores de retorno	Descripción
delete(String noteId)	Note	Elimina una nota.

Nota

El noteId es un UUID.

El objeto Node tiene una variable llamada path; en ese caso, el path contiene un 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);
                List<Note> notes = ws.note.list("f123a950-0329-4d62-8328-0ff500fd42db");
                if (notes.Count > 0)
                {
                    ws.note.delete(notes[0].path);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

set

Descripción:

Método	Valores de retorno	Descripción
set(String noteId, String text)	void	Cambia el texto de la nota.

Nota

El noteId es un UUID.

El objeto Node tiene una variable llamada path; en ese caso, el path contiene un 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);
                List<Note> notes = ws.note.list("f123a950-0329-4d62-8328-0ff500fd42db");
                if (notes.Count > 0)
                {
                    ws.note.set(notes[0].path, "text modified");
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

list

Descripción:

Método	Valores de retorno	Descripción
list(String nodeId)	List	Obtiene una lista con todas las notas 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;

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<Note> notes = ws.note.list("f123a950-0329-4d62-8328-0ff500fd42db");
                foreach (Note note in notes)
                {
                    System.Console.WriteLine(note);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNotesHistories

Descripción:

Método	Valores de retorno	Descripción
getNotesHistories(String nodeId)	List	Obtiene una lista con todos los históricos de notas 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;

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<NoteHistory> notes = ws.note.getNotesHistory("f123a950-0329-4d62-8328-0ff500fd42db");
                foreach (NoteHistory note in notes)
                {
                    System.Console.WriteLine(note);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}