Ir al contenido

Task samples

Aspectos básicos

Sección titulada «Aspectos básicos»

Descripción de los campos de una tarea:

Campo Tipo Descripción Obligatorio
Id long ID interno de la tarea.
Lo establece automáticamente la aplicación.		 No aplica.
Owner String Contiene el ID de usuario de OpenKM.
Lo establece automáticamente la aplicación.		 No aplica.
Subject String El asunto de la tarea. Sí.
Description String La descripción de la tarea. No.
Start DateTime Cuándo puede empezar la tarea. Sí.
End DateTime Cuándo puede terminar la tarea. No.
Status TaskStatus El estado de la tarea.
Usted administra la lista de valores de estado.		 Sí.
Project TaskProject El proyecto relacionado con la tarea.
Usted administra la lista de valores de proyecto.		 Sí.
Type TaskType El tipo de tarea.
Usted administra la lista de valores de tipo de tarea.		 Sí.
Progress int El estado de progreso numérico.
El rango de valores permitidos va de 0 a 100, donde 100% indica una tarea completada.		 Sí.
RepeatGroup long Cuando una tarea se repite en el tiempo, pertenece a un grupo. El grupo se identifica mediante un ID de grupo de repetición único. No.
ReminderStartValue int Cuántos días antes de que empiece la tarea el sistema puede enviar una notificación por correo al usuario. No.
ReminderEndValue int Cuántos días antes de que termine la tarea el sistema puede enviar una notificación por correo al usuario. No.
ReminderStartUnit String Unidades del recordatorio de inicio.
Valores permitidos:
- “m” para minutos.
- “h” para horas.
- “d” para días.		 Obligatorio cuando ReminderStartValue es mayor que 0.
ReminderEndUnit String Unidades del recordatorio de fin.
Valores permitidos:
- “m” para minutos.
- “h” para horas.
- “d” para días.		 Obligatorio cuando ReminderEndValue es mayor que 0.
Users List Colección de usuarios asignados a la tarea. No. Pero debe asignarse al menos un usuario o un rol.
Roles List Colección de roles asignados a la tarea. No. Pero debe asignarse al menos un usuario o un rol.
Documents List Lista de UUIDs de los documentos relacionados. No.
Folders List Lista de UUIDs de las carpetas relacionadas. No.
Mails List Lista de UUIDs de los correos relacionados. No.
Records List Lista de UUIDs de los expedientes relacionados. No.

En todos los métodos, verá un parámetro llamado “token”. Al acceder a la aplicación vía SOAP, el proceso de inicio de sesión devuelve un token, que se usa para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe usar el valor “null”, que indica que la aplicación debe usar la “sesión de usuario”.

Ejemplo de código sugerido

Sección titulada «Ejemplo de código sugerido»

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Llegados a este punto, puede usar todos los métodos de Task desde la clase “task”, tal y como se muestra a continuación:

Ventana de terminal
ws.task.getAssigned(projectId, typeId, statusId, orderColumn, true, 0, 10, subject);

Métodos

Sección titulada «Métodos»

getAssigned

Sección titulada «getAssigned»

Descripción:

