Task samples

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”.

Consejo

En casos especiales, puede ser “promovido a Administrador” usando el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Ejemplo de código sugerido

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

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

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en los webservices, la sesión se mantiene en el objeto webservice. A partir de ahí puede usar el resto de métodos de la API.

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

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

Métodos

getAssignedTasks

Descripción:

Método	Valores de retorno	Descripción
getAssignedTasks(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.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.

• El parámetro typeId debe ser un id de tipo válido.

• El parámetro statusId debe ser un id de estado válido.

• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros más usados son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.

• El parámetro orderAsc ordena ascendente o descendentemente.

• La fecha from para filtrar (este parámetro es opcional).

• La fecha to para filtrar (este parámetro es opcional).

• El parámetro subject es el asunto de la tarea.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” indica cuántos resultados omitir antes de devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20, debe usar estos valores:

• limit=10
• offset=10

Consejo

Los parámetros “from” y “to” son opcionales y le permiten recuperar solo una parte de los resultados de una consulta.

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

getActiveTasks

Descripción:

Método	Valores de retorno	Descripción
getActiveTasks(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.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.

• El parámetro typeId debe ser un id de tipo válido.

• El parámetro statusId debe ser un id de estado válido.

• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros más usados son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.

• El parámetro orderAsc ordena ascendente o descendentemente.

• La fecha from para filtrar (este parámetro es opcional).

• La fecha to para filtrar (este parámetro es opcional).

• El parámetro subject es el asunto de la tarea.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” indica cuántos resultados omitir antes de devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20, debe usar estos valores:

• limit=10
• offset=10

Consejo

Los parámetros “from” y “to” son opcionales y le permiten recuperar solo una parte de los resultados de una consulta.

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

getFinishedTasks

Descripción:

Método	Valores de retorno	Descripción
getFinishedTasks(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.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.

• El parámetro typeId debe ser un id de tipo válido.

• El parámetro statusId debe ser un id de estado válido.

• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros más usados son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.

• El parámetro orderAsc ordena ascendente o descendentemente.

• La fecha from para filtrar (este parámetro es opcional).

• La fecha to para filtrar (este parámetro es opcional).

• El parámetro subject es el asunto de la tarea.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” indica cuántos resultados omitir antes de devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20, debe usar estos valores:

• limit=10
• offset=10

Consejo

Los parámetros “from” y “to” son opcionales y le permiten recuperar solo una parte de los resultados de una consulta.

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

getNotifiedTasks

Descripción:

Método	Valores de retorno	Descripción
getNotifiedTasks(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.

Nota

Descripción de los parámetros de filtro:

• El parámetro projectId debe ser un id de proyecto válido.

• El parámetro typeId debe ser un id de tipo válido.

• El parámetro statusId debe ser un id de estado válido.

• El parámetro orderColumn debe ser un parámetro válido de la clase TaskManagerTask. Los parámetros más usados son “subject”, “start”, “end”, “progress”, “owner”. Más información en la documentación javadoc.

• El parámetro orderAsc ordena ascendente o descendentemente.

• La fecha from para filtrar (este parámetro es opcional).

• La fecha to para filtrar (este parámetro es opcional).

• El parámetro subject es el asunto de la tarea.

Consejo

Los parámetros “limit” y “offset” le permiten recuperar solo una parte de los resultados de una consulta.

• El parámetro “limit” se usa para limitar el número de resultados devueltos.
• El parámetro “offset” indica cuántos resultados omitir antes de devolver resultados.

Nota

Por ejemplo, si su consulta tiene 1000 resultados, pero solo quiere devolver los primeros 10, debe usar estos valores:

• limit=10
• offset=0

Ahora suponga que quiere mostrar los resultados del 11 al 20, debe usar estos valores:

• limit=10
• offset=10

Consejo

Los parámetros “from” y “to” son opcionales y le permiten recuperar solo una parte de los resultados de una consulta.

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

getTaskStatus

Descripción:

Método	Valores de retorno	Descripción
getTaskStatus()	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.getTaskStatus();
foreach (TaskStatus taskStatus in list)
{
System.Console.WriteLine(taskStatus.name);
}
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getTaskProjects

Descripción:

Método	Valores de retorno	Descripción
getTaskProjects(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.getTaskProjects(true);
foreach (TaskProject tpj in taskProjects)
{
System.Console.WriteLine(tpj.name);
}
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getTaskTypes

Descripción:

Método	Valores de retorno	Descripción
getTaskTypes(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.getTaskTypes(false);
foreach (TaskType tp in taskTypes)
{
System.Console.WriteLine(tp.name);
}
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getAssignedTasksCount

Descripción:

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

Nota

Descripción de los parámetros de filtro:

• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

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.getAssignedTasksCount(statusId, projectId, typeId);
System.Console.WriteLine("Assigned tasks count: "+ assigned.ToString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getActiveTasksCount

Descripción:

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

Nota

Descripción de los parámetros de filtro:

• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

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.getActiveTasksCount(statusId, projectId, typeId);
System.Console.WriteLine("Active tasks count: " + active.ToString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getFinishedTasksCount

Descripción:

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

Nota

Descripción de los parámetros de filtro:

• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

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.getFinishedTasksCount(statusId, projectId, typeId);
System.Console.WriteLine("Finished tasks count: " + finished.ToString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getNotifiedTasksCount

Descripción:

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

Nota

Descripción de los parámetros de filtro:

• El parámetro statusId debe ser un id de estado válido.
• El parámetro projectId debe ser un id de proyecto válido.
• El parámetro typeId debe ser un id de tipo válido.

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.getNotifiedTasksCount(statusId, projectId, typeId);
Console.WriteLine("Total: " + total.ToString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

createTask

Descripción:

Método	Valores de retorno	Descripción
createTask(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.createTask(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());
}
}
}
}

updateTask

Descripción:

Método	Valores de retorno	Descripción
updateTask(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.

Nota

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:

* * * * * command to execute
? ? ? ? ?
? ? ? ? ?
? ? ? ? ????? day of week (0 - 6) (0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the same as 0)
? ? ? ?????????? month (1 - 12)
? ? ??????????????? day of month (1 - 31)
? ???????????????????? hour (0 - 23)
????????????????????????? min (0 - 59)

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.updateTask(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

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

deleteTask

Descripción:

Método	Valores de retorno	Descripción
deleteTask(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.deleteTask(task.id);
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

createTaskProject

Descripción:

Método	Valores de retorno	Descripción
createTaskProject(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.createTaskProject("Task project 001", true, "Any description");
System.Console.WriteLine(taskProject.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

updateTaskProject

Descripción:

Método	Valores de retorno	Descripción
updateTaskProject(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.updateTaskProject(taskProjectId, true, "Task project 002", "Any description");
System.Console.WriteLine(taskProject1.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

deleteTaskProject

Descripción:

Método	Valores de retorno	Descripción
deleteTaskProject(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.deleteTaskProject(taskProjectId);
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getTaskProject

Descripción:

Método	Valores de retorno	Descripción
getTaskProject(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.getTaskProject(taskProjectId);
System.Console.WriteLine(tp.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

createTaskType

Descripción:

Método	Valores de retorno	Descripción
createTaskType(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.createTaskType("Test", false, "Any description");
System.Console.WriteLine(taskType.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

updateTaskType

Descripción:

Método	Valores de retorno	Descripción
updateTaskType(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.updateTaskType(taskTypeId, true, "New Test", "New description");
System.Console.WriteLine(taskType.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

deleteTaskType

Descripción:

Método	Valores de retorno	Descripción
deleteTaskType(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.deleteTaskType(taskTypeId);
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getTaskType

Descripción:

Método	Valores de retorno	Descripción
getTaskType(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.getTaskType(taskTypeId);
System.Console.WriteLine(taskType.toString());

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

createTaskStatus

Descripción:

Método	Valores de retorno	Descripción
createTaskStatus(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.createTaskStatus("Test", false);
System.Console.WriteLine(taskStatus.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

updateTaskStatus

Descripción:

Método	Valores de retorno	Descripción
updateTaskStatus(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.updateTaskStatus(taskStatusId , "Test", true);
System.Console.WriteLine(taskStatus.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

deleteTaskStatus

Descripción:

Método	Valores de retorno	Descripción
deleteTaskStatus(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.deleteTaskStatus(taskStatusId);
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getTaskStatus

Descripción:

Método	Valores de retorno	Descripción
getTaskStatus(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.getTaskStatus(taskStatusId);
System.Console.WriteLine(taskStatus.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

getTaskNotes

Descripción:

Método	Valores de retorno	Descripción
getTaskNotes(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.getTaskNotes(taskId))
{
System.Console.WriteLine(tn.toString());
}
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

createTaskNote

Descripción:

Método	Valores de retorno	Descripción
createTaskNote(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.createTaskNote(taskId, "Any note");
System.Console.WriteLine(taskNote.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

updateTaskNote

Descripción:

Método	Valores de retorno	Descripción
updateTaskNote(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.updateTaskNote(taskNoteId, "Any text");
System.Console.WriteLine(taskNote.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}

deleteTaskNote

Descripción:

Método	Valores de retorno	Descripción
deleteTaskNote(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.deleteTaskNote(taskNoteId);
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}