Describe Entities

tool (xml)

RESTful URLs: http://microformats.org/wiki/rest/urls

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]:

Entity Collection URL: GET /tool (xml) (html) (json)

Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable

Show Entity URL: GET /tool/:ID: (xml) (html) (json)

Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable

Custom Actions

publicToolIds : list (GET) : [/tool/publicToolIds] (xml) (html) (json)

hiddenToolIds : list (GET) : [/tool/hiddenToolIds] (xml) (html) (json)

allToolIds : list (GET) : [/tool/allToolIds] (xml) (html) (json)

Entity class : org.sakaiproject.entitybroker.providers.model.EntityTool

Type :: bean

	Name	Type	Status
1)	access	string	Read Only
2)	categories	java.util.Set	Read Only
3)	description	string	Read Only
4)	finalConfig	java.util.Properties	Read Only
5)	home	string	Read Only
6)	id	string	Read Only
7)	keywords	java.util.Set	Read Only
8)	mutableConfig	java.util.Properties	Read Only
9)	registeredConfig	java.util.Properties	Read Only
10)	title	string	Read Only

Data and Request Handling

Output formats : xml, html, json

Input formats : No formats allowed

No Access Provider registered for request processing

Capabilities

	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	CollectionResolvable	org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
5	Describeable	org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
6	Outputable	org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
7	Resolvable	org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable

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