Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "OM2M/SclBase"
< OM2M
Line 3: | Line 3: | ||
|} | |} | ||
− | == | + | == SclBase resource == |
The sclBase resource shall contain all other resources of the hosting SCL. An sclBase resource is the root of all other resources it contains. | The sclBase resource shall contain all other resources of the hosting SCL. An sclBase resource is the root of all other resources it contains. | ||
+ | |||
+ | {{CTable}} | ||
+ | | Name || Type || Occurs || Read/Write || Description | ||
+ | |- | ||
+ | | accessRightID || URI || 0..1 || RW || Reference to an AccessRight resource defining who is allowed to access the resource containing this attribute for a specific purpose (retrieve, update, delete etc.) | ||
+ | |- | ||
+ | | searchStrings || SearchStrings || 1 || RW || Tokens used as keys for discovering resources | ||
+ | |- | ||
+ | | ... || ... || ... || ... || ... | ||
+ | |} | ||
+ | |||
+ | == SclBase XSD representation == | ||
+ | |||
+ | <source lang="xml"> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://uri.etsi.org/m2m" xmlns:tns="http://uri.etsi.org/m2m"> | ||
+ | <include schemaLocation="common.xsd" /> | ||
+ | <element name="sclBase" type="tns:SclBase"/> | ||
+ | <complexType name="SclBase"> | ||
+ | <all> | ||
+ | <element ref="tns:accessRightID" minOccurs="0" /> | ||
+ | <element ref="tns:searchStrings" minOccurs="0" /> | ||
+ | <element ref="tns:creationTime" minOccurs="0" /> | ||
+ | <element ref="tns:lastModifiedTime" minOccurs="0" /> | ||
+ | <element ref="tns:aPocHandling" minOccurs="0" /> | ||
+ | <!-- subresources --> | ||
+ | <element ref="tns:sclsReference" minOccurs="0" /> | ||
+ | <element ref="tns:applicationsReference" minOccurs="0" /> | ||
+ | <element ref="tns:containersReference" minOccurs="0" /> | ||
+ | <element ref="tns:groupsReference" minOccurs="0" /> | ||
+ | <element ref="tns:accessRightsReference" minOccurs="0" /> | ||
+ | <element ref="tns:subscriptionsReference" minOccurs="0" /> | ||
+ | <element ref="tns:discoveryReference" minOccurs="0" /> | ||
+ | </all> | ||
+ | </complexType> | ||
+ | <element name="sclsReference" type="anyURI" /> | ||
+ | <element name="discoveryReference" type="anyURI" /> | ||
+ | </schema> | ||
+ | </source> | ||
== Retrieve SclBase == | == Retrieve SclBase == |
Revision as of 09:47, 13 April 2014
SclBase resource
The sclBase resource shall contain all other resources of the hosting SCL. An sclBase resource is the root of all other resources it contains.
Name | Type | Occurs | Read/Write | Description |
accessRightID | URI | 0..1 | RW | Reference to an AccessRight resource defining who is allowed to access the resource containing this attribute for a specific purpose (retrieve, update, delete etc.) |
searchStrings | SearchStrings | 1 | RW | Tokens used as keys for discovering resources |
... | ... | ... | ... | ... |
SclBase XSD representation
<?xml version="1.0" encoding="UTF-8"?> <schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://uri.etsi.org/m2m" xmlns:tns="http://uri.etsi.org/m2m"> <include schemaLocation="common.xsd" /> <element name="sclBase" type="tns:SclBase"/> <complexType name="SclBase"> <all> <element ref="tns:accessRightID" minOccurs="0" /> <element ref="tns:searchStrings" minOccurs="0" /> <element ref="tns:creationTime" minOccurs="0" /> <element ref="tns:lastModifiedTime" minOccurs="0" /> <element ref="tns:aPocHandling" minOccurs="0" /> <!-- subresources --> <element ref="tns:sclsReference" minOccurs="0" /> <element ref="tns:applicationsReference" minOccurs="0" /> <element ref="tns:containersReference" minOccurs="0" /> <element ref="tns:groupsReference" minOccurs="0" /> <element ref="tns:accessRightsReference" minOccurs="0" /> <element ref="tns:subscriptionsReference" minOccurs="0" /> <element ref="tns:discoveryReference" minOccurs="0" /> </all> </complexType> <element name="sclsReference" type="anyURI" /> <element name="discoveryReference" type="anyURI" /> </schema>
Retrieve SclBase
Retrieve information about accessible resources
- Synopsis: GET {Well Known URI of the Service}
- Request Headers: Authorization, Accept.
- Request Body: N/A.
- Response Headers: Content-Type, Content-Length.
- Response Message Body: SclBase.
- Response Status: 200, 402, 404, 501.
Example Request
GET /scl-id Host: om2m.laas.fr Authorization: Basic xxxxxxxxxxxxxxxxxxx
Example Response
HTTP/1.1 200 OK Content-Type: text/xml
<?xml version="1.0" encoding="UTF-8"?> <om2m:sclBase xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> <om2m:accessRightID>scl-id/accessRights/ar-id</om2m:accessRightID> <om2m:searchStrings> <om2m:searchString>ResourceType/SclBase</om2m:searchString> <om2m:searchString>ResourceID/scl-id</om2m:searchString> </om2m:searchStrings> <om2m:creationTime>2014-04-07T14:45:33.935+02:00</om2m:creationTime> <om2m:lastModifiedTime>2014-04-07T14:45:33.991+02:00</om2m:lastModifiedTime> <om2m:sclsReference>scl-id/scls</om2m:sclsReference> <om2m:applicationsReference>scl-id/applications</om2m:applicationsReference> <om2m:containersReference>sclId/containers</om2m:containersReference> <om2m:groupsReference>scl-id/groups</om2m:groupsReference> <om2m:accessRightsReference>scl-id/accessRights</om2m:accessRightsReference> <om2m:subscriptionsReference>scl-id/subscriptions</om2m:subscriptionsReference> <om2m:discoveryReference>scl-id/discovery</om2m:discoveryReference> </om2m:sclBase>