Document samples

Aspectos básicos

En la mayoría de los métodos verá un parámetro llamado “docId”. El valor de este parámetro puede ser un UUID o una ruta (path) válidos de documento.

Consejo

Ejemplo de docId:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;
• Usando path -> “/okm:root/logo.png”

Métodos

createDocumentSimple

Descripción:

Método	Valores de retorno	Descripción
createDocumentSimple(String docPath, FileStream fs)	Document	Crea un nuevo documento y devuelve como resultado un objeto Document con las propiedades del documento creado.

Ejemplo:

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

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, username, password);
            try
            {
                FileStream fileStream = new FileStream("E:\\logo.png", FileMode.Open);
                ws.createDocumentSimple("/okm:root/logo.png", fileStream);
                fileStream.Dispose();
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteDocument

Descripción:

Método	Valores de retorno	Descripción
deleteDocument(String docId)	void	Elimina un documento.

Nota

Cuando se elimina un documento, se mueve automáticamente a la carpeta /okm:trash/userId.

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, username, password);
            try
            {
                ws.deleteDocument("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
            System.Console.ReadKey();
        }
    }
}

getDocumentProperties

Descripción:

Método	Valores de retorno	Descripción
getDocumentProperties(String docId)	Document	Devuelve las propiedades del documento.

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, username, password);
            try
            {
                 System.Console.WriteLine(ws.getDocumentProperties("/okm:root/logo.png").toString());
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getContent

Descripción:

Método	Valores de retorno	Descripción
getContent(String docId)	Stream	Recupera el contenido (datos binarios) de la versión actual del documento.

Precaución

Si envía el fichero a través de la respuesta de un Servlet, le sugerimos establecer la longitud del contenido con:

Document doc = ws.getDocumentProperties("/okm:root/logo.png");
response.setContentLength(new Long(doc.getActualVersion().getSize()).intValue());

Peligro

Hemos encontrado problemas de tamaño incorrecto al usar:

response.setContentLength(is.available());

Ejemplo:

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

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, username, password);
            try
            {
                Stream s = ws.getContent("/okm:root/logo.png");                FileStream fs = new FileStream(@"D:\Download\logo.png", FileMode.OpenOrCreate);                s.CopyTo(fs);                fs.Close();                s.Close();
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getContentByVersion

Descripción:

Método	Valores de retorno	Descripción
getContentByVersion(String docId,String versionId)	Stream	Recupera el contenido (datos binarios) de una versión concreta del documento.

Precaución

Si envía el fichero a través de la respuesta de un Servlet, le sugerimos establecer la longitud del contenido con:

Document doc = ws.getDocumentProperties("/okm:root/logo.png");
response.setContentLength(new Long(doc.getActualVersion().getSize()).intValue());

Peligro

Hemos encontrado problemas de tamaño incorrecto al usar:

response.setContentLength(is.available());

Ejemplo:

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

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, username, password);
            try
            {
                Stream st = ws.getContentByVersion("/okm:root/logo.png","1.1");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getDocumentChildren

Descripción:

Método	Valores de retorno	Descripción
getDocumentChildren(String fldId)	List	Devuelve una lista con todos los documentos cuyo padre es fldId.

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, username, password);
            try
            {
                foreach (Document doc in ws.getDocumentChildren("/okm:root"))
                {
                    System.Console.WriteLine(doc);
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

renameDocument

Descripción:

Método	Valores de retorno	Descripción
renameDocument(String docId, String newName)	document	Cambia el nombre 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, username, password);
            try
            {
                 Document doc = ws.renameDocument("f123a950-0329-4d62-8328-0ff500fd42db", "logo_rename.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setProperties

Descripción:

Método	Valores de retorno	Descripción
setProperties(Document doc)	void	Cambia las propiedades de un documento.

Precaución

Solo se tendrán en cuenta las variables que no sean nulas ni estén vacías.

• Variables que se pueden cambiar:

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, username, password);
            try
            {
                Document doc = ws.getDocumentProperties("f123a950-0329-4d62-8328-0ff500fd42db");
                doc.description = "some description";
                doc.keywords.Add("test");
                ws.setProperties(doc);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

checkout

Descripción:

Método	Valores de retorno	Descripción
checkout(String docId)	void	Marca el documento para su edición.

• Solo un usuario puede modificar un documento a la vez.
• Antes de empezar la edición debe ejecutar una acción de checkout que bloquea el proceso de edición para el resto de usuarios y permite editar únicamente al usuario que ejecutó la acción.

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, username, password);
            try
            {
                ws.checkout("/okm:root/logo.png");
                // At this point the document is locked for other users except for the user who executed the action
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

cancelCheckout

Descripción:

Método	Valores de retorno	Descripción
cancelCheckout(String docId)	void	Cancela la edición de un documento.

Precaución

Esta acción solo puede realizarla el usuario que ejecutó previamente la acción de checkout.

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, username, password);
            try
            {
                // At this point the document is locked for other users except for the user who executed the action
                ws.cancelCheckout("/okm:root/logo.png");
                // At this point other users are allowed to execute a checkout and modify the document
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

forceCancelCheckout

Descripción:

Método	Valores de retorno	Descripción
forceCancelCheckout(String docId)	void	Cancela la edición de un documento.

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• Este método permite cancelar la edición de cualquier documento.
• No es obligatorio que esta acción la ejecute el mismo usuario que ejecutó previamente la acción de checkout.

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, username, password);
            try
            {
                // At this point the document is locked for other users except for the user who executed the action
                ws.forceCancelCheckout("/okm:root/logo.png");
                // At this point other users are allowed to execute a checkout and modify the document
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isCheckedOut

Descripción:

Método	Valores de retorno	Descripción
isCheckedOut(String docId)	Boolean	Devuelve un booleano que indica si el documento está siendo editado o no.

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, username, password);
            try
            {
                System.Console.WriteLine("Is the document checkout:"+ws.isCheckedOut("/okm:root/logo.png"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

checkin

Descripción:

Método	Valores de retorno	Descripción
checkin(String docId, String comment, FileStream fs)	Version	Actualiza un documento con una nueva versión y devuelve un objeto con los nuevos valores de Version.

Precaución

Solo el usuario que inició la edición (checkout) puede actualizar el documento.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.IO;
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, username, password);
            try
            {
                FileStream fs = new FileStream("E:\\logo.png", FileMode.Open);
                ws.checkin("/okm:root/logo.png","optional some comment",fs);
                fs.Dispose();
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getDocumentVersionHistory

Descripción:

Método	Valores de retorno	Descripción
getDocumentVersionHistory(String docId)	List	Devuelve una lista con todas las versiones del 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, username, password);
            try
            {
                foreach (Version version in ws.getVersionHistory("/okm:root/logo.png"))
                {
                 System.Console.WriteLine(version);
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

lock

Descripción:

Método	Valores de retorno	Descripción
lock(String docId)	LockInfo	Bloquea un documento y devuelve un objeto con la información del bloqueo.

Precaución

Solo el usuario que bloqueó el documento puede desbloquearlo.

Un documento bloqueado no puede ser modificado 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, username, password);
            try
            {
                ws.lockDocument("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

unlock

Descripción:

Método	Valores de retorno	Descripción
unlock(String docId)	void	Desbloquea un documento bloqueado.

Precaución

Solo el usuario que bloqueó el documento puede desbloquearlo.

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, username, password);
            try
            {
                ws.unlock("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

forceUnlock

Descripción:

Método	Valores de retorno	Descripción
forceUnlock(String docId)	void	Desbloquea un documento bloqueado.

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• Este método permite desbloquear cualquier documento bloqueado.
• No es obligatorio que esta acción la ejecute el mismo usuario que ejecutó previamente la acción de bloqueo (checkout).

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, username, password);
            try
            {
                ws.forceUnlock("/okm:root/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isLocked

Descripción:

Método	Valores de retorno	Descripción
isLocked(String docId)	Boolean	Devuelve un booleano que indica si el documento está bloqueado o no.

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, username, password);
            try
            {
                System.Console.WriteLine("Is document locked:" + ws.isLocked("/okm:root/logo.png"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getLockInfo

Descripción:

Método	Valores de retorno	Descripción
getLockInfo(String docId)	LockInfo	Devuelve un objeto con la información del bloqueo.

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, username, password);
            try
            {
                System.Console.WriteLine(ws.getLockInfo("/okm:root/logo.png"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purgeDocument

Descripción:

Método	Valores de retorno	Descripción
purgeDocument(String docId)	void	El documento se elimina permanentemente del repositorio.

Precaución

Cuando un documento se purga, solo puede restaurarse a partir de una copia de seguridad anterior del repositorio. La acción de purgar elimina el documento de forma permanente del repositorio.

• Normalmente se purgan documentos en /okm:trash/userId - las ubicaciones personales de la papelera de cada usuario - pero es posible purgar directamente cualquier documento de todo el repositorio.

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, username, password);
            try
            {
                ws.purgeDocument("/okm:trash/okmAdmin/logo.png");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

moveDocument

Descripción:

Método	Valores de retorno	Descripción
moveDocument(String docId, String dstId)	void	Mueve un documento a una carpeta o expediente.

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, username, password);
            try
            {
                ws.moveDocument("/okm:root/logo.png", "/okm:root/test");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

copyDocument

Descripción:

Método	Valores de retorno	Descripción
copyDocument(String docId, String dstId)	void	Copia un documento a una carpeta o expediente.

Precaución

Solo se copian los datos binarios y los permisos de seguridad al destino; los metadatos, palabras clave, etc. del documento no se copian.

Consulte el método “extendedCopy” para esta funcionalidad.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente.
• Cuando el valor del parámetro newName es null, el documento conservará el mismo nombre.

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, username, password);
            try
            {
                ws.copyDocument("/okm:root/logo.png", "/okm:root/temp");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

restoreVersion

Descripción:

Método	Valores de retorno	Descripción
restoreVersion(String docId, String versionId)	void	Restaura una versión anterior del documento como versión actual.

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, username, password);
            try
            {
                // Actual version is 2.0
                ws.restoreVersion("/okm:root/logo.png", "1.0");
                // Actual version is 1.0
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purgeVersionHistory

Descripción:

Método	Valores de retorno	Descripción
purgeVersionHistory(String docId)	void	Purga todas las versiones del documento excepto la versión actual.

Precaución

Esta acción no se puede revertir.

• Esta acción compacta 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;

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, username, password);
            try
            {
                // Version history has version 1.3,1.2,1.1 and 1.0
                ws.purgeVersionHistory("/okm:root/logo.png");
                // Version history has only version 1.3
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getVersionHistorySize

Descripción:

Método	Valores de retorno	Descripción
getVersionHistorySize(String docId)	long	Devuelve el tamaño total en bytes de todos los documentos del historial de versiones.

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, username, password);

            try
            {
                String[] UNITS = new String[] { "B", "KB", "MB", "GB", "TB", "PB", "EB" };
                long bytes = ws.getVersionHistorySize("/okm:root/logo.png");
                String value = "";
                for (int i = 6; i > 0; i--)
                {
                    double step = Math.Pow(1024, i);
                    if (bytes > step)
                        value = String.Format(Locale.ROOT, "%3.1f %s", bytes / step, UNITS[i]);
                }

                if (value.Equals(""))
                {
                    value = bytes.ToString() + " " + UNITS[0];
                }

                System.Console.WriteLine(value);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isLocked

Descripción:

Método	Valores de retorno	Descripción
isLocked(String docId)	Boolean	Devuelve un booleano que indica si el nodo es un documento o no.

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, username, password);
            try
            {
                // Return true
                ws.isValidDocument("/okm:root/logo.png");
                // Return false
                ws.isValidDocument("/okm:root");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getDocumentPath

Descripción:

Método	Valores de retorno	Descripción
getDocumentPath(String uuid)	String	Convierte el UUID de un documento en su ruta.

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, username, password);
            try
            {
                System.Console.WriteLine(ws.getDocumentPath("e339f14b-4d3a-489c-91d3-05e4575709d2"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isValidDocument

Descripción:

Método	Valores de retorno	Descripción
isValidDocument(String docId)	Boolean	Devuelve un booleano que indica si el nodo es un documento o no.

• Parámetros:
  docId de tipo string es el UUID o la ruta (path) del documento

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, username, password);

            try
            {
                // Return true
                ws.isValidDocument("/okm:root/logo.png");

                // Return false
                ws.isValidDocument("/okm:root");
            } catch (Exception e) {
               System.Console.WriteLine(e.ToString());
            }
         }
     }
}

extendedDocumentCopy

Descripción:

Método	Valores de retorno	Descripción
extendedDocumentCopy(String docId, String dstId, String name, boolean categories, boolean keywords,             boolean propertyGroups, boolean notes, boolean wiki)	void	Copia un documento con los datos asociados a una carpeta o expediente.
El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente. Cuando el valor del parámetro newName es null, el documento conservará el mismo nombre. Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. del documento no se copian. Adicionalmente: - Cuando el parámetro category es true, se copian los valores originales de las categorías. - Cuando el parámetro keywords es true, se copian los valores originales de las palabras clave. - Cuando el parámetro property groups es true, se copian los valores originales de los grupos de metadatos. - Cuando el parámetro notes es true, se copian los valores originales de las notas. - Cuando el parámetro wiki es true, se copian los valores originales del wiki.

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, username, password);

            try
            {
                ws.extendedDocumnetCopy("/okm:root/logo.png", "/okm:root/tmp", null, true, true, true, true, true);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createFromTemplate

Descripción:

Método	Valores de retorno	Descripción
Document createFromTemplate(String docId, String dstPath, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki, Dictionary<String, String> properties)	Document	Crea un nuevo documento a partir de la plantilla y devuelve un Document.

Nota

Para más información sobre plantillas y metadatos, consulte: Creating templates.

Nota

Adicionalmente:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copian los valores originales de las palabras clave.
• Cuando el parámetro property Groups es true, se copian los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copian los valores originales de las notas.
• Cuando el parámetro wiki es true, se copian los valores originales del wiki.

• El dstPath debe ser una carpeta.
• Cuando la plantilla usa grupos de metadatos para rellenar campos, estos valores son obligatorios y deben establecerse en el parámetro properties.

Ejemplo:

Nota

El siguiente ejemplo se basa en la muestra Creating PDF template.

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, username, password);

            try
            {
                Dictionary<String, String> properties = new Dictionary<String, String>();                properties.Add("okp:tpl.name", "Some name");                DateTime date = DateTime.Now;                // Value must be converted to String ISO 8601 compliant                properties.Add("okp:tpl.bird_date", ISO8601.formatBasic(date));                properties.Add("okp:tpl.language", "java");                                // create from template                Document doc2 = ws.createFromTemplate("fc638b93-0072-49ac-ad88-d4eeb098fd5a", "/okm:root/template.pdf", false, false, false, true, false, properties);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}