Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "OM2M/SclBase"
< OM2M
(→SclBase resource) |
|||
(24 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
{{CTable}} | {{CTable}} | ||
− | | Name || Type || | + | | Name || Type || Multiplicity || Create || Update ||Response |
|- | |- | ||
− | | accessRightID || | + | | [[OM2M/Attributes#AccessRightID | accessRightID]] || AnyURI || 0..1 || N/A || O || O |
|- | |- | ||
− | | searchStrings || SearchStrings || 1 || | + | | [[OM2M/Attributes#SearchStrings | searchStrings]] || SearchStrings || 1 || N/A || O || M |
|- | |- | ||
− | | | + | | [[OM2M/Attributes#CreationTime | creationTime]] || DateTime || 1 || N/A || NP || M |
+ | |- | ||
+ | | [[OM2M/Attributes#LastModifiedTime | lastModifiedTime]] || DateTime || 1 || NP || NP || M | ||
+ | |- | ||
+ | | [[OM2M/Attributes#APocHandling | aPocHandling ]] || APocHandling || 1 || NP || O || O | ||
+ | |- | ||
+ | | sclsReference || AnyURI || 1 || NP || NP || M | ||
+ | |- | ||
+ | | applicationsReference || AnyURI || 1 || NP || NP || M | ||
+ | |- | ||
+ | | containersReference || AnyURI || 1 || NP || NP || M | ||
+ | |- | ||
+ | | groupsReference || AnyURI || 1 || NP || NP || M | ||
+ | |- | ||
+ | | accessRightsReference || AnyURI || 1 || NP || NP || M | ||
+ | |- | ||
+ | | subscriptionsReference || AnyURI || 1 || NP || NP || M | ||
+ | |- | ||
+ | | subscriptionsReference || AnyURI || 1 || NP || NP || M | ||
+ | |- | ||
+ | | discoveryReference || AnyURI || 1 || NP || NP || M | ||
|} | |} | ||
− | == SclBase | + | == SclBase XSD schema == |
<source lang="xml"> | <source lang="xml"> | ||
Line 43: | Line 63: | ||
</source> | </source> | ||
− | == | + | == Create SclBase == |
− | + | This resource shall not be created via the API. | |
− | + | == Retrieve SclBase == | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
'''Example Request''' | '''Example Request''' | ||
Line 86: | Line 101: | ||
</om2m:sclBase> | </om2m:sclBase> | ||
</pre> | </pre> | ||
+ | |||
+ | == Update SclBase == | ||
+ | |||
+ | '''Example Request''' | ||
+ | |||
+ | <pre> | ||
+ | PUT /scl-id | ||
+ | Host: om2m.laas.fr | ||
+ | Authorization: Basic xxxxxxxxxxxxxxxxxxx | ||
+ | |||
+ | <?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:searchString>Location/Home</om2m:searchString> | ||
+ | </om2m:searchStrings> | ||
+ | </om2m:sclBase> | ||
+ | </pre> | ||
+ | |||
+ | '''Example Response''' | ||
+ | |||
+ | <pre> | ||
+ | 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:searchString>Location/Home</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> | ||
+ | </pre> | ||
+ | |||
+ | == Delete SclBase == | ||
+ | |||
+ | This resource shall not be deleted via the API. |
Latest revision as of 06:02, 4 May 2014
Contents
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 | Multiplicity | Create | Update | Response |
accessRightID | AnyURI | 0..1 | N/A | O | O |
searchStrings | SearchStrings | 1 | N/A | O | M |
creationTime | DateTime | 1 | N/A | NP | M |
lastModifiedTime | DateTime | 1 | NP | NP | M |
aPocHandling | APocHandling | 1 | NP | O | O |
sclsReference | AnyURI | 1 | NP | NP | M |
applicationsReference | AnyURI | 1 | NP | NP | M |
containersReference | AnyURI | 1 | NP | NP | M |
groupsReference | AnyURI | 1 | NP | NP | M |
accessRightsReference | AnyURI | 1 | NP | NP | M |
subscriptionsReference | AnyURI | 1 | NP | NP | M |
subscriptionsReference | AnyURI | 1 | NP | NP | M |
discoveryReference | AnyURI | 1 | NP | NP | M |
SclBase XSD schema
<?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>
Create SclBase
This resource shall not be created via the API.
Retrieve SclBase
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>
Update SclBase
Example Request
PUT /scl-id Host: om2m.laas.fr Authorization: Basic xxxxxxxxxxxxxxxxxxx <?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:searchString>Location/Home</om2m:searchString> </om2m:searchStrings> </om2m:sclBase>
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:searchString>Location/Home</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>
Delete SclBase
This resource shall not be deleted via the API.