7.2 Resource-Type specific procedures and definitions

7.2.1 Introduction

The present clause defines the resource-type specific details of the resource representations and protocol procedures for each <mgmtObj> specialization defined in clause 7.1.

7.2.2 Resource [registration]

7.2.2.1 Introduction

This specialization of <mgmtObj> is used to convey the service layer configuration information needed to register an AE or CSE with a Registrar CSE.

Table 7.2.2.1-1: Data Type Definition of [registration]

Data Type ID	File Name	Note
registration	DCFG-registration.xsd

Table 7.2.2.1-2: Resource specific attributes of [registration]

Attribute Name	Request Optionality		Data Type
Attribute Name	Create	Update	Data Type
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1020 (registration).
objectIDs	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4]
originatorID	O	O	m2m:ID	CSE-ID of the CSE hosted on the ASN/MN or the AE-ID of an AE hosted on an ASN/MN or ADN node. If the setting is for a CSE, then this attribute shall be present.
pointOfAccess	O	O	m2m:poaList	The point of access URI of the Registrar CSE. Note; protocol binding is determined from the protocol schema in this URI.
CSEBase	O	O	xs:anyURI	No Defaults.
CSE-ID	O	O	m2m:ID	No Defaults.
appID	O	O	m2m:ID	The APP_ID of an AE. This attribute shall only be present when this resource is used for the registration of an AE.
externalID	O	O	m2m:externalID	The M2M-Ext-ID of the ASN/MN CSE. This attribute can be present when the originatorID is a CSE-ID and the CSE uses the dynamic registration defined in clause 7.1.10 Trigger Recipient Identifier of oneM2M TS0001 [2].
Trigger-Recipient-ID	O	O	m2m:triggerRecipientID	The Trigger-Recipient-ID of the ASN/MN CSE. This attribute can be present when the originatorID is a CSE-ID and the CSE uses the dynamic registration defined in clause 7.1.10 Trigger Recipient Identifier of oneM2M TS-0001 [2].
mgmtLink	O	O	m2m:mgmtLinkRef	1 link to a [authenticationProfile] resource instance. See note.
M2M-Sub-ID	O	NP	m2m:ID
NOTE: The SUID in the linked [authenticationProfile] instance constrains the security framework to be used with the Authentication Profile. The security frameworks used with the [registration] resource are Security Association Establishment Frameworks (SAEF). The entity composing a [registration] instance is expected to confirm that the linked Authentication Profile contains a SUID corresponding to an SAEF. The SAEF SUIDs are the values 12, 22, 32 or 42 as defined in oneM2M TS-0004 [4].

7.2.2.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. In addition to the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource following check shall be done in CREATE and UPDATE operation:

If appID attribute is set to a value starting with other than 'r', 'R' or 'N' then the Hosting CSE shall reject the request with "BAD_REQUEST" Response Status Code .

Note

Use of 'r' will be forbidden when subsequently registering an AE that supports release 4 or above.

7.2.3 Resource [dataCollection]

7.2.3.1 Introduction

Table 7.2.3.1-1: Data Type Definition of [dataCollection]

Data Type ID	File Name	Note
dataCollection	DCFG-dataCollection.xsd

Table 7.2.3.1-2: Resource specific attributes of [dataCollection]

Attribute Name	Request Optionality		Data Type
Attribute Name	Create	Update	Data Type
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1021 (dataCollection).
objectIDs	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4]
containerPath	M	O	m2m:ID	The URI of the <container> resource in the hosting CSE that stores the data transmitted by the device.
reportingSchedule	O	O	m2m:scheduleEntries	The schedule, used to transmit the measured or collected data to the Hosting CSE. If the entity that reports the data misses a reporting interval, the entity shall wait until the next interval to report the data.
measurementSchedule	O	O	m2m:scheduleEntries	The schedule, that the device will use to collect or measure the data. If the entity that measures or collects the data misses a measurement interval, the entity shall wait until the next interval to collect or measure the data.
mgmtLink	O	O	m2m:mgmtLinkRef	1 link to a [authenticationProfile]. See note.
NOTE: The SUID in the linked [authenticationProfile] instance constrains the security framework to be used with the Authentication Profile. The security frameworks used with the [dataCollection] resource are End-to-End Security of Primitives (ESPrim). The entity composing a [dataCollection] instance is expected to confirm that the linked Authentication Profile contains a SUID corresponding to ESPrim. The SUIDs corresponding to ESPrim security frameworks are the values 13, 23, 33 or 43 as defined in oneM2M TS-0004 [4].

