Describe all registered entities (xml)


Describe all (registered entities): 74

General notes on special params and headers:
no-cache - this will cause the caching headers to be set for no caching (default caching is set based on last modified date on entity OR 5 minutes)
last-modified - this will force the last-modified date header to be set (unix timestamp in ms), no-cache overrides this
accept - this standard header can be used in place of format extensions (e.g. xml), just leave the extension off the URL
When searching for entities in a list, the following params are handled specially in the system (note that all the RoR conventions are followed for sorting/paging):
_start (number): the position of the first entity to return (0 is the first), e.g. _start=5
_page (number): the page of data to display (0 is first), e.g. _page=2
_perpage (number): the number of entities to return for the page (0 means all), e.g. _perpage=20
_limit (number): the maximum number of entities to return (0 means all), e.g. _limit=50
_order (string): the sort order to return entities in (default is ascending), should be a comma separated list of entity field names which optionally include a suffix to determine order, suffix can be _reverse or _desc for descending order OR '' (blank) or _asc for ascending order, e.g. _order=name OR _order=name_reverse OR _order=name,email_desc,firstname_asc,lastname_reverse
_sort (string): same as order
_validateSession: supply this parameter if sessions are to be explicitly checked to ensure a valid session. Without this, the session validation is left to the provider

announcement (xml)

指定されたサイトに対するお知らせ (マージされたお知らせを含む) またはユーザに対するすべてのお知らせを表します.今日のメッセージおよび公開のお知らせも含みます.オプションの URL パラメータが 2 つあります: 'n' はお知らせの検索結果の合計を,'d' はお知らせを取得する日数です.パラメータの指定がない場合は,ツール設定の指定に従うか,デフォルト値である n=3, n=10 が使用されます.例えば,/announcements/site/mercury.json?n=20&d=100 は過去 100 日間について最大 20 件のお知らせを取得します.

assignment (xml)


basiclti-events (xml)

サイト統計に LTI 利用の報告を許可します.ここには利用可能なインタフェースはありません.

calendar (xml)


chat-channel (xml)

チャットチャンネルとは,あるコンテキスト (サイト) 中のチャットルームを表します.

chat-message (xml)

チャットメッセージはチャットチャンネル (ルーム) 中のメッセージを表しています.

cm-academic-session (xml)

cm-canonical-course (xml)

cm-course-offering (xml)

cm-course-set (xml)

cm-enrollment (xml)

cm-enrollment-set (xml)

cm-section (xml)

cm-section-category (xml)

commons (xml)

content (xml)


delegated_access (xml)

dropbox (xml)

Dropbox ツールです

feedback (xml)

forum (xml)

forum_message (xml)

forum_topic (xml)

forums (xml)

単一のフォーラム,フォーラムのサイトコレクション,個人のトピックス(スレッドのコレクション),および子とのメッセージを取得するために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 をコールします.

gbng (xml)

gradebook (xml)


grades (xml)

lessonbuilder (xml)

lessons (xml)

lti (xml)

LTIService support LTI 1.x およびLTI 2.x work から種々のデータ構造へのアクセスができます.コレクションエンドポイントにより first= last= およびorder= パラメータの使用ができます.

mailarchive (xml)


membership (xml)

Represents a user's membership in a location (site, group, etc.) in the system, works with the site/group entities and the user entities. In the documentation below, a membership ID is a string in the form USER_ID::LOCATION_REFERENCE (e.g., "aaronz::site:mySiteId").

my (xml)

様々なページへ直接リンクし Profile2 に表示するために使用することができる URL の集合です.

mySignup (xml)

notify (xml)

Allows access to Sakai's email notification handling

pasystem (xml)

pasystem-admin (xml)

poll (xml)

廃止予定. 意識調査エンティティプロバイダを使用してください. 意識調査 (単一アイテムサーベイ) の内容,および,オプションで選択内容 (選択肢) への投票数 (表明) を表します.

poll-option (xml)

廃止予定. 意識調査エンティティプロバイダを使用してください. 意識調査の選択内容 (選択肢) を表します

poll-vote (xml)

廃止予定. 意識調査エンティティプロバイダを使用してください.意識調査におけるユーザの投票を表します.

polls (xml)

意識調査,選択内容 (選択肢),意識調査ツールの投票を表します

portal (xml)

portal-chat (xml)


profile (xml)


profile-events (xml)

サイト統計 にツール利用の報告を匿名ユーザにも許可します.ここには利用可能なインタフェースははありません.

profile-image (xml)

profile-message (xml)

Profile2 メッセージングシステムにアクセスを許可

profile-status (xml)


roster (xml)


roster-export (xml)

roster-membership (xml)

sam_core (xml)

sam_item (xml)

sam_pub (xml)

sam_publisheditem (xml)

search (xml)

server-config (xml)

Represents settings in the server configuration

session (xml)

Represents a user or system session which is currently active, inactive sessions or information about inactive sessions cannot be accessed, the session is effectively immutable and removing it is the same as deactivating it, updating simply has the effect of refreshing it so it will not timeout

signupEvent (xml)

site (xml)

Represents a site (a collection of users and tools) in the Sakai system

sitestats (xml)


sitestats-metrics (xml)

現在のサーバノードに対する SiteStats イベントアグリゲータ基準を提供

sitestats-report (xml)

synopticmsgcntritem (xml)

tagservice (xml)

tagservice-admin (xml)

tool (xml)

topic (xml)

tutorial (xml)

url (xml)

ShortenedUrlService を通じた URL を短縮を可能にするエンティティプロバイダ

user (xml)

Represents a user in the system, user data is effectively immutable and removing users cannot override externally provided users

userPrefs (xml)


validation (xml)

webcontent (xml)


wiki (xml)


REST:: 1.0.1 SVN: $Revision$ : $Date$