APIs Device to Cloud One M2 M CSEBase - Common Services Entity
A CSEBase (resourceType = 5) resource represents the Common Service Entity (CSE) itself, and is the root of a CSE’s resources tree.
Supported child resources
A CSEBase may have most of the other resource types as child resources.
Some of them, however, shall only be located directly under the CSEBase, for example, the AE
or the remoteCSE resource.
| Child Resources Type | Multiplicity | Description |
|---|---|---|
AE | 0..n | An AE
resource represents any kind of application or functionality in a oneM2M system that implements any kind of functional, management, or business logic. |
container | 0..n | The container
resource (resourceType=3) represents a container for data instances. |
flexContainer | 0..n | A flexContainer
represents a customizable container for data instances that can be extended with so-called custom attributes. |
node | 0..n | A node
represents specific information about a (oneM2M) node / device. |
remoteCSE | 0..n | |
CSEBaseAnnc | 0..n |
Universal and common attributes
| Name | Full Name | Type | Multiplicity | Mode |
|---|---|---|---|---|
| ty | resourceType | m2m:resourceType / integer | 1 | RO |
| ri | resourceID | m2m:ID / string | 1 | RO |
| rn | resourceName | string | 1 | WO |
| pi | parentID | m2m:ID / string | 1 | RO |
| lbl | labels | m2m:labels / list of string | 0..1(L) | RW |
| acpi | accessControlPolicyIDs | m2m:acpType / list of resourceID | 0..1(L) | RW |
| ct | creationTime | m2m:timestamp | 1 | RO |
| lt | lastModifiedTime | m2m:timestamp | 1 | RO |
| stateTag | 1 | RW | ||
| announcedAttribute | 0..1(L) | RW | ||
| announcedTo | 0..1(L) | RW | ||
| custodian | 0..1 | RW |
Mode: RW = Read/Write, RO = Read Only, WO = Write Once
Resource specific attributes
| Name | Full Name | Multiplicity | Mode | Create | Update |
|---|---|---|---|---|---|
| cst | cseType | 0..1 | RO | NP | NP |
| csi | CSE-ID | 1 | RO | NP | NP |
| srt | supportedResourceType | 1(L) | RO | NP | NP |
| poa | pointOfAccess | 1(L) | RO | NP | NP |
| nl | nodeLink | 0..1 | RO | NP | NP |
| czs | contentSerialization | 0..1 (L) | RO | NP | NP |
| srv | supportedReleaseVersions | 0..1 (L) | RO | NP | NP |
| ctm | currentTime | 0..1 | RO | NP | NP |
Mode: RW = Read/Write, RO = Read Only, WO = Write Once
Request Optionality: NP = not provisioned, O = optional, M = Mandatory
Attribute: cst (cseType)
Indicates the type of CSE represented by the created resource:
- Mandatory for an (Infrastructure) IN-CSE, hence multiplicity (1).
- Its presence is subject to service provider (SP) configuration in case of an ASN-CSE or a MN-CSE.
Allowed values are:
- 1 = IN_CSE
- 2 = MN_CSE
- 3 = ASN_CSE
Attribute: csi (CSE-ID)
The CSE identifier in SP-relative CSE-ID format.
Attribute: srt (supportedResourceType)
List of the resource types (integer) which are supported in the CSE.
Attribute: poa (pointOfAccess)
Represents the list of physical addresses to be used by remote CSEs to connect to this CSE (e.g. IP address, FQDN). This attribute is exposed to its Registree.
Attribute: nl (nodeLink)
The resource identifier of a node
resource that stores the node specific information of the node on which the CSE represented by this CSEBase resource resides.
Attribute: czs (contentSerialization)
The list of supported serializations of the Content primitive parameter for receiving a request from its registrants. (e.g. XML, JSON). The list shall be ordered so that the most preferred format comes first.
Attribute: srv (supportedReleaseVersions)
List of oneM2M release versions which are supported by the CSE. Starting with Release 2, this attribute is mandatory for a CSE. For CSEs compliant to older releases, this attribute is optional. For CSEs that do not include this attribute, the default release version shall be Release 1.
Attribute: ctm (currentTime)
When the CSE receives a retrieve request targeting this resource or attribute, the CSE samples its current time (e.g. makes an OS call to get the system time) and respond with the value in this attribute. An Originator retrieving this attribute can use this time value to adjust and synchronize its time value to the time value of this CSE.
JSON representation example
{
"m2m:cb": {
"csi": "5e67931460a2779b6545cfd5",
"cst": 1,
"csz": [
"application/json",
"application/vnd.onem2m-res+json"
],
"ct": "20200130T102614,841666",
"et": "20210129T102614,841695",
"lt": "20200130T102615,066693",
"pi": "",
"ri": "5e67931460a2779b6545cfd5",
"rn": "eos",
"srt": [
2,5,13,14,28
],
"srv": [
"3"
],
"st": 1,
"ty": 5
}
}