Método Valores de retorno Descripción
getAssigned(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, DateTime? from, DateTime? to,String subject) TaskList Recupera una lista de tareas asignadas a un usuario, filtrada y paginada.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id
                long statusId = 1; // A valid status id
                String orderColumn = "subject"; // A valid TaskManagerTask class parameter name used in HQL query
                DateTime? from = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 1);
                DateTime? to = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 30);
                String subject = "test";


                TaskList assignedTasks = ws.task.getAssigned(projectId, typeId, statusId, orderColumn, true, 0, 10, from, to, subject);
                foreach (Task task in assignedTasks.tasks)
                {
                     System.Console.WriteLine(task.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getActive

Sección titulada «getActive»

Descripción:

Método Valores de retorno Descripción
getActive(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, DateTime? from, DateTime? to, String subject) TaskList Recupera una lista de tareas activas asignadas a un usuario, filtrada y paginada.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id
                long statusId = 1; // A valid status id
                String orderColumn = "subject"; // A valid TaskManagerTask class parameter name used in HQL query
                DateTime? from = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 1);
                DateTime? to = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 30);
                String subject = "test";


                TaskList activeTasks = ws.task.getActive(projectId, typeId, statusId, "description", false, 0, 10, from, to, subject);
                foreach (Task task in activeTasks.tasks)
                {
                     System.Console.WriteLine(task.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getFinished

Sección titulada «getFinished»

Descripción:

Método Valores de retorno Descripción
getFinished(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, DateTime? from, DateTime? to, String subject) TaskList Recupera una lista de tareas finalizadas asignadas a un usuario, filtrada y paginada.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id
                long statusId = 1; // A valid status id
                String orderColumn = "start"; // A valid TaskManagerTask class parameter name used in HQL query
                DateTime? from = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 1);
                DateTime? to = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 30);
                String subject = "test";


                TaskList finishedTasks = ws.task.getFinished(projectId, typeId, statusId, "description", false, 0, 10, from, to, subject);
                foreach (Task task in finishedTasks.tasks)
                {
                     System.Console.WriteLine(task.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNotified

Sección titulada «getNotified»

Descripción:

Método Valores de retorno Descripción
getNotified(long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, DateTime? from, DateTime? to, String subject) List Recupera una lista de tareas notificadas asignadas a un usuario, filtrada y paginada.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id
                long statusId = 1; // A valid status id
                String orderColumn = "start"; // A valid TaskManagerTask class parameter name used in HQL query
                DateTime? from = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 1);
                DateTime? to = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 30);
                String subject = "test";


                TaskList taskList = ws.task.getNotified(projectId, typeId, statusId, orderColumn, true, 0, 10, from, to, subject);
                foreach (Task task in taskList.tasks)
                {
                    Console.WriteLine(task.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getStatus

Sección titulada «getStatus»

Descripción:

Método Valores de retorno Descripción
getStatus() List Recupera una lista con todos los estados de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                List<TaskStatus> list = ws.task.getStatus();
                foreach (TaskStatus taskStatus in list)
                {
                    System.Console.WriteLine(taskStatus.name);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getProjects

Sección titulada «getProjects»

Descripción:

Método Valores de retorno Descripción
getProjects(bool filterActive) List Recupera una lista con todos los proyectos de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                List<TaskProject> taskProjects = ws.task.geProjects(true);
                foreach (TaskProject tpj in taskProjects)
                {
                     System.Console.WriteLine(tpj.name);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getTypes

Sección titulada «getTypes»

Descripción:

Método Valores de retorno Descripción
getTypes(bool filterActive) List Recupera una lista con todos los tipos de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                List<TaskType> taskTypes = ws.task.getTypes(false);
                foreach (TaskType tp in taskTypes)
                {
                     System.Console.WriteLine(tp.name);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getAssignedCount

Sección titulada «getAssignedCount»

Descripción:

Método Valores de retorno Descripción
getAssignedCount(long statusId, long projectId, long typeId) long Devuelve el número de tareas asignadas a un usuario.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long statusId = 1; // A valid status id
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id
                long assigned = ws.task.getAssignedCount(statusId, projectId, typeId);
                System.Console.WriteLine("Assigned tasks count: "+ assigned.ToString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getActiveCount

Sección titulada «getActiveCount»

Descripción:

Método Valores de retorno Descripción
getActiveCount(long statusId, long projectId, long typeId) long Devuelve el número de tareas activas de un usuario.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long statusId = 1; // A valid status id
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id
                long active = ws.task.getActiveCount(statusId, projectId, typeId);
                System.Console.WriteLine("Active tasks count: " + active.ToString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getFinishedCount

Sección titulada «getFinishedCount»

Descripción:

Método Valores de retorno Descripción
getFinishedCount(long statusId, long projectId, long typeId) long Devuelve el número de tareas finalizadas de un usuario.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long statusId = 1; // A valid status id
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id
                long finished = ws.task.getFinishedCount(statusId, projectId, typeId);
                System.Console.WriteLine("Finished tasks count: " + finished.ToString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNotifiedCount

Sección titulada «getNotifiedCount»

Descripción:

Método Valores de retorno Descripción
getNotifiedCount(long statusId, long projectId, long typeId) Long Devuelve el número de tareas notificadas asignadas a un usuario.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id
                long statusId = 1; // A valid status id
                long total = ws.task.getNotifiedCount(statusId, projectId, typeId);
                Console.WriteLine("Total: " + total.ToString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

create

Sección titulada «create»

Descripción:

Método Valores de retorno Descripción
create(String subject, String start, String end, String description, long statusId, long projectId,
long typeId, String user, List notificationUsers, List externalUsers, List relatedDocuments,
List relatedFolders, List relatedRecords, List relatedMails, String repeatExpression,
String repeatExpression, String formatDate, int repeatTimes, String reminderStartUnit, int reminderStartValue,
String reminderEndUnit, int reminderEndValue)		 Task Crea una nueva tarea.
Descripción del parámetro repeatExpression:
Los comandos se ejecutan mediante cron cuando los campos de minuto, hora y mes coinciden con la hora actual, y cuando al menos uno de los dos campos de día (día del mes, o día de la semana) coincide con la hora actual. El planificador examina las entradas de crontab una vez cada minuto. Los campos de hora y fecha son:
<br>* * * * * command to execute<br> ? ? ? ? ?<br> ? ? ? ? ?<br> ? ? ? ? ????? day of week (0 - 6) (0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the same as 0)<br> ? ? ? ?????????? month (1 - 12)<br> ? ? ??????????????? day of month (1 - 31)<br> ? ???????????????????? hour (0 - 23)<br> ????????????????????????? min (0 - 59)<br>

Ejemplo:

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.util;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                String subject = "task subject";


                DateTime date = DateTime.Now;
                String start = ISO8601.formatBasic(date);
                date = new DateTime(2019, 1, 1);
                String end = ISO8601.formatBasic(date);


                String description = "description test";
                long statusId = 1; // A valid task status id
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id


                List<String> notificationUsers = new List<string>();
                notificationUsers.Add("pherrera");
                notificationUsers.Add("sochoa");


                List<String> externalUsers = new List<String>();
                externalUsers.Add("test@openkm.com");


                List<String> relatedDocuments = new List<String>();
                relatedDocuments.Add("82555dd1-bcc2-4e64-81cb-5f7c2b0d7801");


                List<String> relatedFolders = new List<String>();
                relatedFolders.Add("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7");


                List<String> relatedMails = new List<String>();
                List<String> relatedRecords = new List<String>();


                Task task = ws.task.create(subject, start, end, description, statusId, projectId, typeId, "okmAdmin", notificationUsers, externalUsers,
                   relatedDocuments, relatedFolders, relatedRecords, relatedMails, "0 0 1 * *", "", "", 10, "m", 5, "m", 10);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

update

Sección titulada «update»

Descripción:

Método Valores de retorno Descripción
update(long taskId, String subject, String start, String end, String description, long statusId,
long projectId, long typeId, String user, List notificationUsers, List externalUsers,
List relatedDocuments, List relatedFolders, List relatedRecords, List relatedMails,
String owner, String repeatExpression, String repeatUntil, String formatDate, int repeatTimes, int progress,
String reminderStartUnit, int reminderStartValue, String reminderEndUnit, int reminderEndValue)		 Task Actualiza una tarea.

Ejemplo:

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.util;


namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                String taskId = "2";
                String subject = "task update";


                DateTime date = DateTime.Now;
                String start = ISO8601.formatBasic(date);


                date = new DateTime(2019, 12, 1);
                String end = ISO8601.formatBasic(date);


                String description = "test update";
                long statusId = 1; // A valid task status id
                long projectId = 1; // A valid project id
                long typeId = 1; // A valid type id




                List<String> notificationUsers = new List<String>();
                roles.Add("pherrera");
                roles.Add("sochoa");


                List<String> externalUsers = new List<String>();
                externalUsers.Add("test@openkm.com");


                List<String> relatedDocuments = new List<String>();
                relatedDocuments.Add("82555dd1-bcc2-4e64-81cb-5f7c2b0d7801");


                List<String> relatedFolders = new List<String>();
                relatedFolders.Add("70ec54af-76ad-4d02-b9c8-8c94c3b6ffc7");


                List<String> relatedMails = new List<String>();
                List<String> relatedRecords = new List<String>();


                String owner = "okmAdmin";
                int progress = 20; // Progress task


                String repeatExpression = "0 0 1 * *";
                long taskId = 1;
                Task task = ws.task.update(taskId, subject, start, end, description, statusId, projectId, typeId, "okmAdmin", notificationUsers, externalUsers,
                   relatedDocuments, relatedFolders, relatedRecords, relatedMails, owner, repeatExpression, "", "", progress, 10, "m", 5, "m", 10);
                System.Console.WriteLine(task.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getTask

Sección titulada «getTask»

Descripción:

Método Valores de retorno Descripción
getTask(long taskId) Task Recupera una tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskId = "2";
Task task = ws.task.getTask(task.id);
                System.Console.WriteLine(task.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

delete

Sección titulada «delete»

Descripción:

Método Valores de retorno Descripción
delete(long taskId) void Elimina una tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskId = "2";
ws.task.delete(task.id);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createProject

Sección titulada «createProject»

Descripción:

Método Valores de retorno Descripción
createProject(String name, bool active, String description) TaskProject Crea un proyecto de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                TaskProject taskProject = ws.task.createProject("Task project 001", true, "Any description");
                System.Console.WriteLine(taskProject.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateProject

Sección titulada «updateProject»

Descripción:

Método Valores de retorno Descripción
updateProject(long projectId, bool active, String name, String description) TaskProject Actualiza un proyecto de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskProjectId = 1; // Valid task project id
                TaskProject taskProject = ws.task.updateProject(taskProjectId, true, "Task project 002", "Any description");
                System.Console.WriteLine(taskProject1.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteProject

Sección titulada «deleteProject»

Descripción:

Método Valores de retorno Descripción
deleteProject(long projectId) void Elimina un proyecto de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskProjectId = 1; // Valid task project id
                ws.task.deleteProject(taskProjectId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getProject

Sección titulada «getProject»

Descripción:

Método Valores de retorno Descripción
getProject(long projectId) TaskProject Obtiene un proyecto de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskProjectId = 1; // Valid task project id
                TaskProject tp = ws.task.getProject(taskProjectId);
                System.Console.WriteLine(tp.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createType

Sección titulada «createType»

Descripción:

Método Valores de retorno Descripción
createType(String name, bool active, String description) TaskType Crea un tipo de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                TaskType taskType = ws.task.createType("Test", false, "Any description");
                System.Console.WriteLine(taskType.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateType

Sección titulada «updateType»

Descripción:

Método Valores de retorno Descripción
updateType(long typeId, bool active, String name, String description) TaskType Actualiza un tipo de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskTypeId = 1; // Valid task type id
                TaskType taskType = ws.task.updateType(taskTypeId, true, "New Test", "New description");
                System.Console.WriteLine(taskType.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteType

Sección titulada «deleteType»

Descripción:

Método Valores de retorno Descripción
deleteType(long typeId) void Elimina un tipo de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskTypeId = 1; //Valid task type id
                ws.task.deleteType(taskTypeId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getType

Sección titulada «getType»

Descripción:

Método Valores de retorno Descripción
getType(long typeId) TaskType Obtiene un objeto de tipo de tarea por 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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskTypeId = 1; //Valid task type id
                TaskType taskType = ws.task.getType(taskTypeId);
                System.Console.WriteLine(taskType.toString());


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

createStatus

Sección titulada «createStatus»

Descripción:

Método Valores de retorno Descripción
createStatus(String name, bool finish) TaskStatus Crea un estado de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                TaskStatus taskStatus = ws.task.createStatus("Test", false);
                System.Console.WriteLine(taskStatus.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateStatus

Sección titulada «updateStatus»

Descripción:

Método Valores de retorno Descripción
updateStatus(long statusId, String name, bool finish) TaskStatus Actualiza un estado de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskStatusId = 1; // Valid task status id
                TaskStatus taskStatus = ws.task.updateStatus(taskStatusId , "Test", true);
                System.Console.WriteLine(taskStatus.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteStatus

Sección titulada «deleteStatus»

Descripción:

Método Valores de retorno Descripción
deleteStatus(long statusId) void Elimina un estado de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskStatusId = 1; // Valid task status id
                ws.task.deleteStatus(taskStatusId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getStatus

Sección titulada «getStatus»

Descripción:

Método Valores de retorno Descripción
getStatus(long statusId) TaskStatus Obtiene un estado de tarea por 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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskStatusId = 1; // Valid task status id
                TaskStatus taskStatus= ws.task.getStatus(taskStatusId);
                System.Console.WriteLine(taskStatus.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getNotes

Sección titulada «getNotes»

Descripción:

Método Valores de retorno Descripción
getNotes(long taskId) List Devuelve una lista de notas de una tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskId = 1; // Valid task id
                foreach (TaskNote tn in ws.task.getNotes(taskId))
                {
                    System.Console.WriteLine(tn.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createNote

Sección titulada «createNote»

Descripción:

Método Valores de retorno Descripción
createNote(long taskId, String text) TaskNote Crea una nota para una tarea concreta.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskId = 1; // Valid task id
                TaskNote taskNote = ws.task.createNote(taskId, "Any note");
                System.Console.WriteLine(taskNote.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateNote

Sección titulada «updateNote»

Descripción:

Método Valores de retorno Descripción
updateNote(long noteId, String text) TaskNote Actualiza una nota de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskNoteId = 1; // Valid task note id
                TaskNote taskNote = ws.task.updateNote(taskNoteId, "Any text");
                System.Console.WriteLine(taskNote.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteNote

Sección titulada «deleteNote»

Descripción:

Método Valores de retorno Descripción
deleteNote(long noteId) void Elimina una nota de tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskNoteId = 1; // Valid task note id
                ws.task.deleteNote(taskNoteId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getHistory

Sección titulada «getHistory»

Descripción:

Método Valores de retorno Descripción
getHistory(long taskId) List Devuelve el historial de una tarea.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                long taskId = 1; // Valid task id
                foreach (TaskHistory th in ws.task.getHistory(taskId))
                {
                    System.Console.WriteLine(th.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRelatedTasks

Sección titulada «getRelatedTasks»

Descripción:

Método Valores de retorno Descripción
getRelatedTasks(string uuid) TaskList Devuelve una lista de tareas.

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:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);


            try
            {
                ws.login(user, password);
                foreach (TaskList tl in ws.task.getRelatedTasks("l8fce7e5-f667-44bd-be2f-f3b3e584d574").tasks)
                {
                    System.Console.WriteLine(tl.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}