All docs This doc
Skip to end of metadata
Go to start of metadata


Overview

The following operations allow you to work with tasks. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with tasks, see Sample configuration

OperationDescription

createTask

Creates a task.

deleteTaskDeletes a task.
getTaskRetrieves a specific task.
listTasks

Retrieves tasks for a list and completed tasks.

updateTaskUpdates a task by overwriting properties.

Operation details

This section provides further details on the operations related to tasks.

Creating a task

The createTask operation creates a task.

createTask
<wunderlist.createTask>
    <listId>{$ctx:listId}</listId>
    <title>{$ctx:title}</title>
    <assigneeId>{$ctx:assigneeId}</assigneeId>
    <completed>{$ctx:completed}</completed>
    <recurrenceType>{$ctx:recurrenceType}</recurrenceType>
    <recurrenceCount>{$ctx:recurrenceCount}</recurrenceCount>
    <dueDate>{$ctx:dueDate}</dueDate>
	<starred>{$ctx:starred}</starred>
</wunderlist.createTask>
Properties
  • listId: The ID of the list to which the task would be added.
  • title: Title of the task. Maximum length is 255 characters.
  • assigneeId: The ID of the person to whom the task is assigned.
  • completed: Indicate whether the task is completed or not.
  • recurrenceType: Type of recurrence: day, week, month, year.
  • recurrenceCount: No. of recurrences.
  • dueDate: Due date of the task. Formatted as an ISO8601 date.
  • starred: Indicates whether the task is starred or not.
Sample request

Following is a sample REST/JSON request that can be handled by the createTask operation.

Sample Request for createTask
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "listId": 162511981,
    "title": "Task One",
    "assigneeId": 111069791,
    "completed": true,
    "recurrenceType": "day",
    "recurrenceCount": 2,
    "dueDate": "2015-12-27",
    "starred": true
}
Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/task

Deleting a task

The deleteTask operation deletes a task. 

deleteTask
<wunderlist.deleteTask>
    <taskId>{$ctx:taskId}</taskId>
	<revision>{$ctx:revision}</revision>
</wunderlist.deleteTask>
Properties
  • taskId: The ID of the task to delete.
  • revision: Revision of the task to delete.
Sample request

Following is a sample REST/JSON request that can be handled by the deleteTask operation.

Sample Request for deleteTask
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "taskId": "1201293286",
    "revision": 1
}
Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/task

Retrieving a specific task

The getTask operation retrieves a specific task.

getTask
<wunderlist.getTask>
	<taskId>{$ctx:taskId}</taskId>
</wunderlist.getTask>
Properties
  • taskId: The ID of the task whose details would be retrieved.
Sample request

Following is a sample REST/JSON request that can be handled by the getTask operation.

Sample Request for getTask
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "taskId": "1201232101"
}
Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/task

Retrieving tasks for a list and completed tasks

The listTasks operation retrieves tasks for a list and completed tasks.

listTasks
<wunderlist.listTasks>
    <listId>{$ctx:listId}</listId>
	<completed>{$ctx:completed}</completed>
</wunderlist.listTasks>
Properties
  • listId: The ID of the list whose tasks would be retrieved.
  • completed: Indicate whether or not to list only the completed tasks.
Sample request

Following is a sample REST/JSON request that can be handled by the listTasks operation.

Sample Request for listTasks
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "listId": "162511981",
    "completed": true
}
Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/task

Updating a task by overwriting properties

The updateTask operation updates a task by overwriting properties. 

updateTask
<wunderlist.updateTask>
    <title>{$ctx:title}</title>
    <assigneeId>{$ctx:assigneeId}</assigneeId>
    <completed>{$ctx:completed}</completed>
    <recurrenceType>{$ctx:recurrenceType}</recurrenceType>
    <recurrenceCount>{$ctx:recurrenceCount}</recurrenceCount>
    <dueDate>{$ctx:dueDate}</dueDate>
    <starred>{$ctx:starred}</starred>
    <taskId>{$ctx:taskId}</taskId>
    <revision>{$ctx:revision}</revision>
	<remove>{$ctx:remove}</remove>
</wunderlist.updateTask>
Properties
  • title: Title of the task. Maximum length is 255 characters.
  • assigneeId: The ID of the person to whom the task is assigned.
  • completed: Indicate whether the task is completed or not.
  • recurrenceType: Type of recurrence: day, week, month, year.
  • recurrenceCount: No. of recurrences.
  • dueDate: Due date of the task. Formatted as an ISO8601 date.
  • starred: Indicates whether the task is starred or not.
  • taskId: The ID of the task whose details would be retrieved.
  • revision: Revision of the task to update.
  • remove: List of attributes to be removed from the task.
Sample request

Following is a sample REST/JSON request that can be handled by the updateTask operation.

Sample Request for updateTask
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "taskId": "1201278472",
    "title": "updated task title2",
    "assigneeId": 110606111,
    "completed": false,
    "recurrenceType": "week",
    "recurrenceCount": 2,
    "dueDate": "2015-06-16",
    "starred": false,
    "revision": 4,
    "remove": ["assignee_id"]
}

Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/task

Sample configuration

Following is a sample proxy service that illustrates how to connect to Wunderlist with the init operation and use the createTask operation. The sample request for this proxy can be found in the createTask sample request. You can use this sample as a template for using other operations in this category.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="wunderlist_createTask" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="clientId" expression="json-eval($.clientId)"/>
         <property name="accessToken" expression="json-eval($.accessToken)"/>
         <property name="listId" expression="json-eval($.listId)"/>
         <property name="title" expression="json-eval($.title)"/>
         <property name="assigneeId" expression="json-eval($.assigneeId)"/>
         <property name="completed" expression="json-eval($.completed)"/>
         <property name="recurrenceType" expression="json-eval($.recurrenceType)"/>
         <property name="recurrenceCount" expression="json-eval($.recurrenceCount)"/>
         <property name="dueDate" expression="json-eval($.dueDate)"/>
         <property name="starred" expression="json-eval($.starred)"/>
         <wunderlist.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <clientId>{$ctx:clientId}</clientId>
            <accessToken>{$ctx:accessToken}</accessToken>
         </wunderlist.init>
         <wunderlist.createTask>
            <listId>{$ctx:listId}</listId>
            <title>{$ctx:title}</title>
            <assigneeId>{$ctx:assigneeId}</assigneeId>
            <completed>{$ctx:completed}</completed>
            <recurrenceType>{$ctx:recurrenceType}</recurrenceType>
            <recurrenceCount>{$ctx:recurrenceCount}</recurrenceCount>
            <dueDate>{$ctx:dueDate}</dueDate>
            <starred>{$ctx:starred}</starred>
         </wunderlist.createTask>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>
  • No labels