Document samples

Aspectos básicos

En la mayoría de los métodos verá el 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 una respuesta de 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.getContent("/okm:root/logo.png");
            } 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 una respuesta de 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 algunas propiedades del documento.

Precaución

Solo se tendrán en cuenta las variables no nulas y no 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.

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());
            }
        }
    }
}

checkin

Descripción:

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

Nota

El valor de la variable increment debe ser 1 o mayor.

Los valores válidos de la variable increment dependen del VersionNumberAdapter que tenga habilitado.

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(@"C:\Desktop\logo.png", FileMode.Open);
                ws.checkin("/okm:root/logo.png", "optional some comment", fs, 1);
                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, String newName)	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", "new_logo.png");
            } 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());
            }
        }
    }
}

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.

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 un UUID de documento en una ruta de 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.getDocumentPath("e339f14b-4d3a-489c-91d3-05e4575709d2"));
            } 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());
            }
        }
    }
}

getExtractedText

Descripción:

Método	Valores de retorno	Descripción
getExtractedText(String docId)	String	Devuelve una cadena de texto con el texto extraído por el proceso de extracción de texto.

Precaución

Lamentablemente, no existe una forma directa de saber si un documento ha sido procesado o no desde la API, porque esta información solo se almacena a nivel de base de datos.

Aunque existe esta restricción, desde la API -solo los usuarios administradores- pueden realizarse consultas a la base de datos para recuperar esta información. Consulte Repository samples para acceder a información a nivel de base de datos.

Nota

Más información en Statistics.

• Cuando un documento se sube a OpenKM, entra en la cola de extracción de texto. Existe un crontab que procesa periódicamente esta cola y extrae el contenido de los documentos.

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.getExtractedText("/okm:root/document.doc"));
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getThumbnail

Descripción:

Método	Valores de retorno	Descripción
getThumbnail(String docId, ThumbnailType type)	Stream	Devuelve los datos de la imagen de la miniatura.

Nota

Cada tipo de miniatura tiene sus propias dimensiones de imagen.

• Tipos disponibles:

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.getThumbnail("/okm:root/document.doc", ThumbnailType.THUMBNAIL_LIGHTBOX);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setLanguage

Descripción:

Método	Valores de retorno	Descripción
setLanguage(String docId, String lang)	void	Establece el idioma de un documento.

Nota

Más información en https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.

• El parámetro lang debe cumplir con ISO 691-1.

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.setLanguage("/okm:root/document.doc", "es");
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setDocumentTitle

Descripción:

