TaskList

Resumen del método

GET/scr/api/TaskList

Descripción

Utilice este método para obtener una lista de las tareas abiertas asignadas al usuario actual y una lista de las tareas completadas del usuario.

Información de recursos

Requisitos	Descripción
Formato de la respuesta	JSON
Requiere autenticación	Sí
Permite credenciales de cliente de OAuth 2	Sí utilizando un ID de servicio de usuario que contiene la categoría de gestión de trabajo
Velocidad limitada	Aún no

Parámetros

Nombre	Ubicación	Descripción	Obligatorio	Tipo
X-On-Behalf-Of	Cabecera	El contexto de usuario. El valor debe ser un nombre de usuario en la cuenta. El usuario debe tener permiso para realizar la acción en la cuenta y en el espacio padre especificado, si lo hay.	Necesario si se utilizan credenciales de ID de servicio OAuth. No es necesario cuando se utiliza la credencial de ID de servicio de usuario OAuth.	Serie
type	Consulta	Tipo de lista a devolver. Se da soporte a estos valores: assigned o completed. Si el valor no está soportado, se devuelve el código de respuesta de 400.	Sí	Serie
version	Consulta	Versión de la API solicitada. El único valor permitido es 20110917.	Sí	Serie
limit	Consulta	El número máximo de tareas a devolver. Si este parámetro no se proporciona, se usa el valor predeterminado de 100.	Nee	Entero
startFrom	Consulta	Si se proporciona este parámetro, la lista devuelta empieza con la tarea en este índice en la lista (basada en cero). Utilice este parámetro si el número de tareas disponibles es mayor que el número de tareas devueltas en un límite de llamada anterior.	Nee	Entero

Respuesta

Entrada de ejemplo

• Uso de la ID de servicio de usuario OAuth 2 credenciales de cliente:

  curl -i -H "Authorization: Bearer access_token"
  "https://your_server_url/scr/api/TaskList?type=completed&version=20110917"

• Uso de la ID de servicio OAuth 2 credenciales de cliente con contexto de usuario:

  curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com"
      "https://your_server_url/scr/api/TaskList?type=completed&version=20110917"

Resultado de ejemplo

{
      "work":[
         {           
            "name":"ProcessApp 1 - Multiple process apps.",        
            "id":"5f501e1345eda"
         },
         {           
            "name":"ProcessApp 2 - Multiple process apps.",        
            "id":"5f500e134a57f"
         },
     ]
}

Propiedades de respuesta

version

Versión de la API que se ha utilizado para crear una respuesta.

more

Contiene uno de los siguientes valores posibles:

• true si hay más tareas en el servidor
• false si la entrada de tarea incluye todas las tareas disponibles

type

Tipo de tareas de la lista. Los valores posibles son assigned o completed. Estos valores coinciden con el que se puede pasar para el parámetro type.

tasks

Matriz de tareas. Las tareas se listan en orden cronológico inverso de dueDate. Los elementos con el mismo dueDate se ordenan por ID de instancia e ID de tarea.

task.name

Nombre de la tarea.

task.id

El ID de la tarea.

task.workId

ID del trabajo asociado. Esta propiedad coincide con la propiedad ID de una de las entradas de la matriz de trabajos. Más de una tarea puede hacer referencia a la misma entrada de trabajo.

task.dueDate

Parámetro opcional. La fecha de vencimiento de la tarea. Si la tarea no tiene ninguna fecha de vencimiento, este campo no está presente. La fecha de vencimiento se lista en milisegundos desde epoch, es decir, 1 de enero de 1970 a medianoche, hora universal coordinada (UTC).

work

Matriz de elementos de trabajo. Los elementos de trabajo no están en ningún orden concreto. Hay una entrada en la matriz para cada valor exclusivo de workId en la matriz de tareas.

work.name

Nombre asignado a la instancia de trabajo cuando se inició.

work.id

ID de la instancia de trabajo.

Mensajes de respuesta

Código HTTP	Razón
200	La solicitud se ha completado correctamente.
400	Se ha producido un error al procesar la solicitud. Faltaban algunos parámetros obligatorios o contenían valores no válidos.
401	El usuario no está autorizado a realizar la petición.