list filter tasks
/members/{member}/tasks/filter [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
Description
Load a list of tasks using filter parameters. The last comment in the task must match all filter parameters.
This service is now deprecated, use service /members/{member}/tasks/find [GET] instead.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
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 | datetime | |
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 | datetime | |
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 | enum | all |
author | The member id of the tasks author | no | string | |
comments | The replies to include, can be none , first , last , all , archive | no | enum | last |
contents | The contents to include, can be none or all | no | enum | 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 | datetime | |
createdbefore | The date time before which the tasks were created format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00 | no | datetime | |
dueafter | The date time after which the tasks are due format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00 | no | datetime | |
duebefore | The date time before which the tasks are due format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00 | no | datetime | |
emails | The email addresses to include, can be none or all (admin only) | no | enum | 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 wildcard * suffix, use ** to escape) | no | string | |
type | The type of the tasks (optional wildcard * suffix, use ** to escape) | no | string |
Permission
Only the member or an administrator can invoke this service.
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
Code | Cause / Description |
---|---|
0x1306 | The Group is invalid or not accessible |
0x1312 | The createdafter or createdbefore date is invalid |
0x1313 | The author is invalid |