単一のフォーラム,フォーラムのサイトコレクション,個人のトピックス(スレッドのコレクション),および子とのメッセージを取得するためにRESTfulエンドポイントセットを指定して下さい.ワークフロー例はサイトの個人のフォーラムを取得するために /direct/forums/site/SITEID.json を用いたサイトアクションをコールし,そしてトピックレベルまでの個人のフォーラムを取得するために /direct/forums/site/SITEID/forum/FORUMID.json を使います.基本的にスレッドのセットであるトピックを取得するため /direct/forums/site/SITEID/forum/FORUMID/topic/TOPICID.json を使った後に,添付と子に完全に割り当てられたメッセージを取得するため /direct/forums/site/SITEID/forum/FORUMID/topic/TOPICID/message/MESSAGEID.json をコールします.
HTTP response codes as returned by the system:
200 - OK (request is ok and content returned)
201 - CREATED (request created new content, URL and id of content in the header)
204 - NO CONTENT (request is ok but no content to return)
400 - ERROR (general error in the request, probably invalid parameters or data)
401 - UNAUTHORIZED (user authentication required for this request)
403 - FORBIDDEN (authorization required, insufficient privileges, user is already authenticated)
404 - NOT FOUND (resource not found, URL is invalid in some way, id or action are invalid)
405 - METHOD NOT ALLOWED (the method is not supported for this entity type)
406 - NOT ACCEPTABLE (the data format requested is unavailable for this entity type)
500 - INTERNAL SERVER ERROR (general server failure, probably a failure in the provider)
501 - NOT IMPLEMENTED (indicates that a prefix is invalid)
Custom Actions
site :
list (GET) :
[/forums/site] (
json) (
xml)
(GET) 指定されたサイトIDに対するフォーラム,トピックス,スレッドを取得します.
すべてのフォーラムを取得するサイト:
/direct/forums/site/SITEID.json
すべてのスレッドを取得するトピック:
/direct/forums/site/SITEID/forum/FORUMID/topic/TOPICID.json
完全に割り当てられたスレッドまたはメッセージ取得.指定したメッセージの下位からメッセージツリーを取得します.メッセージIDがスレッドのトップレベルのメッセージであれば,すべてのスレッドが返されます.
/direct/forums/site/SITEID/forum/FORUMID/topic/TOPICID/message/MESSAGEID.json
Data and Request Handling
Output formats : json, xml
Input formats : No formats allowed
No Access Provider registered for request processing
Capabilities
| Name | Type | Description |
1 | EntityProvider | org.sakaiproject.entitybroker.entityprovider.EntityProvider | |
2 | ActionsExecutable | org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable | |
3 | AutoRegisterEntityProvider | org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider | |
4 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
5 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$