APIs Device to Cloud One M2 M NOD -Node

A node (resourceType = 14) represents specific information about a (oneM2M) node / device. It may have specializations of the mgmtObj resource as children, which then represent further hardware and software aspects that can be used to perform management of a node.

Besides of management capabilities a node resource may host AE resources. There exists links between these two resource types in order to show this relationship.

Supported child resources

Child Resources TypeMultiplicityDescription
myCertFileCred0..1This resource is used to configure a certificate or certificate chain which the Managed Entity knows the private key.
battery0..nThe resource provides the power information of the node. (E.g. remaining battery charge).
areaNwkInfo0..nThis resource describes the list of Nodes attached behind the MN/ASN node and its physical or underlying relation among the nodes in the M2M Area Network. This attribute is defined in case the Node is MN/ASN.
areaNwkDeviceInfo0..nThis resource describes the information about the Node in the M2M Area Network.
activeCmdhPolicy0..1This resource defines which of the present cmdhPolicy resource(s) shall be active for the CMDH processing on the CSE hosted on the node represented by this node resource and identified by the hostedCSELink attribute of this node resource.

Universal and common attributes

NameFull NameTypeMultiplicityMode
tyresourceTypem2m:resourceType / integer1RO
riresourceIDm2m:ID / string1RO
rnresourceNamestring1WO
piparentIDm2m:ID / string1RO
lbllabelsm2m:labels / list of string0..1(L)RW
acpiaccessControlPolicyIDsm2m:acpType / list of resouceID0..1(L)RW
ctcreationTimem2m:timestamp1RO
ltlastModifiedTimem2m:timestamp1RO
atannounceTolist of URI0..1 (L)RW
aaannouncedAttributelist of string0..1 (L)RW
dacidynamicAuthorizationConsultationIDslist of URI0..1 (L)RW
cstncustodianID / string0..1RW

Mode: RW = Read/Write, RO = Read Only, WO = Write Once

Resource specific attributes

NameFull NameMultiplicityModeCreateUpdate
ninodeID1RWMO
hclhostedCSELink0..1RWOO
haelhostedAELinks0..1(L)RWMO
hslhostedServiceLinks0..1(L)RWMO
mgcamgmtClientAddress0..1RWMO
nidnetworkID0..1RONPNP
ntynodeType0..1RWMO

Mode: RW = Read/Write, RO = Read Only, WO = Write Once

Request Optionality: NP = not provisioned, O = optional, M = Mandatory

Attribute: ni (nodeID)

The M2M-Node-ID of the node which is represented by this node resource. See also the section on NodeID’s for allowed formats.

This attribute allows to find the CSEBase or remoteCSE resource representing the CSE that is residing on the node that is represented by this node resource. The attribute contains the resource ID of a resource where all of the following applies.

The CSEBase is a CSEBase](../CSEBase) resource or a remoteCSE resource.

The resource represents the CSE which resides on the specific node that is represented by the current node resource.

In case the node that is represented by this node resource does not contain a CSE, this attribute shall not be present.

This attribute allows to find the AEs hosted by the node that is represented by this node resource. The attribute shall contain a list of resource identifiers of resources representing the ADN-AEs residing on the node that is represented by the current node resource.

This attribute allows to find flexContainer resources that have been created by an IPE to represent services hosted on a NoDN, the NoDN being represented by this node resource.

Attribute: mgca (mgmtClientAddress)

Represents the physical address of management client of the node which is represented by this node resource. This attribute is absent if management server is able to acquire the physical address of the management client.

Attribute: nid (networkID)

Configured with the identity of the underlying network which the M2M Node is currently attached to.

Attribute: nty (nodeType)

Indicates the type of node. It shall have one of the following value:

  • UNSPECIFIED = 0 (the default)
  • IN = 1
  • MN = 2
  • ASN = 3
  • ADN = 4
  • NoDN = 5 (for all no-oneM2M devices)

JSON representation example

{
    "m2m:nod": {
        "ct":"20200226T173457,094898",   
        "et":"20210225T173457,094921",   
        "lbl": [ 
          "dmoDeviceProfile:COT", 
          "dmoICCID:89490200020160801101", 
          "dmoRegistrationStatus:registered", 
          "dmoExternalID:96577" 
        ],   
        "lt":"20200226T173457,094898",   
        "nid":"urn:gsma:imei:12345-6789",   
        "pi":"5e7ce4537a80d86edd56ab88",   
        "ri":"5e7ce47e7a80d83f4156ab8c",   
        "rn":"aNode",   
        "hael": [ "5e7ce4937a80d86e4f56ab8e" ],
        "st":0,   
        "ty":14
    }
}

CREATE request

POST {{API_URL}}/device-management-orchestrator/v3/{{TENANT}}
Content-Type:application/json;ty=14
Accept:application/json 
X-M2M-Origin:CAdmin 
X-M2M-RI:1234 

{
    "m2m:nod": {
        "ni": "urn:some:id",
        "rn": "aNode"
    }
}