Last updated November 19, 2009 17:54, by john_brock
Project Forums Resource
These APIs let you work with a project's forums. The APIs work with topics, which contain posts about the topic, and with the posts in a topic.
Contents
- 1 List Topics
- 2 Topic Info
- 3 Topic Create
- 4 Topic Update
- 5 Topic Delete
- 6 List Posts
- 7 Post Info
- 8 Post Create
- 9 Post Update
- 10 Post Delete
List Topics
Get a paginated list of the topics available in the forum, or search the forum.
| Version | 1.0 |
| Authentication | unnecessary |
| URI | /api/projects/foo/features/forum/topics.json |
| Request | GET /api/projects/foo/features/forum/topics.json GET /api/projects/foo/features/forum/topics.json?q={search-query} |
| Response | Success: 200 OK Content-Type: application/vnd.com.kenai.topics+json |
Topic Info
Get information about a single topic.
Note: The topic posts are in the posts collection, which is linked from this entity-body in the posts_href URL and is not included directly.
| Version | 1.0 |
| Authentication | unnecessary |
| URI | /api/projects/foo/features/forum/topics/123.json |
| Request | GET /api/projects/foo/features/forum/topics/123.json |
| Response | Success: 200 OK Content-Type: application/vnd.com.kenai.topic+json |
Topic Create
Create a new topic. When a topic is created, a topic post (first post in the topic) is created as well.
| Version | 1.0 |
| Authentication | required |
| URI | /api/projects/foo/features/forum/topics.json |
| Request | POST /api/projects/foo/features/forum/topics.json Content-Type: application/vnd.com.kenai.topic.create+json |
| Response | Success: 201 Created Content-Type: application/vnd.com.kenai.topic+json |
Topic Update
Update a topic to specify a different subject, or to update the topic post.
| Version | 1.0 |
| Authentication | required |
| URI | /api/projects/foo/features/forum/topics/123.json |
| Request | PUT /api/projects/foo/features/forum/topics/123.json Content-Type:application/vnd.com.kenai.topic.create+json |
| Response | Success: 200 OK Content-Type:application/vnd.com.kenai.topic+json |
Topic Delete
Delete a topic and all its posts.
| Version | 1.0 |
| Authentication | required |
| URI | /api/projects/foo/features/forum/topics/123.json |
| Request | DELETE /api/projects/foo/features/forum/topics/123.json |
| Response | Success: 200 OK |
List Posts
List all posts for a topic.
| Version | 1.0 |
| Authentication | unnecessary |
| URI | /api/projects/foo/features/forum/topics/123/posts.json |
| Request | GET /api/projects/foo/features/forum/topics/123/posts.json |
| Response | Success: 200 OK Content-Type: application/vnd.com.kenai.posts+json |
Post Info
Get a single post.
| Version | 1.0 |
| Authentication | unnecessary |
| URI | /api/projects/foo/features/forum/topics/123/posts/456.json |
| Request | GET /api/projects/foo/features/forum/topics/123/posts/456.json |
| Response | Success: 200 OK Content-Type: application/vnd.com.kenai.post+json |
Post Create
Create a new post in a topic.
| Version | 1.0 |
| Authentication | required |
| URI | /api/projects/foo/features/forum/topics/123/posts.json |
| Request | POST /api/projects/foo/features/forum/topics/123/posts.json Content-Type: application/vnd.com.kenai.post.create+json |
| Response | Success: 200 OK Content-Type:application/vnd.com.kenai.post+json |
Post Update
Update an existing post. To be able to change a post, you must be the person who created it.
| Version | 1.0 |
| Authentication | required |
| URI | /api/projects/foo/features/forum/topics/123/posts/456.json |
| Request | PUT /api/projects/foo/features/forum/topics/123/posts/456.json Content-Type: application/vnd.com.kenai.post.create+json |
| Response | Success: 200 OK Content-Type:application/vnd.com.kenai.post+json |
Post Delete
Delete a post. To be able to delete a post, you must be the person who created it.
| Version | 1.0 |
| Authentication | required |
| URI | /api/projects/foo/features/forum/topics/123/posts/456.json |
| Request | DELETE /api/projects/foo/features/forum/topics/123/posts/456.json |
| Response | Success:200 OK |
