Web service API

How to use PageSeeder's Web service API

find tasks public

/tasks/find [GET]

com.pageseeder.comment.GetTasksByFilter

Description

Load public tasks by filter

Load a list of tasks using filter parameters. The last comment in the task must match all filter parameters.

Note

The @status, @priority, @due attributes and <assignedto> element may not be included if comments=first or none and the last comment in the task is not loaded.

Parameters

NameDescriptionRequiredTypeDefault value
assignedafter the date time after which the tasks were assigned last format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00 no string
assignedbefore the date time before which the tasks were assigned last format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00 no string
assignedto the member id of the member the tasks are assigned to no string
attachments the attachments to include, can be "none", "context", "all" no string all
author the member id of the tasks author no string
comments the replies to include, can be "none", "first", "last", "all", "archive" no string last
contents the contents to include, can be "none", "all" no string all
createdafter the date time after which the tasks were created format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00 no string
createdbefore the date time before which the tasks were created format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00 no string
dueafter the date time after which the tasks are due format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00 no string
duebefore the date time before which the tasks are due format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00 no string
emails the email addresses to include, can be "none", "all" (admin only) no string none
groups the groups the tasks must belong to (comma-separated list of names, if not specified, the user's current groups are used) no string
labels comma-separated list of labels - task must have all (not recommended for filtering large data sets) no string
page the page to load no integer 1
pagesize the number of results per page no integer 1000
paths the context URI paths for the tasks - must be URL encoded (comma-separated list with optional * suffix) no string
priorities comma-separated list of priorities no string
statuses comma-separated list of statuses no string
tasksize the maximum number of comments to return per task no integer 100
title the title of the tasks (optional wild card * suffix, use ** to escape) no string
type the type of the tasks (optional wild card * suffix, use ** to escape) no string

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<tasks>
   <task id="123"
         title="My thread"
         lastcommentid="234"
         lastcommentdate="2012-08-20T14:27:48+10:00"
         status="Open"
         priority="High"
         due="2012-08-25T18:00:00+10:00">
     <uri id="789">...</uri>
     <locator fragment="2"/>
     <assignedto id="34"
                 date="2012-08-20T14:27:48+10:00" ...> ... </assignedto>
     <comment id="234"
              contentrole="File Attachment"
              created="2012-03-08T12:34:00+10:00">
       <title>My thread</title>
       <content type="text/plain">
         Some text
       </content>
       <attachment>
         <uri id="189">...</uri>
       </attachment>
       <attachment fragment="5">
         <uri id="289">...</uri>
       </attachment>
     </comment>
   </task>
   <task id="100">
     ...
   </task>
 </tasks>

Error handling

CodeCause / Description
0x1306 The Group is invalid or not accessible
0x1312 The createdafter or createdbefore date is invalid
0x1313 The author is invalid

Created on , last edited on