7.2.3.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource. oneM2M TS-0005 [5] and oneM2M TS0006 [6] provide the mapping of these resources into the technology specific protocol data model.

7.2.4 Resource [authenticationProfile]

7.2.4.1 Introduction

Table 7.2.4.1-1: Data Type Definition of [authenticationProfile]

Data Type ID	File Name	Note
authenticationProfile	DCFG-authenticationProfile.xsd

Table 7.2.4.1-2: Resource specific attributes of [authenticationProfile]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1022 (authenticationProfile).
objectID	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4]
SUID	M	NP	m2m:suid	Allowed values are listed in table 7.1.43.
TLSCiphersuites	O	O	dcfg:listOfTLSCiphersuite
symmKeyID	O	NP	sec:credentialID
symmKeyValue	O	NP	xs:hexBinary	The minimum key length is 256 bits.
MAFKeyRegLabels	O	NP	m2m:labels
MAFKeyRegDuration	O	NP	xs:duration
mycertFingerprint	O	NP	dcfg:niURI or dcfg:nihURI
rawPubKeyID	O	NP	dcfg:niURI or dcfg:nihURI
M2M-Sub-ID	O	NP	m2m:ID
mgmtLink	O	O	See clause 7.4.15 of oneM2M TS-0004 [4]

Table 7.2.4.13: Child resources of [authenticationProfile] resource

Child Resource Type	Child Resource Name	Multiplicity	Ref. to in Resource Type Definition
<subscription>	[variable]	0..n	Clause 7.4.8 of oneM2M TS-0004 [4]

7.2.4.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource. oneM2M TS-0005 [5] and oneM2M TS0006 [6] provide the mapping of these resources into the technology specific protocol data model.

7.2.5 Resource [myCertFileCred]

7.2.5.1 Introduction

Table 7.2.5.1-1: Data Type Definition of [myCertFileCred]

Data Type ID	File Name	Note
myCertFileCred	DCFG-myCertFileCred.xsd

Table 7.2.5.1-2: Resource specific attributes of [myCertFileCred]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1023 (myCertFileCred)
objectID	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4]
SUIDs	M	O	xs:list of m2m:suid	Allowed values are listed in table 7.1.5-3.
myCertFileFormat	M	NP	xs:anyURI	Media Type of myCertFileContent attribute. Default is "application/pkcs7-mime".
myCertFileContent	M	NP	xs:string	Certificate or certificate chain. Default media-type is "application/pkcs7-mime".

Table 7.2.5.13: Child resources of [myCertFileCred] resource

Child Resource Type	Child Resource Name	Multiplicity	Ref. to in Resource Type Definition
<subscription>	[variable]	0..n	Clause 7.4.8 of oneM2M TS-0004 [4]

7.2.5.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource. oneM2M TS-0005 [5] and oneM2M TS0006 [6] provide the mapping of these resources into the technology specific protocol data model.

7.2.6 Resource [trustAnchorCred]

7.2.6.1 Introduction

Table 7.2.6.1-1: Data Type Definition of [trustAnchorCred]

Data Type ID	File Name	Note
trustAnchorCred	DCFG-trustAnchorCred.xsd

Table 7.2.6.1-2: Resource specific attributes of [trustAnchorCred]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1024 (trustAnchorCred)
objectID	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4]
certFingerprint	M	NP	dcfg:niURI
URI	M	O	xs:anyURI

Table 7.2.6.13: Child resources of [trustAnchorCred] resource

