Skip to main content

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.

Jump to: navigation, search

OM2M/Resources data model

Definitions

  • Resource: is a uniquely addressable entity in the RESTful architecture. A resource has a representation that shall be transferred and manipulated with the verbs. A resource shall be addressed using a Universal Resource Identifier (URI).
  • Sub-Resource: also called child resource. It is a resource that has a containment relationship with the addressed (parent) resource. The parent resource representation contains references to the children.
  • Attribute: is meta-data that provides properties associated with a resource representation.
  • Attribute-Type: attributes are distinguished by the following types:


Type Description
RW read/write by client
RO Read-Only by client, set by the server
WO Write-once, can be provided at creation, but cannot be changed anymore

SclBase

The sclBase resource shall contain all other resources of the hosting SCL. An sclBase resource is the root of all other resources it contains.

SclBase data model

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

<?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>

Scls

Scl

Applications

Application

Containers

Container

ContentInstances

ContentInstance

AccessRights

AccessRight

Groups

Group

Subscriptions

Subscription

Discovery

Back to the top