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


Overview

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

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

OperationDescription

createNote

Creates a note.

getNoteRetrieves a specific note.
listNotesRetrieves the notes for a task or list.
updateNoteUpdates a note by overwriting properties.

Operation details

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

Creating a note

The createNote operation creates a note.

createNote
<wunderlist.createNote>
    <taskId>{$ctx:taskId}</taskId>
	<content>{$ctx:content}</content>
</wunderlist.createNote>
Properties
  • taskId: The name of the note.
  • content: A description of the note.
Sample request

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

Sample Request for createNote
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "taskId": "1201335173",
    "content": "Test Note"
}
Related Wunderlist documentation

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

Retrieving a specific note

The getNote operation retrieves a specific note.

getNote
<wunderlist.getNote>
	<noteId>{$ctx:noteId}</noteId>
</wunderlist.getNote>
Properties
  • noteId: The ID of the note whose contents would be retrieved.
Sample request

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

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

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

Retrieving the notes for a task or list

The listNotes operation retrieves the notes for a task or list.

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

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

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

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

Updating a note by overwriting properties

The updateNote operation updates a note by overwriting properties.

updateNote
<wunderlist.updateNote>
    <noteId>{$ctx:noteId}</noteId>
    <content>{$ctx:content}</content>
	<revision>{$ctx:revision}</revision>
</wunderlist.updateNote>
Properties
  • noteId: The ID of the note to update.
  • content: Content of the note.
  • revision: Revision of the note to update.
Sample request

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

Sample Request for updateNote
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "noteId": "87747696",
    "revision": 3,
    "content": "note updated"
}
Related Wunderlist documentation

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

Sample configuration

Following is a sample proxy service that illustrates how to connect to Wunderlist with the init operation and use the createNote operation. The sample request for this proxy can be found in the createNote 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_createNote" 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="taskId" expression="json-eval($.taskId)"/>
         <property name="content" expression="json-eval($.content)"/>
         <wunderlist.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <clientId>{$ctx:clientId}</clientId>
            <accessToken>{$ctx:accessToken}</accessToken>
         </wunderlist.init>
         <wunderlist.createNote>
            <taskId>{$ctx:taskId}</taskId>
            <content>{$ctx:content}</content>
         </wunderlist.createNote>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>                                                                                                                        
  • No labels