Child Resource Type	Child Resource Name	Multiplicity	Ref. to in Resource Type Definition
<subscription>	[variable]	0..n	Clause 7.4.8 of oneM2M TS-0004 [4]

7.2.6.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource. oneM2M TS-0005 [5] and oneM2M TS0006 [6] provide the mapping of these resources into the technology specific protocol data model.

7.2.7 Resource [MAFClientRegCfg]

7.2.7.1 Introduction

Table 7.2.7.1-1: Data Type Definition of [MAFClientRegCfg]

Data Type ID	File Name	Note
MAFClientRegCfg	DCFG-MAFClientRegCfg.xsd

Table 7.2.7.1-2: Resource specific attributes of [MAFClientRegCfg]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1025 (MAFClientRegCfg)
fqdn	M	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]
adminFQDN	M	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]
httpPort	O	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]	At least one of these attributes shall be present
coapPort	O	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]	At least one of these attributes shall be present
websocketPort	O	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]	At least one of these attributes shall be present
mgmtLink	M	O	m2m:mgmtLinkRef	1 link to a [authenticationProfile] resources instance
NOTE: For further details of these attributes, see clauses 8.8.3.2 and 12.4.2 of oneM2M TS-0003 [3].

Table 7.2.7.13: Child resources of [MAFClientRegCfg] resource

Child Resource Type	Child Resource Name	Multiplicity	Ref. to in Resource Type Definition
<subscription>	[variable]	0..n	Clause 7.4.8 of oneM2M TS-0004 [4]

7.2.7.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource. oneM2M TS-0005 [5] and oneM2M TS0006 [6] provide the mapping of these resources into the technology specific protocol data model.

7.2.8 Resource [MEFClientRegCfg]

7.2.8.1 Introduction

Table 7.2.8.1-1: Data Type Definition of [MEFClientRegCfg]

Data Type ID	File Name	Note
MEFClientRegCfg	DCFG-MEFClientRegCfg.xsd

Table 7.2.8.1-2: Resource specific attributes of [MEFClientRegCfg]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1026 (MEFClientRegCfg)
fqdn	M	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]
adminFQDN	M	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]
httpPort	O	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]	At least one of these attributes shall be present
coapPort	O	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]	At least one of these attributes shall be present
websocketPort	O	NP	See table 12.4.2-1 of oneM2M TS-0003 [3]	At least one of these attributes shall be present
mgmtLink	M	O	m2m:mgmtLinkRef
NOTE: For further details of these attributes, see clauses 8.3.7.2 and 12.4.2 of oneM2M TS-0003 [3].

Table 7.2.8.13: Child resources of [MEFClientRegCfg] resource

Child Resource Type	Child Resource Name	Multiplicity	Ref. to in Resource Type Definition
<subscription>	[variable]	0..n	Clause 7.4.8 of oneM2M TS-0004 [4]

7.2.8.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource. oneM2M TS-0005 [5] and oneM2M TS0006 [6] provide the mapping of these resources into the technology specific protocol data model.

7.2.9 Resource [OAuth2Authentication]

7.2.9.1 Introduction

This specialization of <mgmtObj> is used to store access token and refresh token used in OAuth2 security protocol

Table 7.2.9.1-1: Data Type Definition of [OAuth2Authentication]

Data Type ID	File Name	Note
OAuth2Authentication	DCFG-OAuth2.xsd

Table 7.2.9.1-2: Resource specific attributes of [OAuth2Authentication]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1027 (OAuth2Authentication)
objectIDs	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4]
accessToken	M	O	xs:string
refreshToken	M	O	xs:string

7.2.9.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 in oneM2M TS-0004 [4],'_<mgmtObj> specific procedures' shall be used. There are no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource.

7.2.10 Resource [wifiClient]

7.2.10.1 Introduction

This specialization of <mgmtObj> is used to store configuration of Wi-Fi® connection on the client device.

Table 7.2.10.11: Data Type Definition of [wifiClient]

