Describe Entities

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)

Sample Entity URLs (_id=':ID:') [may not be valid]:

Custom Actions

deepLinkWithPermissions : list (GET) : [/assignment/deepLinkWithPermissions] (xml) (json) (form)

操作により課題リファレンスと，allowReadAssignment, allowAddAssignment, allowSubmitAssignment に対する真偽値が取得され，deepLink url を返します．以下がリクエスト URL パタンです: /direct/assignment/deepLinks/{assignment_ref} に{bool_allowRead}, {bool_allowAdd}, {bool_allowSubmit} のパラメータが付きます．

item : list (GET) : [/assignment/item] (xml) (json) (form)

課題IDによって指定される課題を取得します．リクエスト URL パタン：/direct/assignment/item/{assignmentId}.{format}

site : list (GET) : [/assignment/site] (xml) (json) (form)

サイトの課題を取得します．リクエストするURLパターン：/direct/assignment/site/{siteId}.{format}.gradebookItemId は3つの異なる形式を返します．1) ""- 課題が成績簿と関連していない 2) "{String-of gradebookItem name}"- 既存の成績簿アイテムの課題と関連している 3)"/assignment/a/{site_id}/{assignment-id}"- 成績簿に課題を追加している．

deepLink : list (GET) : [/assignment/deepLink] (xml) (json) (form)

操作により課題リファレンスが取得され，現在のユーザの deepLink URL を返します．以下がリクエスト URL パタンです: /direct/assignment/deepLinks/{assignment_ref}

my : list (GET) : [/assignment/my] (xml) (json) (form)

すべてのサイトのすべての課題を取得します．リクエスト URL パタン：/direct/assignment/my.{format}

annc : list (GET) : [/assignment/annc] (xml) (json) (form)

操作により課題リファレンスを取得し，お知らせとの連携のための課題の情報を返します．課題情報には，課題オブジェクト，コンテキスト，課題 ID，課題タイトル，課題 URLが含まれます．以下がリクエスト URL パタンです: /direct/assignment/annc/{assignment_ref} with paramter {messageId}

Entity class : org.sakaiproject.assignment.entityproviders.AssignmentEntityProvider$SimpleAssignment

Type :: bean

	Name	Type	Status
1)	access	string	Read/Write
2)	allPurposeItemText	string	Read/Write
3)	allowResubmission	boolean	Read/Write
4)	attachments	java.util.List	Read/Write
5)	author	string	Read/Write
6)	authorLastModified	string	Read/Write
7)	closeTime	java.time.Instant	Read/Write
8)	closeTimeString	string	Read/Write
9)	content	org.sakaiproject.assignment.api.model.Assignment	Read/Write
10)	context	string	Read/Write
11)	creator	string	Read/Write
12)	draft	boolean	Read/Write
13)	dropDeadTime	java.time.Instant	Read/Write
14)	dropDeadTimeString	string	Read/Write
15)	dueTime	java.time.Instant	Read/Write
16)	dueTimeString	string	Read/Write
17)	gradeScale	string	Read/Write
18)	gradeScaleMaxPoints	string	Read/Write
19)	gradebookItemId	long	Read/Write
20)	gradebookItemName	string	Read/Write
21)	groups	java.util.Collection	Read/Write
22)	id	string	Read/Write
23)	instructions	string	Read/Write
24)	modelAnswerText	string	Read/Write
25)	openTime	java.time.Instant	Read/Write
26)	openTimeString	string	Read/Write
27)	position	int	Read/Write
28)	privateNoteText	string	Read/Write
29)	section	string	Read/Write
30)	status	string	Read/Write
31)	submissionType	string	Read/Write
32)	timeCreated	java.time.Instant	Read/Write
33)	timeLastModified	java.time.Instant	Read/Write
34)	title	string	Read/Write

	Name	Type
1	CoreEntityProvider	org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider
2	EntityProvider	org.sakaiproject.entitybroker.entityprovider.EntityProvider
3	ActionsExecutable	org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
4	AutoRegisterEntityProvider	org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
5	Describeable	org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
6	Inputable	org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
7	Outputable	org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
8	PropertyProvideable	org.sakaiproject.entitybroker.entityprovider.capabilities.PropertyProvideable
9	Propertyable	org.sakaiproject.entitybroker.entityprovider.capabilities.Propertyable
10	Resolvable	org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
11	Sampleable	org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

assignment (xml)

Sample Entity URLs (_id=':ID:') [may not be valid]:

Custom Actions

Entity class : org.sakaiproject.assignment.entityproviders.AssignmentEntityProvider$SimpleAssignment

Data and Request Handling

Capabilities