Método	Valores de retorno	Descripción
setDocumentTitle(String docId, String title)	void	Establece el título 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
            {
                ws.setDocumentTitle("/okm:root/document.doc", "Some title here");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createFromTemplate

Descripción:

Método	Valores de retorno	Descripción
Document createFromTemplate(String docId, String dstPath, String language, boolean categories, boolean keywords,             boolean propertyGroups, boolean notes, boolean wiki, List properties)	Document	Crea un nuevo documento a partir de una plantilla y devuelve un objeto Document.

Nota

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

Nota

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 de grupos de metadatos es true, se copiarán 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 puede ser una ruta de carpeta o de expediente.
• El parámetro language es opcional.
• Cuando una 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;
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
            {
                List<FormElement> formElements = new  List<FormElement>();
                Input name = new Input();
                name.name = "okp:tpl.name";
                name.value = "Some name";
                formElements.Add(name);

                Input birdDate = new Input();
                birdDate.name = "okp:tpl.bird_date";
                DateTime date = DateTime.Now;
                // Value must be converted to String ISO 8601 compliant
                birdDate.value = ISO8601.formatBasic(date);
                formElements.Add(birdDate);

                Select language = new Select();
                language.name = "okp:tpl.language";
                // With selected option is enought
                Option option = new Option();
                option.value = "java";
                option.selected = true;
                language.options.Add(option);
                formElements.Add(language);
                ws.createFromTemplate("/okm:templates/tpl.pdf", "/okm:root/test.pdf", null, false, false, true, false, false, formElements);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createFromTemplateSimple

Descripción:

Método	Valores de retorno	Descripción
Document createFromTemplateSimple(String docId, String dstPath, String language, boolean categories,             boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, Map<String, String> properties)	Document	Crea un nuevo documento a partir de una plantilla y devuelve un objeto Document.

Nota

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

Nota

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 de grupos de metadatos es true, se copiarán 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 puede ser una ruta de carpeta o de expediente.
• El parámetro language es opcional.
• Cuando una 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;
using com.openkm.sdk4csharp.util;

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");
                ws.createFromTemplateSimple("/okm:templates/tpl.pdf", "/okm:root/test.pdf",null, false, false, true, false, false, properties);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateFromTemplate

Descripción:

Método	Valores de retorno	Descripción
updateFromTemplate(String docId, String dstId, List properties)	Document	Actualiza un documento creado previamente a partir de una plantilla y devuelve un objeto Document.

Nota

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

• Este método solo tiene sentido cuando una plantilla usa grupos de metadatos para rellenar campos.

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;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.bean.form;
using com.openkm.sdk4csharp.util;

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
            {
                List<FormElement> formElements = new List<FormElement>();
                Input name = new Input();
                name.name = "okp:tpl.name";
                name.value = "Some name";
                formElements.Add(name);

                Input birdDate = new Input();
                birdDate.name = "okp:tpl.bird_date";
                DateTime date = DateTime.Now;
                // Value must be converted to String ISO 8601 compliant
                birdDate.value = ISO8601.formatBasic(date);
                formElements.Add(birdDate);

                Select language = new Select();
                language.name = "okp:tpl.language";
                // With selected option is enought
                Option option = new Option();
                option.value = "java";
                option.selected = true;
                language.options.Add(option);
                formElements.Add(language);

                ws.updateFromTemplate("/okm:templates/tpl.pdf", "/okm:root/test.pdf", formElements);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateFromTemplateSimple

Descripción:

Método	Valores de retorno	Descripción
updateFromTemplateSimple(String docId, String dstId, Map<String, String> properties)	Document	Actualiza un documento creado previamente a partir de una plantilla y devuelve un objeto Document.

Nota

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

• Este método solo tiene sentido cuando una plantilla usa grupos de metadatos para rellenar campos.

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;
using com.openkm.sdk4csharp.util;

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");

                ws.updateFromTemplateSimple("/okm:templates/tpl.pdf", "/okm:root/test.pdf", properties);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getDetectedLanguages

Descripción:

Método	Valores de retorno	Descripción
getDetectedLanguages()	List	Devuelve una lista de los idiomas de documento disponibles que OpenKM puede identificar.

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 (String lang in ws.getDetectedLanguages())
                {
                    System.Console.WriteLine(lang);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getAnnotations

Descripción:

Método	Valores de retorno	Descripción
getAnnotations(String docId, String verName)	String	Devuelve las anotaciones del documento para una versión 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
            {
                System.Console.WriteLine(ws.getAnnotations("2b9721e7-f186-4eea-ad61-42c97353548f", "1.0"));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getDifferences

Descripción:

Método	Valores de retorno	Descripción
getDifferences(String docId, String v1, String v2)	Stream	Devuelve un documento PDF con las diferencias entre dos versiones del documento.

Ejemplo:

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

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
            {
                BeanHelper beanHelper = new BeanHelper();
                Stream stream = ws.getDifferences("22799885-973f-46dc-a82c-dd11d2c65c65", "1.0", "1.1");
                Byte[] data = beanHelper.ReadToEnd(stream);
                FileStream fileStream = new FileStream(@"C:\Desktop\out.pdf", FileMode.OpenOrCreate, FileAccess.ReadWrite);
                foreach (byte b in data)
                {
                    fileStream.WriteByte(b);
                }
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getCheckedOut

Descripción:

Método	Valores de retorno	Descripción
getCheckedOut()	List	Devuelve una lista con los documentos que el usuario tiene en checkout.

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
            {
                List<Document> docs =  ws.getCheckedOut();
                foreach (Document doc in docs)
                {
                    System.Console.WriteLine(doc.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

stamp

Descripción:

Método	Valores de retorno	Descripción
stamp(String docId, int type, long stId)	void	Estampa el documento.

Nota

• Valor 0 para el tipo texto
• Valor 1 para el tipo imagen

• El parámetro type.

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
            {
                 long stampId = 1;                 int type = 1; // 1 for type image                 ws.stamp("22799885-973f-46dc-a82c-dd11d2c65c65", type, stampId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

stampImage

Descripción:

Método	Valores de retorno	Descripción
stampImage(String docId, long stId, String range, String exprX, String exprY, FileStream image)	void	Estampa una imagen en un documento.

Nota

En los campos exprX y exprY puede introducir algo más que un simple número. Actualmente están definidas las siguientes macros:

• IMAGE_WIDTH
• IMAGE_HEIGHT
• PAGE_WIDTH
• PAGE_HEIGHT
• PAGE_CENTER
• PAGE_MIDDLE

Así, para centrar un sello en la página puede usar:

• Expr. X:

  PAGE_CENTER

• Expr. Y:

  PAGE_MIDDLE

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
            {
                  long stampId = 1;                  String exprX = "PAGE_CENTER - IMAGE_WIDTH / 2";                  String exprY = "PAGE_MIDDLE - IMAGE_HEIGHT / 2";                   FileStream image = new FileStream(@"C:\images\stamp.jpg", FileMode.Open, FileAccess.Read);                   ws.stampImage("22799885-973f-46dc-a82c-dd11d2c65c65", stampId, "", exprX, exprY, image);                  image.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}