Data Type ID	File Name	Note
wifiClient	DCFG-wifiClient.xsd

Table 7.2.10.12: Resource specific attributes of [wifiClient]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4]	1028 (wifiClient)
objectIDs	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4]
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4]
ssid	M	O	dcfg:ssid
credentials	O	O	dcfg:wifiCredentials
macAddress	O	O	xs:string
channel	O	O	xs:integer
update	O	O	xs:boolean
scan	M	O	xs:boolean
toggleRadioStatus	O	O	xs:boolean
scanResult	O	O	dcfg:listOfSsids
updateStatus	O	O	m2m:actionStatus
connectionStatus	O	O	dcfg:wifiConnectionStatus
radioStatus	O	O	xs:boolean

7.2.10.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4],'<mgmtObj> specific procedures' shall be used. There are no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource except retrieve operation which is described below.

7.2.11 Resource [credentials]

7.2.11.1 Introduction

This specialization of <mgmtObj> is used to store credentials on the client device for authentications.

Table 7.2.11.11: Data Type Definition of [credentials]

Data Type ID	File Name	Note
credentials	DCFG-credentials-v4_0_0.xsd

Table 7.2.11.12: Resource specific attributes of [credentials]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4].	1029 (credentials)
objectIDs	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4].
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4].
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4].
purpose	O	O	xs:string
credentialID	O	O	xs:string
credentialSecret	O	O	xs:string
credentialToken	O	O	Xs:string

7.2.11.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4] shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource.

7.2.12 Resource [SIM]

7.2.12.1 Introduction

This specialization of <mgmtObj> is used to store configuration of Subscriber Identification Module (SIM) and status information.

Table 7.2.12.11: Data Type Definition of [SIM]

Data Type ID	File Name	Note
SIM	DCFG-SIM.xsd

Table 7.2.12.12: Resource specific attributes of [SIM]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4].	1030 (SIM)
objectIDs	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4].
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4].
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4].
imsi	O	O	dcfg:imsi
iccid	M	NP	dcfg:iccid
simStatus	O	O	dcfg:simStatus
simType	O	O	dcfg:simType
serviceProviderName	O	O	xs:string

7.2.12.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource. oneM2M TS-0005 [5] and oneM2M TS 0006 [6] provide the mapping of these resources into the technology specific protocol data model.

7.2.13 Resource [mobileNetwork]

7.2.13.1 Introduction

This specialization of <mgmtObj> is used to store configuration of the currently connected mobile network.

Table 7.2.13.11: Data Type Definition of [mobileNetwork]

Data Type ID	File Name	Note
mobileNetwork	DCFG-mobileNetwork.xsd

Table 7.2.12.12: Resource specific attributes of [mobileNetwork]

Attribute Name	Request Optionality		Data Type	Default Value and Constraints
Attribute Name	Create	Update	Data Type	Default Value and Constraints
mgmtDefinition	M	NP	See clause 7.4.15 of oneM2M TS-0004 [4].	1031 (mobileNetwork)
objectIDs	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4].
objectPaths	O	NP	See clause 7.4.15 of oneM2M TS-0004 [4].
description	O	O	See clause 7.4.15 of oneM2M TS-0004 [4].
cellularNetworkBearer	O	O	dcfg:cellularNetworkBearerType
radioSignalStrength	O	O	xs:integer
linkQuality	O	O	xs:integer
ipAddresses	O	O	list of m2m:ipAddress
routerIPAddresses	O	O	list of m2m:ipAddress
apn	O	O	dcfg:apn
cellID	O	O	xs:integer
smnc	O	O	xs:integer
smcc	O	O	xs:integer
lac	O	O	dcfg:lac
coverageEnhancementLevel	O	O	dcfg:coverageEnhancementLevel

7.2.13.2 Resource specific procedure on CRUD operations

When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of oneM2M TS-0004 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of oneM2M TS-0004 [4] for operations on this resource. oneM2M TS-0005 [5] and oneM2M TS 0006 [6] provide the mapping of these resources into the technology specific protocol data model.