Relation 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 o un path válido de documento, carpeta, correo o expediente.

Consejo

Ejemplo de nodeId:

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

Métodos

getRelationTypes

Descripción:

Método	Valores de retorno	Descripción
getRelationTypes(String type)	List	Obtiene una lista de todas las relaciones definidas para un tipo.

Nota

Más información en Relation types.

• Tipos disponibles:

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 (RelationType type in ws.getRelationTypes(RelationType.PARENT_CHILD))
                {
                    System.Console.WriteLine(type);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

addRelation

Descripción:

Método	Valores de retorno	Descripción
addRelation(String nodeAId, String nodeBId, long relTypeId)	void	Establece una relación entre dos nodos.

• Los parámetros nodeAId y nodeBId deben ser un UUID o una ruta (path) válidos de documento, carpeta, correo o expediente.

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 (RelationType type in ws.getRelationTypes(RelationType.BIDIRECTIONAL))
                {
                    // looking for a relation named invoice
                    if (type.title.Equals("invoice"))
                    {
                        ws.addRelation("/okm:root/invoice.pdf", "/okm:root/budget.pdf", type.id);
                    }
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteRelation

Descripción:

Método	Valores de retorno	Descripción
deleteRelation(long relationId)	void	Elimina una relación.

Precaución

Una relación solo puede eliminarse cuando ningún nodo la utiliza; en caso contrario, obtendrá un error.

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 (RelationType type in ws.getRelationTypes(RelationType.BIDIRECTIONAL))
                {
                    // looking for a relation named invoice
                    if (type.title.Equals("invoice"))
                    {
                        ws.deleteRelation(type.id);
                    }
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRelations

Descripción:

Método	Valores de retorno	Descripción
getRelations(String nodeId)	RelationList	Obtiene una lista de todas las relaciones 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, username, password);
            try
            {
                foreach (Relation relation in ws.getRelations("/okm:root/invoice.pdf"))
                {
                    System.Console.WriteLine(relation);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRelationGroups

Descripción:

Método	Valores de retorno	Descripción
getRelationGroups(String nodeId)	List	Obtiene una lista de todos los grupos de relación 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, username, password);
            try
            {
                foreach (RelationGroup rGroup in ws.getRelationGroups("/okm:root/invoice.pdf"))
                {
                    System.Console.WriteLine(rGroup);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

addRelationGroup

Descripción:

Método	Valores de retorno	Descripción
addRelationGroup(String nodeId, String groupName, long type)	void	Añade un grupo de relación a un nodo.

Nota

Más información en Relation types.

• Un grupo de relación solo tiene sentido para el tipo de relación RelationType.MANY_TO_MANY.

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 (RelationType type in ws.getRelationTypes(RelationType.MANY_TO_MANY))
                {
                    if (type.title.Equals("staple"))
                    {
                        ws.addRelationGroup("/okm:root/invoice.pdf", "staple group", type.id);
                    }
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

addNodeToGroup

Descripción:

Método	Valores de retorno	Descripción
addNodeToGroup(String nodeId, long groupId)	void	Añade un nodo a un grupo de relación existente.

Nota

Más información en Relation types.

• Un grupo de relación solo tiene sentido para el tipo de relación RelationType.MANY_TO_MANY.

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 (RelationGroup rGroup in ws.getRelationGroups("/okm:root/invoice.pdf"))
                {
                    if (rGroup.name.Equals("staple group"))
                    {
                        ws.addNodeToGroup("/okm:root/complaint.pdf", rGroup.id);
                    }
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteRelationGroup

Descripción:

Método	Valores de retorno	Descripción
deleteRelationGroup(String nodeId, long groupId)	void	Elimina un nodo de un grupo de relación.

Ejemplo:

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

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                foreach (RelationGroup rGroup in ws.getRelationGroups("/okm:root/budget.pdf"))
                {
                    if (rGroup.name.Equals("staple group"))
                    {
                        ws.deleteRelationGroup("/okm:root/complaint.pdf", rGroup.id);
                    }
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findRelationGroup

Descripción:

Método	Valores de retorno	Descripción
findRelationGroup(long groupId)	RelationGroup	Busca un grupo de relación por su id.

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 groupId = 2;
                System.Console.WriteLine(ws.findRelationGroup(groupId));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setRelationGroupName

Descripción:

Método	Valores de retorno	Descripción
setRelationGroupName(long groupId, String groupName)	void	Cambia el nombre del grupo de relación.

Ejemplo:

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

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                long groupId = 2;
                ws.setRelationGroupName(groupId, "new name");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}