ETSI TS 118 104 V1.1.0 (2016-03)

ETSI TS 118 104 V1.1.0 (2016-03)






TECHNICAL SPECIFICATION
oneM2M;
Service Layer Core Protocol Specification
(oneM2M TS-0004 version 1.6.0 Release 1)

�

---------------------- Page: 1 ----------------------
oneM2M TS-0004 version 1.6.0 Release 1 2 ETSI TS 118 104 V1.1.0 (2016-03)



Reference
RTS/oneM2M-000004v110
Keywords
IoT, M2M, protocol

ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: +33 4 92 94 42 00  Fax: +33 4 93 65 47 16

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2016.
All rights reserved.

TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members.
TM
3GPP and LTE™ are Trade Marks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
GSM® and the GSM logo are Trade Marks registered and owned by the GSM Association.
ETSI

---------------------- Page: 2 ----------------------
oneM2M TS-0004 version 1.6.0 Release 1 3 ETSI TS 118 104 V1.1.0 (2016-03)
Contents
Intellectual Property Rights . 14
Foreword . 14
1 Scope . 15
2 References . 15
2.1 Normative references . 15
2.2 Informative references . 16
3 Definitions and abbreviations . 17
3.1 Definitions . 17
3.2 Abbreviations . 17
4 Conventions . 18
5 Protocol design principles and requirements . 19
5.1 General introduction . 19
5.2 Introduction . 19
5.2.0 General . 19
5.2.1 Interfaces to the underlying networks . 19
5.3 API design guidelines . 20
5.4 Primitives . 20
5.4.1 Introduction. 20
5.4.2 Primitives modelling . 21
5.4.3 Primitive principles . 22
5.4.4 Serialization of primitives . 22
5.5 Design principles . 22
5.5.1 Introduction. 22
5.5.2 Extensibility . 22
5.5.3 Scalability . 22
5.5.4 Fault tolerance and robustness . 23
5.5.5 Efficiency . 23
5.5.6 Inter-operability . 23
5.5.7 Self-operation and self-management . 23
6 oneM2M protocols/API overview . 23
6.1 Introduction . 23
6.2 Addressing . 24
6.2.1 Introduction. 24
6.2.2 Summary of oneM2M Identifiers . 24
6.2.3 oneM2M Entity Addressing . 25
6.2.4 oneM2M Resource Addressing. 26
6.3 Common data types . 27
6.3.1 Introduction. 27
6.3.2 Simple data types incorporated from XML schema . 27
6.3.3 oneM2M simple data types . 29
6.3.4 oneM2M enumerated data types . 32
6.3.4.1 Introduction . 32
6.3.4.2 Enumeration type definitions . 32
6.3.4.2.1 m2m:resourceType . 32
6.3.4.2.2 m2m:cseTypeID . 33
6.3.4.2.3 m2m:locationSource . 33
6.3.4.2.4 m2m:stdEventCats . 33
6.3.4.2.5 m2 m:operation . 33
6.3.4.2.6 m2m:responseType . 33
6.3.4.2.7 m2m:resultContent . 34
6.3.4.2.8 m2m:discResType . 34
6.3.4.2.9 m2m:responseStatusCode . 34
6.3.4.2.10 m2m:requestStatus . 34
6.3.4.2.11 m2m:memberType . 35
ETSI

