list filter tasks public
/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.
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, or 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, or 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
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 |