Web service API

How to use PageSeeder's Web service API

list filter tasks public

/tasks/filter [GET]

com.pageseeder.comment.GetTasksByFilter

This service is deprecated since version 5.7900

Description

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

This service is deprecated, please use service /tasks/find [GET] instead.

Parameters

NameDescriptionRequiredTypeDefault value
assignedafterthe date time after which the tasks were assigned last format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00nodatetime
assignedbeforethe date time before which the tasks were assigned last format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00nodatetime
assignedtothe member id of the member the tasks are assigned tonostring
attachmentsthe attachments to include, can be "none", "context", "all"noenumall
authorthe member id of the tasks authornostring
commentsthe replies to include, can be "none","first","last","all","archive"noenumlast
contentsthe contents to include, can be "none", "all"noenumall
createdafterthe date time after which the tasks were created format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00nodatetime
createdbeforethe date time before which the tasks were created format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00nodatetime
dueafterthe date time after which the tasks are due format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00nodatetime
duebeforethe date time before which the tasks are due format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00nodatetime
emailsthe email addresses to include, can be "none", "all" (admin only)noenumnone
groupsthe groups the tasks must belong to (comma-separated list of names, if not specified, the user's current groups are used)nostring
labelscomma-separated list of labels - task must have all (not recommended for filtering large data sets)nostring
pagethe page to loadnointeger1
pagesizethe number of results per pagenointeger1000
pathsthe context URI paths for the tasks - must be URL encoded (comma-separated list with optional * suffix)nostring
prioritiescomma-separated list of prioritiesnostring
statusescomma-separated list of statusesnostring
tasksizethe maximum number of comments to return per tasknointeger100
titlethe title of the tasks (optional wild card * suffix, use ** to escape)nostring
typethe type of the tasks (optional wild card * suffix, use ** to escape)nostring

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