---------------------- Page: 3 ----------------------
oneM2M TS-0004 version 1.6.0 Release 1 4 ETSI TS 118 104 V1.1.0 (2016-03)
6.3.4.2.12 m2m:consistencyStrategy . 35
6.3.4.2.13 m2m:cmdType . 35
6.3.4.2.14 m2m:execModeType . 36
6.3.4.2.15 m2m:execStatusType . 36
6.3.4.2.16 m2m:execResultType . 36
6.3.4.2.17 m2m:pendingNotification . 37
6.3.4.2.18 m2m:notificationContentType . 37
6.3.4.2.19 m2m:notificationEventType . 37
6.3.4.2.20 m2m:status . 38
6.3.4.2.21 m2m:batteryStatus . 38
6.3.4.2.22 m2m:mgmtDefinition . 38
6.3.4.2.23 m2m:logTypeId . 39
6.3.4.2.24 m2m:logStatus . 39
6.3.4.2.25 m2m:eventType . 39
6.3.4.2.26 m2m:statsRuleStatusType . 40
6.3.4.2.27 m2m:statModelType . 40
6.3.4.2.28 m2m:encodingType . 40
6.3.4.2.29 m2m:accessControlOperations . 40
6.3.4.2.30 m2m:SRole-ID . 41
6.3.4.2.31 m2m:filterUsage . 41
6.3.5 Complex data types . 41
6.3.5.1 Introduction . 41
6.3.5.2 m2m:deliveryMetaData . 41
6.3.5.3 m2m:aggregatedRequest . 41
6.3.5.4 m2m:metaInformation . 42
6.3.5.5 m2m:primitiveContent . 42
6.3.5.6 m2m:batchNotify . 42
6.3.5.7 m2m:eventNotificationCriteria . 42
6.3.5.8 m2m:filterCriteria . 43
6.3.5.9 m2m:attribute . 43
6.3.5.10 (void) . 43
6.3.5.11 m2m:scheduleEntries . 43
6.3.5.12 m2m:aggregatedNotification . 44
6.3.5.13 m2m:notification . 44
6.3.5.14 m2m:actionStatus . 45
6.3.5.15 m2m:anyArgType . 45
6.3.5.16 m2m:resetArgsType . 45
6.3.5.17 m2m:rebootArgsType . 45
6.3.5.18 m2m:uploadArgsTypes . 45
6.3.5.19 m2m:downloadArgsType . 46
6.3.5.20 m2m:softwareInstallArgsType . 46
6.3.5.21 m2m:softwareUpdateArgsType . 46
6.3.5.22 m2m:softwareUninstallArgsType . 46
6.3.5.23 m2m:execReqArgsListType. 47
6.3.5.24 m2m:mgmtLinkRef . 47
6.3.5.25 m2m:resourceWrapper . 47
6.3.5.26 m2m:setOfAcrs . 48
6.3.5.27 m2m:accessControlRule . 48
6.3.5.28 m2m:locationRegion . 49
6.3.5.29 m2m:childResourceRef . 49
6.3.5.30 m2m:responseT ypeInfo . 49
6.3.5.31 m2m:rateLimit . 49
6.3.5.32 m2m:operationResult . 50
6.3.5.33 m2m:aggregatedResponse . 50
6.3.6 Universal and Common attributes . 50
6.4 Message parameter data types . 53
6.4.1 Request primitive parameter data types . 53
6.4.2 Response primitive parameter data types. 54
6.5 Resource data types . 54
6.5.1 Description . 54
6.5.2 resource . 55
6.5.2.1 Description . 55
ETSI

---------------------- Page: 4 ----------------------
oneM2M TS-0004 version 1.6.0 Release 1 5 ETSI TS 118 104 V1.1.0 (2016-03)
6.5.2.2 Reference . 55
6.5.2.3 Usage . 55
6.5.3 regularResource . 55
6.5.3.1 Description . 55
6.5.3.2 Reference . 55
6.5.3.3 Usage . 55
6.5.4 announceableResource . 56
6.5.4.1 Description . 56
6.5.4.2 Reference . 56
6.5.4.3 Usage . 56
6.5.5 announcedResource . 56
6.5.5.1 Description . 56
6.5.5.2 Reference . 56
6.5.5.3 Usage . 56
6.5.6 announceableSubordinateResource . 56
6.5.6.1 Description . 56
6.5.6.2 Reference . 56
6.5.6.3 Usage . 56
6.5.7 announcedSubordinateResource . 57
6.5.7.1 Description . 57
6.5.7.2 Reference . 57
6.5.7.3 Usage . 57
6.6 Response status codes . 57
6.6.1 Introduction. 57
6.6.2 RSC framework overview . 57
6.6.3 Definition of Response Status Codes . 57
6.6.3.1 Overview . 57
6.6.3.2 Informational response class . 57
6.6.3.3 Successful response class . 57
6.6.3.4 Redirection response class . 58
6.6.3.5 Originator Error response class . 58
6.6.3.6 Receiver Error response class . 58
6.6.3.7 Network System Error response class . 58
6.7 oneM2M specific MIME media types . 59
6.8 Virtual Resources . 60
7 oneM2M procedures. 60
7.1 Introduction . 60
7.2 Primitive format and generic procedure . 60
7.2.1 Primitive format . 60
7.2.1.1 Request primitive format . 60
7.2.1.2 Response primitive format . 61
7.2.2 Description of generic procedures . 62
7.2.2.1 Generic resource request procedure for originator . 62
7.2.2.2 Generic request procedure for receiver . 64
7.3 Common operations . 68
7.3.1 Originator actions . 68
7.3.1.1 Compose request primitive . 68
7.3.1.2 Send a request to the receiver CSE . 69
7.3.1.3 Wait for response primitive . 69
7.3.1.4 Retrieve the resource . 69
7.3.2 Receiver CSE actions. 69
7.3.2.1 Check the validity of received request primitive . 69
7.3.2.2 Create resource locally . 70
7.3.2.3 Create a success response (acknowledgement) . 71
7.3.2.4 Send response primitive (acknowledgement) . 72
7.
...