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/Scls"
< OM2M
(Created page with "__TOC__ == Scls resource == The ''scls'' resource shall contain a collection of ''scl'' resources. {{CTable}} | Name || Type || Multiplicity || Create || Update ||Response...") |
|||
(6 intermediate revisions by the same user not shown) | |||
Line 8: | Line 8: | ||
| Name || Type || Multiplicity || Create || Update ||Response | | Name || Type || Multiplicity || Create || Update ||Response | ||
|- | |- | ||
− | | [[OM2M/Attributes#AccessRightID|accessRightID]] || | + | | [[OM2M/Attributes#AccessRightID|accessRightID]] || AnyURI || 0..1 || N/A || O || O |
|- | |- | ||
| [[OM2M/Attributes#CreationTime|creationTime]] || DateTime || 1 || N/A || NP || M | | [[OM2M/Attributes#CreationTime|creationTime]] || DateTime || 1 || N/A || NP || M | ||
Line 18: | Line 18: | ||
| subscriptionsReference || AnyURI || 1 || N/A || NP || M | | subscriptionsReference || AnyURI || 1 || N/A || NP || M | ||
|- | |- | ||
− | | mgmtObjsReference || AnyURI || 1 || N/A || NP || | + | | mgmtObjsReference || AnyURI || 0..1 || N/A || NP || O |
|} | |} | ||
− | == | + | == Scls XSD schema == |
<source lang="xml"> | <source lang="xml"> | ||
Line 27: | Line 27: | ||
<schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://uri.etsi.org/m2m" xmlns:tns="http://uri.etsi.org/m2m"> | <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" /> | <include schemaLocation="common.xsd" /> | ||
− | <element name=" | + | <element name="scls" type="tns:Scls" /> |
− | <complexType name=" | + | <complexType name="Scls"> |
<all> | <all> | ||
<element ref="tns:accessRightID" minOccurs="0" /> | <element ref="tns:accessRightID" minOccurs="0" /> | ||
Line 34: | Line 34: | ||
<element ref="tns:lastModifiedTime" minOccurs="0" /> | <element ref="tns:lastModifiedTime" minOccurs="0" /> | ||
<!-- subresources --> | <!-- subresources --> | ||
− | <element ref="tns: | + | <element ref="tns:sclCollection" minOccurs="0" /> |
− | + | ||
<element ref="tns:subscriptionsReference" minOccurs="0" /> | <element ref="tns:subscriptionsReference" minOccurs="0" /> | ||
<element ref="tns:mgmtObjsReference" minOccurs="0" /> | <element ref="tns:mgmtObjsReference" minOccurs="0" /> | ||
</all> | </all> | ||
</complexType> | </complexType> | ||
− | <element name=" | + | <element name="sclCollection" type="tns:NamedReferenceCollection" /> |
− | + | ||
</schema> | </schema> | ||
</source> | </source> | ||
− | == Create | + | == Create Scls == |
This resource shall not be created via the API, it is created as a part of the parent resource. | This resource shall not be created via the API, it is created as a part of the parent resource. | ||
− | == Retrieve | + | == Retrieve Scls == |
'''Example Request''' | '''Example Request''' | ||
<pre> | <pre> | ||
− | + | PUT /scl-id/scls | |
Host: om2m.laas.fr | Host: om2m.laas.fr | ||
Authorization: Basic xxxxxxxxxxxxxxxxxxx | Authorization: Basic xxxxxxxxxxxxxxxxxxx | ||
Line 66: | Line 64: | ||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | ||
− | <om2m: | + | <om2m:scls xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> |
− | <om2m:accessRightID> | + | <om2m:accessRightID>nscl/accessRights/AR_ADMIN</om2m:accessRightID> |
− | <om2m:creationTime>2014- | + | <om2m:creationTime>2014-05-04T14:18:00.617+02:00</om2m:creationTime> |
− | <om2m:lastModifiedTime>2014- | + | <om2m:lastModifiedTime>2014-05-04T14:18:23.532+02:00</om2m:lastModifiedTime> |
− | <om2m: | + | <om2m:sclCollection> |
− | <om2m:namedReference id=" | + | <om2m:namedReference id="gscl">nscl/scls/gscl</om2m:namedReference> |
− | + | </om2m:sclCollection> | |
− | + | <om2m:subscriptionsReference>nscl/scls/subscriptions</om2m:subscriptionsReference> | |
− | </om2m: | + | <om2m:mgmtObjsReference>nscl/scls/mgmtObjs</om2m:mgmtObjsReference> |
− | + | </om2m:scls> | |
− | <om2m:subscriptionsReference> | + | |
− | <om2m:mgmtObjsReference> | + | |
− | </om2m: | + | |
</pre> | </pre> | ||
− | == Update | + | == Update Scls == |
+ | '''Example Request''' | ||
+ | |||
+ | <pre> | ||
+ | PUT /scl-id/accessRights | ||
+ | Host: om2m.laas.fr | ||
+ | Authorization: Basic xxxxxxxxxxxxxxxxxxx | ||
+ | |||
+ | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | ||
+ | <om2m:scls xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> | ||
+ | <om2m:accessRightID>nscl/accessRights/AR_ADMIN_2</om2m:accessRightID> | ||
+ | </om2m:scls> | ||
+ | </pre> | ||
+ | |||
+ | '''Example Response''' | ||
+ | |||
+ | <pre> | ||
+ | HTTP/1.1 200 OK | ||
+ | Content-Type: text/xml | ||
+ | |||
+ | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | ||
+ | <om2m:scls xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> | ||
+ | <om2m:accessRightID>nscl/accessRights/AR_ADMIN_2</om2m:accessRightID> | ||
+ | <om2m:creationTime>2014-05-04T14:18:00.617+02:00</om2m:creationTime> | ||
+ | <om2m:lastModifiedTime>2014-05-04T14:18:23.532+02:00</om2m:lastModifiedTime> | ||
+ | <om2m:sclCollection> | ||
+ | <om2m:namedReference id="gscl">nscl/scls/gscl</om2m:namedReference> | ||
+ | </om2m:sclCollection> | ||
+ | <om2m:subscriptionsReference>nscl/scls/subscriptions</om2m:subscriptionsReference> | ||
+ | <om2m:mgmtObjsReference>nscl/scls/mgmtObjs</om2m:mgmtObjsReference> | ||
+ | </om2m:scls> | ||
+ | </pre> | ||
− | == Delete | + | == Delete Scls == |
This resource shall not be deleted via the API. It is deleted when the parent resource is deleted. | This resource shall not be deleted via the API. It is deleted when the parent resource is deleted. |
Latest revision as of 08:25, 4 May 2014
Contents
Scls resource
The scls resource shall contain a collection of scl resources.
Name | Type | Multiplicity | Create | Update | Response |
accessRightID | AnyURI | 0..1 | N/A | O | O |
creationTime | DateTime | 1 | N/A | NP | M |
lastModifiedTime | DateTime | 1 | N/A | NP | M |
sclCollection | NamedReferenceCollection | 1 | N/A | NP | M |
subscriptionsReference | AnyURI | 1 | N/A | NP | M |
mgmtObjsReference | AnyURI | 0..1 | N/A | NP | O |
Scls 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="scls" type="tns:Scls" /> <complexType name="Scls"> <all> <element ref="tns:accessRightID" minOccurs="0" /> <element ref="tns:creationTime" minOccurs="0" /> <element ref="tns:lastModifiedTime" minOccurs="0" /> <!-- subresources --> <element ref="tns:sclCollection" minOccurs="0" /> <element ref="tns:subscriptionsReference" minOccurs="0" /> <element ref="tns:mgmtObjsReference" minOccurs="0" /> </all> </complexType> <element name="sclCollection" type="tns:NamedReferenceCollection" /> </schema>
Create Scls
This resource shall not be created via the API, it is created as a part of the parent resource.
Retrieve Scls
Example Request
PUT /scl-id/scls 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" standalone="yes"?> <om2m:scls xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> <om2m:accessRightID>nscl/accessRights/AR_ADMIN</om2m:accessRightID> <om2m:creationTime>2014-05-04T14:18:00.617+02:00</om2m:creationTime> <om2m:lastModifiedTime>2014-05-04T14:18:23.532+02:00</om2m:lastModifiedTime> <om2m:sclCollection> <om2m:namedReference id="gscl">nscl/scls/gscl</om2m:namedReference> </om2m:sclCollection> <om2m:subscriptionsReference>nscl/scls/subscriptions</om2m:subscriptionsReference> <om2m:mgmtObjsReference>nscl/scls/mgmtObjs</om2m:mgmtObjsReference> </om2m:scls>
Update Scls
Example Request
PUT /scl-id/accessRights Host: om2m.laas.fr Authorization: Basic xxxxxxxxxxxxxxxxxxx <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <om2m:scls xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> <om2m:accessRightID>nscl/accessRights/AR_ADMIN_2</om2m:accessRightID> </om2m:scls>
Example Response
HTTP/1.1 200 OK Content-Type: text/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <om2m:scls xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"> <om2m:accessRightID>nscl/accessRights/AR_ADMIN_2</om2m:accessRightID> <om2m:creationTime>2014-05-04T14:18:00.617+02:00</om2m:creationTime> <om2m:lastModifiedTime>2014-05-04T14:18:23.532+02:00</om2m:lastModifiedTime> <om2m:sclCollection> <om2m:namedReference id="gscl">nscl/scls/gscl</om2m:namedReference> </om2m:sclCollection> <om2m:subscriptionsReference>nscl/scls/subscriptions</om2m:subscriptionsReference> <om2m:mgmtObjsReference>nscl/scls/mgmtObjs</om2m:mgmtObjsReference> </om2m:scls>
Delete Scls
This resource shall not be deleted via the API. It is deleted when the parent resource is deleted.