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


Overview

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

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

OperationDescription

createFolder

Creates a folder.

getFolderRetrieves a specific folder.
listFoldersRetrieves all folders created by the the current user.
updateFolderUpdate a folder by overwriting properties.

Operation details

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

Creating a folder

The createFolder operation creates a folder.

createFolder
<wunderlist.createFolder>
	<title>{$ctx:title}</title>
	<listIds>{$ctx:listIds}</listIds>
</wunderlist.createFolder>
Properties
  • title: Title of the folder.
  • listIds: The IDs of the lists to add to the folder.
   Sample request

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

Sample Request for createFolder
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "title": "Test Folder",
    "listIds": [162512068,162512069]
}
Related Wunderlist documentation

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

Retrieving a specific folder

The getFolder operation retrieves a specific folder.

getFolder
<wunderlist.getFolder>
	<folderId>{$ctx:folderId}</folderId>
</wunderlist.getFolder>
Properties
  • folderId: The ID of the folder whose details would be retrieved.
   Sample request

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

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

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

Retrieving all folders created by the current user

The listFolders operation retrieves all folders created by the current user.

listFolders
<wunderlist.listFolders>
</wunderlist.listFolders>
   Sample request

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

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

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

Updating a folder by overwriting properties 

The updateFolder operation updates a folder by overwriting properties. 

updateFolder
<wunderlist.updateFolder>
    <folderId>{$ctx:folderId}</folderId>
    <title>{$ctx:title}</title>
    <listIds>{$ctx:listIds}</listIds>
	<revision>{$ctx:revision}</revision>
</wunderlist.updateFolder>
Properties
  • folderId: The ID of the folder to update.
  • title: The title of the folder.
  • listIds: The IDs of lists to add to the folder.
  • revision: Revision of the folder to update.
   Sample request

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

Sample Request for updateFolder
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "folderId": "1029605",
    "revision": 4,
    "title": "updated folder name",
    "listIds": [162512070,162512071]
}
Related Wunderlist documentation

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

Sample configuration

Following is a sample proxy service that illustrates how to connect to Wunderlist with the init operation and use the createFolder operation. The sample request for this proxy can be found in the createFolder  sample request.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="wunderlist_createFolder" 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="title" expression="json-eval($.title)"/>
         <property name="listIds" expression="json-eval($.listIds)"/>
         <wunderlist.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <clientId>{$ctx:clientId}</clientId>
            <accessToken>{$ctx:accessToken}</accessToken>
         </wunderlist.init>
         <wunderlist.createFolder>
            <title>{$ctx:title}</title>
            <listIds>{$ctx:listIds}</listIds>
         </wunderlist.createFolder>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>
  • No labels