Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "OM2M/Scl"

(→‎Delete Scl)
(→‎Scl XSD schema)
 
(8 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
| Name || Type || Multiplicity || Create || Update ||Response
 
| Name || Type || Multiplicity || Create || Update ||Response
 
|-
 
|-
−
| [[OM2M/Attributes#appID|appId]] || NMTOKEN || 1 || O || NP || M
+
| sclId || NMTOKEN || 1 || M || NP || M
 
|-
 
|-
−
| [[OM2M/Attributes#AccessRightID|accessRightID]] || AnyURI || 0..1 || O || O || O
+
| pocs || pocs || 1 || O || O || M
 
|-
 
|-
−
| [[OM2M/Attributes#CreationTime|creationTime]] || DateTime || 1 || NP || NP || M
+
| remTriggerAddr || remTriggerAddr || 1 || O || O || O
 
|-
 
|-
−
| [[OM2M/Attributes#LastModifiedTime|lastModifiedTime]] || DateTime || 1 || NP || NP || M
+
| onlineStatus || OnlineStatus || 1 || NP || NP || M
 
|-
 
|-
−
| [[OM2M/Attributes#ExpirationTime|expirationTime]] || DateTime || 1 || O || O || M*
+
| serverCapability || ServerCapability || 1 || NP || NP || M
 
|-
 
|-
−
| [[OM2M/Attributes#SearchStrings|searchStrings]] || searchStrings || 1 || O || O || M
+
| link || AnyURI || 1 || O || O || O
 
|-
 
|-
−
| [[OM2M/Attributes#AnnounceTo|announceTo]] || AnnounceTo || 0..unbounded || O || O || M*
+
| schedule || Schedule || 1 || O || O || O
 
|-
 
|-
−
| [[OM2M/Attributes#APoC|aPoC]] || AnyURI || 0..1 || O || O || O
+
| expirationTime || DateTime || 1 || O || O || M
 
|-
 
|-
−
| [[OM2M/Attributes#APocPaths|aPoCPaths]] || aPocPaths || 0..1 || O || O || O
+
| accessRightID || AnyURI || 1 || O || O || O
 
|-
 
|-
−
| [[OM2M/Attributes#Iocrequester|Iocrequester]] || String || 0..1 || O || O || O
+
| searchStrings || SearchStrings || 1 || O || O || M
 +
|-
 +
| creationTime || DateTime || 1 || NP || NP || M
 +
|-
 +
| lastModifiedTime || DateTime || 1 || NP || NP || M
 +
|-
 +
| locTargetDevice || locTargetDevice || 1 || O || O || O
 +
|-
 +
| mgmtProtocolType || MgmtProtocolType || 1 || M || M || M
 +
|-
 +
| integrityValResults || IntegrityValResults || 1 || O || O || O
 +
|-
 +
| aPocHandling || APocHandling || 1 || NP || NP || O
 
|-
 
|-
 
| containersReference || AnyURI || 1 || NP || NP || M
 
| containersReference || AnyURI || 1 || NP || NP || M
Line 31: Line 43:
 
| groupsReference || AnyURI || 1 || NP || NP || M
 
| groupsReference || AnyURI || 1 || NP || NP || M
 
|-
 
|-
−
| accessRightsReference || NamedReferencecollection || 1 || NP || NP || M
+
| applicationsReference || AnyURI || 1 || NP || NP || M
 +
|-
 +
| accessRightsReference || AnyURI || 1 || NP || NP || M
 
|-
 
|-
 
| subscriptionsReference || AnyURI || 1 || NP || NP || M
 
| subscriptionsReference || AnyURI || 1 || NP || NP || M
 +
|-
 +
| mgmtObjsReference || AnyURI || 0..1 || NP || NP || M
 
|-
 
|-
 
| notificationChannelsReference || AnyURI || 1 || NP || NP || M
 
| notificationChannelsReference || AnyURI || 1 || NP || NP || M
 +
|-
 +
| m2mPocsReference || AnyURI || 0..1 || NP || NP || M
 +
|-
 +
| attachedDevicesReference || AnyURI || 0..1 || NP || NP || M
 
|}
 
|}
  
Line 44: Line 64:
 
<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="application" type="tns:Application" />
+
   <element name="scl" type="tns:Scl" />
−
   <complexType name="Application">
+
   <complexType name="Scl">
 
     <all>
 
     <all>
 +
      <element ref="tns:pocs" minOccurs="0" />
 +
      <element ref="tns:remTriggerAddr" minOccurs="0" />
 +
      <element ref="tns:onlineStatus" minOccurs="0" />
 +
      <element ref="tns:serverCapability" minOccurs="0" />
 +
      <element ref="tns:link" minOccurs="0" />
 +
      <element ref="tns:schedule" minOccurs="0" />
 
       <element ref="tns:expirationTime" minOccurs="0" />
 
       <element ref="tns:expirationTime" minOccurs="0" />
 
       <element ref="tns:accessRightID" minOccurs="0" />
 
       <element ref="tns:accessRightID" minOccurs="0" />
Line 52: Line 78:
 
       <element ref="tns:creationTime" minOccurs="0" />
 
       <element ref="tns:creationTime" minOccurs="0" />
 
       <element ref="tns:lastModifiedTime" minOccurs="0" />
 
       <element ref="tns:lastModifiedTime" minOccurs="0" />
−
       <element ref="tns:announceTo" minOccurs="0" />
+
       <element ref="tns:locTargetDevice" minOccurs="0" />
−
       <element ref="tns:aPoC" minOccurs="0" />
+
       <element ref="tns:mgmtProtocolType" minOccurs="0" />
−
       <element ref="tns:aPoCPaths" minOccurs="0" />
+
       <element ref="tns:integrityValResults" minOccurs="0" />
−
       <element ref="tns:locRequestor" minOccurs="0" />
+
       <element ref="tns:aPocHandling" minOccurs="0" />
 
       <!-- subresources -->
 
       <!-- subresources -->
 
       <element ref="tns:containersReference" minOccurs="0" />
 
       <element ref="tns:containersReference" minOccurs="0" />
 
       <element ref="tns:groupsReference" minOccurs="0" />
 
       <element ref="tns:groupsReference" minOccurs="0" />
 +
      <element ref="tns:applicationsReference" minOccurs="0" />
 
       <element ref="tns:accessRightsReference" minOccurs="0" />
 
       <element ref="tns:accessRightsReference" minOccurs="0" />
 
       <element ref="tns:subscriptionsReference" minOccurs="0" />
 
       <element ref="tns:subscriptionsReference" minOccurs="0" />
 +
      <element ref="tns:mgmtObjsReference" minOccurs="0" />
 
       <element ref="tns:notificationChannelsReference" minOccurs="0" />
 
       <element ref="tns:notificationChannelsReference" minOccurs="0" />
 +
      <element ref="tns:m2mPocsReference" minOccurs="0" />
 +
      <element ref="tns:attachedDevicesReference" minOccurs="0" />
 
     </all>
 
     </all>
−
     <attribute name="appId" type="anyURI"/>
+
     <attribute name="sclId" type="anyURI"/>
 
   </complexType>
 
   </complexType>
−
   <element name="applicationStatus" type="tns:ApplicationStatus" />
+
   <element name="pocs" type="tns:AnyURIList" />
−
   <element name="aPoC" type="anyURI" />
+
   <element name="serverCapability" type="boolean" />
−
   <element name="aPoCPaths" type="tns:APoCPaths" />
+
   <element name="schedule" type="tns:Schedule" />
−
   <element name="locRequestor" type="anySimpleType" />
+
   <element name="remTriggerAddr" type="anyURI" />
−
   <simpleType name="ApplicationStatus">
+
  <element name="locTargetDevice" type="anySimpleType" />
 +
  <element name="mgmtProtocolType" type="tns:MgmtProtocolType" />
 +
  <element name="integrityValResults" type="tns:IntegrityValResults" />
 +
  <element name="m2mPocsReference" type="anyURI" />
 +
  <element name="attachedDevicesReference" type="anyURI" />
 +
   <simpleType name="MgmtProtocolType">
 
     <restriction base="string">
 
     <restriction base="string">
−
       <enumeration value="ONLINE"></enumeration>
+
       <enumeration value="OMA DM"></enumeration>
−
       <enumeration value="OFFLINE"></enumeration>
+
       <enumeration value="BBF TR 069"></enumeration>
−
      <enumeration value="NOT_REACHABLE"></enumeration>
+
 
     </restriction>
 
     </restriction>
 
   </simpleType>
 
   </simpleType>
−
   <complexType name="APoCPaths">
+
   <complexType name="IntegrityValResults">
−
    <sequence>
+
−
      <element ref="tns:aPoCPath" minOccurs="0" maxOccurs="unbounded" />
+
−
    </sequence>
+
−
  </complexType>
+
−
  <element name="aPoCPath" type="tns:APoCPath" />
+
−
  <complexType name="APoCPath">
+
 
     <all>
 
     <all>
−
       <element ref="tns:path"/>
+
       <element name="ivalResults" type="long" />
−
       <element ref="tns:accessRightID" minOccurs="0" />
+
       <element name="signedIvalResult" type="long" />
−
       <element ref="tns:searchStrings" minOccurs="0" />
+
       <element name="secureTimeStamp" type="dateTime" />
 
     </all>
 
     </all>
 
   </complexType>
 
   </complexType>
−
  <element name="path" type="anyURI" />
 
 
</schema>
 
</schema>
 
</source>
 
</source>
Line 145: Line 172:
  
 
<pre>
 
<pre>
−
GET /scl-id/scls/scl-Id
+
GET /nscl/scls/gscl
 
Host: om2m.laas.fr
 
Host: om2m.laas.fr
 
Authorization: Basic xxxxxxxxxxxxxxxxxxx
 
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Line 161: Line 188:
 
     <om2m:searchStrings>
 
     <om2m:searchStrings>
 
         <om2m:searchString>ResourceType/Scl</om2m:searchString>
 
         <om2m:searchString>ResourceType/Scl</om2m:searchString>
−
         <om2m:searchString>ResourceID/gscl</om2m:searchString>
+
         <om2m:searchString>ResourceID/scl-id</om2m:searchString>
 
     </om2m:searchStrings>
 
     </om2m:searchStrings>
 
     <om2m:pocs>
 
     <om2m:pocs>
Line 241: Line 268:
  
 
<pre>
 
<pre>
−
DELETE /sclBase-id/scls/scl-Id
+
DELETE /nscl/scls/gscl
 
Host: om2m.laas.fr
 
Host: om2m.laas.fr
 
Authorization: Basic xxxxxxxxxxxxxxxxxxx
 
Authorization: Basic xxxxxxxxxxxxxxxxxxx

Latest revision as of 16:52, 4 May 2014

Scl resource

This resource represents a registered scl.


Name Type Multiplicity Create Update Response
sclId NMTOKEN 1 M NP M
pocs pocs 1 O O M
remTriggerAddr remTriggerAddr 1 O O O
onlineStatus OnlineStatus 1 NP NP M
serverCapability ServerCapability 1 NP NP M
link AnyURI 1 O O O
schedule Schedule 1 O O O
expirationTime DateTime 1 O O M
accessRightID AnyURI 1 O O O
searchStrings SearchStrings 1 O O M
creationTime DateTime 1 NP NP M
lastModifiedTime DateTime 1 NP NP M
locTargetDevice locTargetDevice 1 O O O
mgmtProtocolType MgmtProtocolType 1 M M M
integrityValResults IntegrityValResults 1 O O O
aPocHandling APocHandling 1 NP NP O
containersReference AnyURI 1 NP NP M
groupsReference AnyURI 1 NP NP M
applicationsReference AnyURI 1 NP NP M
accessRightsReference AnyURI 1 NP NP M
subscriptionsReference AnyURI 1 NP NP M
mgmtObjsReference AnyURI 0..1 NP NP M
notificationChannelsReference AnyURI 1 NP NP M
m2mPocsReference AnyURI 0..1 NP NP M
attachedDevicesReference AnyURI 0..1 NP NP M

Scl 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="scl" type="tns:Scl" />
  <complexType name="Scl">
    <all>
      <element ref="tns:pocs" minOccurs="0" />
      <element ref="tns:remTriggerAddr" minOccurs="0" />
      <element ref="tns:onlineStatus" minOccurs="0" />
      <element ref="tns:serverCapability" minOccurs="0" />
      <element ref="tns:link" minOccurs="0" />
      <element ref="tns:schedule" minOccurs="0" />
      <element ref="tns:expirationTime" minOccurs="0" />
      <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:locTargetDevice" minOccurs="0" />
      <element ref="tns:mgmtProtocolType" minOccurs="0" />
      <element ref="tns:integrityValResults" minOccurs="0" />
      <element ref="tns:aPocHandling" minOccurs="0" />
      <!-- subresources -->
      <element ref="tns:containersReference" minOccurs="0" />
      <element ref="tns:groupsReference" minOccurs="0" />
      <element ref="tns:applicationsReference" minOccurs="0" />
      <element ref="tns:accessRightsReference" minOccurs="0" />
      <element ref="tns:subscriptionsReference" minOccurs="0" />
      <element ref="tns:mgmtObjsReference" minOccurs="0" />
      <element ref="tns:notificationChannelsReference" minOccurs="0" />
      <element ref="tns:m2mPocsReference" minOccurs="0" />
      <element ref="tns:attachedDevicesReference" minOccurs="0" />
    </all>
    <attribute name="sclId" type="anyURI"/>
  </complexType>
  <element name="pocs" type="tns:AnyURIList" />
  <element name="serverCapability" type="boolean" />
  <element name="schedule" type="tns:Schedule" />
  <element name="remTriggerAddr" type="anyURI" />
  <element name="locTargetDevice" type="anySimpleType" />
  <element name="mgmtProtocolType" type="tns:MgmtProtocolType" />
  <element name="integrityValResults" type="tns:IntegrityValResults" />
  <element name="m2mPocsReference" type="anyURI" />
  <element name="attachedDevicesReference" type="anyURI" />
  <simpleType name="MgmtProtocolType">
    <restriction base="string">
      <enumeration value="OMA DM"></enumeration>
      <enumeration value="BBF TR 069"></enumeration>
    </restriction>
  </simpleType>
  <complexType name="IntegrityValResults">
    <all>
      <element name="ivalResults" type="long" />
      <element name="signedIvalResult" type="long" />
      <element name="secureTimeStamp" type="dateTime" />
    </all>
  </complexType>
</schema>

Create Scl

Example Request 

POST /scl-id/applications
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Body:
<om2m:application xmlns:om2m="http://uri.etsi.org/m2m" appId=app-Id> 
 <om2m:searchStrings> 
 <om2m:searchString>Type/sensor</om2m:searchString> 
 <om2m:searchString>Category/temperature</om2m:searchString> 
 <om2m:searchString>Location/Home</om2m:searchString> 
 </om2m:searchStrings> 
</om2m:application>

Example Response 

HTTP/1.1 201 Created
Content-Type: text/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<om2m:application xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" appId="MY_SENSOR">
    <om2m:accessRightID>scl-id/accessRights/AR_ADMIN</om2m:accessRightID>
    <om2m:searchStrings>
        <om2m:searchString>Type/sensor</om2m:searchString>
        <om2m:searchString>Category/temperature</om2m:searchString>
        <om2m:searchString>Location/Home</om2m:searchString>
    </om2m:searchStrings>
    <om2m:expirationTime>2045-12-23T16:15:11.981+01:00</om2m:expirationTime>
    <om2m:creationTime>2014-04-16T15:28:32.981+02:00</om2m:creationTime>
    <om2m:lastModifiedTime>2014-04-16T15:28:32.981+02:00</om2m:lastModifiedTime>
    <om2m:announceTo>
        <om2m:activated>false</om2m:activated>
        <om2m:global>false</om2m:global>
    </om2m:announceTo>
    <om2m:containersReference>scl-id/applications/app-Id/containers</om2m:containersReference>
    <om2m:groupsReference>scl-id/applications/app-Id/groups</om2m:groupsReference>
    <om2m:accessRightsReference>scl-id/applications/app-Id/accessRights</om2m:accessRightsReference>
    <om2m:subscriptionsReference>scl-id/applications/app-Id/subscriptions</om2m:subscriptionsReference>
    <om2m:notificationChannelsReference>scl-id/applications/app-Id/notificationChannels</om2m:notificationChannelsReference>
</om2m:application>

Retrieve Scl

Example Request 

GET /nscl/scls/gscl
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:scl xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" sclId="gscl">
    <om2m:accessRightID>nscl/accessRights/AR_ADMIN</om2m:accessRightID>
    <om2m:searchStrings>
        <om2m:searchString>ResourceType/Scl</om2m:searchString>
        <om2m:searchString>ResourceID/scl-id</om2m:searchString>
    </om2m:searchStrings>
    <om2m:pocs>
        <reference>http://127.0.0.1:8181/om2m</reference>
    </om2m:pocs>
    <om2m:onlineStatus>ONLINE</om2m:onlineStatus>
    <om2m:serverCapability>true</om2m:serverCapability>
    <om2m:link>gscl</om2m:link>
    <om2m:expirationTime>2046-01-10T15:05:02.514+01:00</om2m:expirationTime>
    <om2m:creationTime>2014-05-04T14:18:23.516+02:00</om2m:creationTime>
    <om2m:lastModifiedTime>2014-05-04T14:18:23.516+02:00</om2m:lastModifiedTime>
    <om2m:mgmtProtocolType>OMA DM</om2m:mgmtProtocolType>
    <om2m:containersReference>nscl/scls/gscl/containers</om2m:containersReference>
    <om2m:groupsReference>nscl/scls/gscl/groups</om2m:groupsReference>
    <om2m:applicationsReference>nscl/scls/gscl/applications</om2m:applicationsReference>
    <om2m:accessRightsReference>nscl/scls/gscl/accessRights</om2m:accessRightsReference>
    <om2m:subscriptionsReference>nscl/scls/gscl/subscriptions</om2m:subscriptionsReference>
    <om2m:mgmtObjsReference>nscl/scls/gscl/mgmtObjs</om2m:mgmtObjsReference>
    <om2m:notificationChannelsReference>nscl/scls/gscl/notificationChannels</om2m:notificationChannelsReference>
    <om2m:m2mPocsReference>nscl/scls/gscl/m2mPocs</om2m:m2mPocsReference>
    <om2m:attachedDevicesReference>nscl/scls/gscl/attachedDevices</om2m:attachedDevicesReference>
</om2m:scl>

Update Scl

Example Request 

PUT /scl-id/applications/app-Id
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Body:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<om2m:application xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" >
    <om2m:accessRightID>gscl/accessRights/AR_ADMIN</om2m:accessRightID>
    <om2m:searchStrings>
        <om2m:searchString>Type/sensor</om2m:searchString>
        <om2m:searchString>Category/temperature</om2m:searchString>
        <om2m:searchString>Location/Home</om2m:searchString>
        <om2m:searchString>Unit/Celsus</om2m:searchString>
    </om2m:searchStrings>
</om2m:application>

Example Response 

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<om2m:application xmlns:om2m="http://uri.etsi.org/m2m" xmlns:xmime="http://www.w3.org/2005/05/xmlmime" appId=app-Id>
    <om2m:accessRightID>gscl/accessRights/AR_ADMIN</om2m:accessRightID>
    <om2m:searchStrings>
        <om2m:searchString>Type/sensor</om2m:searchString>
        <om2m:searchString>Category/temperature</om2m:searchString>
        <om2m:searchString>Location/Home</om2m:searchString>
        <om2m:searchString>Unit/Celsus</om2m:searchString>
    </om2m:searchStrings>
    <om2m:expirationTime>2045-12-23T16:15:11.981+01:00</om2m:expirationTime>
    <om2m:creationTime>2014-04-16T15:28:32.981+02:00</om2m:creationTime>
    <om2m:lastModifiedTime>2014-04-16T16:44:33.180+02:00</om2m:lastModifiedTime>
    <om2m:announceTo>
        <om2m:activated>false</om2m:activated>
        <om2m:global>false</om2m:global>
    </om2m:announceTo>
    <om2m:containersReference>scl-id/applications/app-Id/containers</om2m:containersReference>
    <om2m:groupsReference>scl-id/applications/app-Id/groups</om2m:groupsReference>
    <om2m:accessRightsReference>scl-id/applications/app-Id/accessRights</om2m:accessRightsReference>
    <om2m:subscriptionsReference>scl-id/applications/app-Id/subscriptions</om2m:subscriptionsReference>
    <om2m:notificationChannelsReference>scl-id/applications/app-Id/notificationChannels</om2m:notificationChannelsReference>
</om2m:application>

Delete Scl

Example Request 

DELETE /nscl/scls/gscl
Host: om2m.laas.fr
Authorization: Basic xxxxxxxxxxxxxxxxxxx

Example Response 

HTTP/1.1 204 No Content
Retrieved from "https://wiki.eclipse.org/index.php?title=OM2M/Scl&oldid=361973"

This page was last modified 16:52, 4 May 2014 by Eclipsepedia anonymous user Unnamed Poltroon.

Back to the top