find discussions
/members/{member}/discussions/find [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9400 | 6.0000 | xml, json |
Description
Find discussions.
Load a list of discussions using filter parameters. A comment in the discussion must match all filter parameters. The discussions with the most recent last comment are returned first.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| attachments | The attachments to include, can be none, context, all | no | enum | all |
| author | The ID of the comment author | no | long | |
| comments | The replies to include, can be none, first, last, all, archive | no | enum | last |
| contents | The contents to include, can be none, all | no | enum | all |
| context | Only return comments in this context, can be group, uri, all | no | enum | all |
| createdafter | The date time after which the comments were created, format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00 | no | datetime | |
| createdbefore | The date time before which the comments were created, format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00 | no | datetime | |
| discussionsize | The maximum number of comments to return per discussion (0 = unlimited) | no | integer | 100 |
| emails | The email addresses to include, can be none or all (administrator only) | no | enum | none |
| groups | A comma-separated list of group names the comment should belong to (if not specified, the user’s current groups are used) | no | strings | |
| labels | Comma-separated list of label values – comment must have all (not recommended for filtering large data sets) | no | strings | |
| 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 comments – MUST be URL encoded (comma-separated list with optional * suffix) | no | strings | |
| project | Return only discussions from the current user's groups that are under this project (only if groups not specified) | no | string | |
| title | The title of the comments (optional wildcard * suffix, use ** to escape) | no | string | |
| type | The type of the comments (optional wildcard * suffix, use ** to escape) | no | string | |
| types | Comma-separated list of types the comment can have (empty string means no type) | no | strings |
Permission
This service can only be invoked by the member or an administrator. If the parameter emails is set to all, the permission is restricted to administrator only.
The other restriction is that the groups parameter can only list groups that have public access or the current user is a guest or higher.
Response
The output has the following format:
<discussions>
<discussion id="123"
title="My thread"
[replycount="1"
lastcommentid="234"
lastcommentdate="2012-08-20T14:27:48+10:00"]>
<uri id="789"> ... </uri>
<locator fragment="2"/>
<comment id="234"
contentrole="File Attachment"
created="2012-08-20T14:27:48+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>
</discussion>
<discussion id="100"> ... </discussion>
</discussions>
The @replycount , @lastcommentid and @lastcommentdate are only included and @title is from the last comment, if the comments parameter is last, all or archive, otherwise @title is from the first comment.
Error Handling
| 0x1303 | Context ‘group’ cannot be used with 'paths' parameter |
|---|---|
| 0x1306 | The Group is invalid or not accessible |
| 0x1312 | The createdafter or createdbefore date is invalid |
| 0x1313 | The author is invalid |