ETSI TS 118 109 V2.6.1 (2016-09)

oneM2M; HTTP Protocol Binding (oneM2M TS-0009 version 2.6.1 Release 2)

RTS/oneM2M-000009v200

General Information

• Status: Published
• Publication Date: 08-Sep-2016
• Technical Committee: oneM2M - oneM2M
• Current Stage: 12 - Completion
• Completion Date: 09-Sep-2016

Standards Content (Sample)

ETSI TS 118 109 V2.6.1 (2016-09)






TECHNICAL SPECIFICATION
oneM2M;
HTTP Protocol Binding
(oneM2M TS-0009 version 2.6.1 Release 2)

---------------------- Page: 1 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 2 ETSI TS 118 109 V2.6.1 (2016-09)



Reference
RTS/oneM2M-000009v200
Keywords
IoT, M2M, protocol

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

Tel.: [phone]  Fax: [phone]

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-0009 version 2.6.1 Release 2 3 ETSI TS 118 109 V2.6.1 (2016-09)
Contents
Intellectual Property Rights . 5
Foreword . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 7
3 Abbreviations . 7
4 Conventions . 7
5 Overview on HTTP Binding . 7
5.0 Overview . 7
5.1 Introduction . 7
5.2 Request-Line . 8
5.3 Status-Line . 8
6 HTTP Message Mapping. 9
6.1 Introduction . 9
6.2 Parameter Mappings on Request-Line . 9
6.2.1 Method . 9
6.2.2 Request-Target . 9
6.2.2.1 Path component . 9
6.2.2.2 Query component . 10
6.2.3 HTTP-Version . 12
6.3 Status-Line . 13
6.3.1 HTTP-Version . 13
6.3.2 Status-Code . 13
6.3.3 Reason-Phrase . 14
6.4 Header Fields . 15
6.0 Introduction. 15
6.4.1 Host . 15
6.4.2 Accept . 15
6.4.3 Content-Type . 15
6.4.4 Content-Location . 15
6.4.5 Content-Length . 15
6.4.6 Etag . 16
6.4.7 X-M2M-Origin . 16
6.4.8 X-M2M-RI . 16
6.4.9 Void . 16
6.4.10 X-M2M-GID. 16
6.4.11 X-M2M-RTU . 16
6.4.12 X-M2M-OT . 16
6.4.13 X-M2M-RST . 16
6.4.14 X-M2M-RET . 16
6.4.15 X-M2M-OET . 16
6.4.16 X-M2M-EC. 17
6.4.17 X-M2M-RSC . 17
6.4.18 X-M2M-ATI . 17
6.4.19 Authorization . 17
6.5 Message-body . 18
6.6 Message Routing . 18
7 Security Consideration . 18
7.1 Authentication on HTTP Request Message . 18
7.2 Transport Layer Security . 18
Annex A (informative): Example Procedures . 19
ETSI

---------------------- Page: 3 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 4 ETSI TS 118 109 V2.6.1 (2016-09)
A.1 resource creation . 19
Annex B (informative): WebSocket . 20
B.1 Notification using WebSocket . 20
History . 21

ETSI

---------------------- Page: 4 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 5 ETSI TS 118 109 V2.6.1 (2016-09)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This Technical Specification (TS) has been produced by ETSI Partnership Project oneM2M (oneM2M).
ETSI

---------------------- Page: 5 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 6 ETSI TS 118 109 V2.6.1 (2016-09)
1 Scope
The present document will cover the protocol specific part of communication protocol used by oneM2M compliant
systems as RESTful HTTP binding.
The scope of the present document is (not limited to as shown below):
• Binding oneM2M Protocol primitive types to HTTP method.
• Binding oneM2M response status codes (successful/unsuccessful) to HTTP response codes.
• Binding oneM2M RESTful resources to HTTP resources.
The present document is depending on Core Protocol specification (ETSI TS 118 104 [3]) for data types.
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference/.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] IETF RFC 7230 (June 2014): "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and
Routing".
[2] ETSI TS 118 103: "oneM2M; Security Solutions (oneM2M TS-0003)".
[3] ETSI TS 118 104: "oneM2M; Service Layer Core Protocol Specification (oneM2M TS-0004)".
[4] IETF RFC 7235 (June 2014): "Hypertext Transfer Protocol (HTTP/1.1): Authentication".
[5] IETF RFC 6750 (October 2012): "The OAuth 2.0 Authorization Framework: Bearer Token
Usage".
[6] ETSI TS 118 111: "oneM2M; Common Terminology (oneM2M TS-0011)".
[7] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)".
[8] IETF RFC 7232 (June 2014): "Hypertext Transfer Protocol (HTTP/1.1): "Conditional Requests".
[9] IETF RFC 3986 (January 2005): "Uniform Resource Identifier (URI): Generic Syntax".
ETSI

---------------------- Page: 6 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 7 ETSI TS 118 109 V2.6.1 (2016-09)
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] oneM2M Drafting Rules.
NOTE: Available at http://www.onem2m.org/images/files/oneM2M-Drafting-Rules.pdf.
[i.2] Void.
[i.3] Void.
[i.4] IETF RFC 6455 (December 2011):"The WebSocket Protocol".
[i.5] Void.
3 Abbreviations
For the purposes of the present document, the abbreviations given in ETSI TS 118 111 [6] apply and the following
apply:
HTTP Hyper Text Transfer Protocol
TLS Transport Layer Security
URI Uniform Resource Identifier
4 Conventions
The keywords "Shall", "Shall not", "May", "Need not", "Should", "Should not" in this document are to be interpreted as
described in the oneM2M Drafting Rules [i.1].
5 Overview on HTTP Binding
5.0 Overview
HTTP binding specifies the equivalence between oneM2M request and response primitives and HTTP request and
response messages, respectively. This clause provides a brief overview on the mapping relationship between oneM2M
and HTTP message parameters.
This clause describes how oneM2M request/response primitives can be mapped to HTTP request/response messages
and vice versa.
5.1 Introduction
Figure 5.1-1 illustrates an example oneM2M system configuration and its correspondence to an HTTP-based
information system if HTTP binding as defined in this specification is applied. The upper diagram in figure 5.1-1 shows
with solid line arrows the flow of a request primitive originating from an AE which is registered to an MN-CSE
(Registrar of AE). The request primitive is assumed to address a resource which is hosted by another MN-CSE (Host of
Resource). Both MN-CSEs are registered to the same IN-CSE.
ETSI

---------------------- Page: 7 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 8 ETSI TS 118 109 V2.6.1 (2016-09)
When applying HTTP binding, the oneM2M entities of the upper diagram take the roles outlined in the lower diagram
of a corresponding HTTP information system as defined in IETF RFC 7230 [1]. The AE takes the role of an HTTP
client, the MN-CSE (Registrar of AE) takes the role of a HTTP Proxy Server, and both the IN-CSE and MN-CSE (Host
of Resource) take the role of a HTTP server for this particular request message.
CSEs may also issue unsolicited request messages, shown with dashed line arrows in figure 5.1-1, and receive
associated response messages. Therefore, for HTTP protocol binding, CSEs generally provides capability of both HTTP
Server and HTTP Client. AEs may provide HTTP Server capability optionally in order to be able to serve Notification
request messages (see ETSI TS 118 104 [3] and ETSI TS 118 101 [7]).

Figure 5.1-1 : Correspondence between oneM2M entities and HTTP Client and Server
Each individual request primitive will be mapped to single HTTP request message, and each individual response
primitive will be mapped to a single HTTP response message, and vice-versa.
An HTTP request message consists of Request-Line, headers and message-body. An HTTP response message consists
of Status-Line, headers and message-body [1]. HTTP header names are case-insensitive and a Receiver shall accept
headers that are either lower or upper or any mixture thereof. This clause describes how oneM2M request/response
primitives are mapped to HTTP messages at a high level. Corresponding details are specified in clause 6.
5.2 Request-Line
The HTTP method of a request message is mapped to the Operation parameter, and vice-versa.
At the message originator side the HTTP Request-Target is derived from the To parameter of the request primitive,
including a query string which carries other specific primitive parameters.
HTTP-Version is specified in clause 6.
5.3 Status-Line
HTTP Version is specified in clause 6.
The Status-Code of HTTP response messages is derived from the Response Status Code parameter of the response
primitive. The Reason-Phrase is not applicable to oneM2M systems and is omitted.
ETSI

---------------------- Page: 8 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 9 ETSI TS 118 109 V2.6.1 (2016-09)
6 HTTP Message Mapping
6.1 Introduction
Mapping between oneM2M primitives and HTTP messages shall be applied in the following four use cases:
1) Mapping of request primitive to HTTP request message at the request originator (HTTP client)
2) Mapping of HTTP request message to request primitive at the request receiver (HTTP server)
3) Mapping of response primitive to HTTP response message at the request receiver (HTTP server)
4) Mapping of HTTP response message to response primitive at the request originator (HTTP client)
All four use cases also appear at transit CSEs.
The following clauses specify the mapping between each oneM2M primitive parameter and a corresponding HTTP
message field to compose a HTTP request/response message.
6.2 Parameter Mappings on Request-Line
6.2.1 Method
The HTTP 'Method' shall be derived from the Operation request primitive parameter of the request primitive.
Table 6.2.1-1: HTTP Method Mapping
oneM2M Operation HTTP Method
Create POST
Retrieve GET
Update PUT
Delete DELETE
Notify POST

At the Receiver, an HTTP request message with POST method shall be mapped either to a Create or Notify Operation
parameter. Discrimination between Create and Notify operations can be accomplished by inspection of the content-type
header. The Resource Type parameter is present in the content-type header only when the HTTP POST request
represents a Create request (see clause 6.4.3). The Resource Type parameter is not present in the content-type header
when the HTTP POST request represents a Notify request.
6.2.2 Request-Target
6.2.2.1 Path component
The path component of the origin-form HTTP Request-Target shall be interpreted as the mapping of the resource
identifier part of the To request primitive parameter. If the HTTP message is sent directly to the next hop CSE, the
origin-form of Request-Target shall be employed (see clause 5.3.1 of IETF RFC 7230 [1]).
The resource identifier part of the To parameter can be represented in three different forms (see clause 6.2.3 of ETSI
TS 118 104 [3] and clause 7.2 of ETSI TS 118 101 [7]):
• CSE-Relative-Resource-ID,
• SP-Relative-Resource-ID,
• Absolute-Resource-ID.
Each of the above three formats may include either a structured Resource ID (used for hierarchical addressing) or an
unstructured Resource ID (used for non-hierarchical addressing) as defined in clause 7.2 of ETSI TS 118 101 [7].
ETSI

---------------------- Page: 9 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 10 ETSI TS 118 109 V2.6.1 (2016-09)
For CSE-relative Resource ID representation, the path component of the HTTP request message shall be constructed as
the concatenation of the literal "/" and the To request primitive parameter. For SP-relative Resource ID representation,
the path component of the HTTP request message shall be constructed as the concatenation of the literal "/~" and the To
request primitive parameter. For Absolute Resource ID representation, the path component of the HTTP request
message shall be constructed by replacing the first "/" character of the To request primitive parameter with "/_".
Table 6.2.2.1-1 shows valid mappings between the To request primitive parameter and the path component of the
origin-form HTTP request target. In the shown examples, /myCSEID and /CSE178 represent applicable CSI-IDs,
CSEBase represents the resource name of a resource, CSEBase/ae12/cont27/contInst696 represents a
structured CSE-relative resource ID, and cin00856 an unstructured CSE-relative resource ID.
Table 6.2.2.1-1: Mapping examples between To parameter and path component of request-line
Resource-ID Type To parameter value path component (origin-form)
structured CSE- CSEBase/ae12/cont27/contInst696 /CSEBase/ae12/cont27/contInst696/
Relative
unstructured CSE-cin00856 /cin00856
Relative
structured SP-Relative /CSE178/CSEBase/ae12/cont27/contInst696 /~/CSE178/CSEBase/ae12/cont27/contInst696
unstructured SP-/CSE178/cin00856 /~/CSE178/cin00856
Relative
structured Absolute //mym2msp.org/CSE178/CSEBase/ /_/mym2msp.org/CSE178/CSEBase/
ae12/cont27/contInst696 ae12/cont27/contInst696
unstructured Absolute //mym2msp.org/CSE178/cin00856 /_/mym2msp.org/CSE178/cin00856

At the HTTP server side, the reverse operations shall be applied to the path component of request-line to derive a
replica of the original To request primitive parameter.
If the HTTP message is sent to a HTTP proxy instead directly to the next hop CSE, the absolute-form of Request-Target
shall be employed (see clause 5.3.2 of IETF RFC 7230 [1]). The absolute-form is derived by prefixing the origin-form
with the schema and the host address of the next hop CSE:
http://{host address of next hop CSE}{origin-form path-component}
6.2.2.2 Query component
The query component (e.g. query-string) may include the optional primitive parameters listed in table 6.2.2-1 compliant
with IETF RFC 7230 [1]. Each applicable request primitive parameters and elements of Filter Criteria parameter
shown in table 6.2.2-1 shall be represented as pair of field-name and value in query-string. Multiple such pairs shall be
concatenated with an ampersand '&' character used as separator between two pairs.
Table 6.2.2-1 also shows the permitted multiplicity of occurrence of field names in the query-string. Multiplicity '0.1'
means that a parameter is optional and can occur at most once. Parameters with multiplicity '0.n', may occur multiple
times in the query-string in the form of = value. For example, if the resourceType element of the
Filter Criteria parameter is represented by a list of 3 values '2 3 4' (see clause 6.3.4.7 in ETSI TS 118 104 [3]), it would
be mapped to ty=2+3+4 in the query-string. At the receiver side, this query string can be reverted back into the list type
of representation. The same representation shall be applied for multiple occurrences of contentType and labels
elements.
The 'attribute' element of the Filter Criteria request primitive parameter consists of two elements, name and value,
which in XML notation would look for example as follows in case of multiplicity 2 (see clause 6.2.4.8 in ETSI
TS 118 104 [3]):
    
      attname1
      attvalue1
    
    
      attname2
      attvalue2
    
ETSI

---------------------- Page: 10 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 11 ETSI TS 118 109 V2.6.1 (2016-09)
Each name (e.g. attname1 and attname2) shall represent a valid resource attribute name of the resource types indicated
in the ty field of the query-string. The sequence of attribute elements as shown in the above example will be mapped
into the query-string as attname1=attvalue1&attname2=attvalue2. The attribute names (i.e. attname1 and attname2 in
the above example) shall be expressed in the form of short names as defined in clause 8.2.3 of ETSI TS 118 104 [3].
Note that the tag of the XML representation is omitted in the HTTP binding.
Examples of valid Request-Target representations are the following:
EXAMPLE 1): Request-Target for 'nonBlockingRequestSynch'
Primitive parameters: To:   /CSE1234/RCSE78/container234    (SP-Relative-Resource-ID)
Response Type:    responseType = 1      (nonBlockingRequestSynch)
Result Persistence: P1Y2M3DT10H1M0S Request-Target:
/CSE1234/RCSE78/container234?rt=1&rp=P1Y2M3DT10H1M0S
EXAMPLE 2): Request-Target for Discovery
When the entity wants to discover container resources where the creator attribute has the value 'Sam':
Primitive parameters: To:   /CSE1234/RCSE78
    Filter Criteria: resourceType = 3      (container)
                                     attribute name: creator
                                     attribute value: Sam
       filterUsage = discovery
Request-Target:  /CSE1234/RCSE78?ty=3&cr=Sam&fu=1
EXAMPLE 3): Semantic Discovery
The entity wants to discover resources whose semantic description stored in the descriptor attribute of a
child resource fulfils the semantic filter specified in SPARQL. In this case, the semantic
descriptor of the resource to discover has to contain information about a Thing of type Car based on the concept defined
in the "myOnt" ontology.
Due to the use of reserved characters in SPARQL, the semanticsFilter requires "percent-encoding" [9].
Primitive parameters: To:   /CSE1234/RCSE78
Filter Criteria: semanticsFilter =
PREFIX rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#
PREFIX myOnt: http://www.onem2m.org/ontology/myontology#
SELECT ?car WHERE { ?car rdf:type myOnt:Car }
Request-Target:    /CSE1234/RCSE78?smf=PREFIX%20rdf%3A%20%3Chttp%3A%2F%2
              Fwww.w3.org%2F1999%2F02%2F22-rdf-syntax-ns%23%3E%20PREFI
              X%20myOnt%3A%20%3Chttp%3A%2F%2Fwww.onem2m.org%2Fonto
             logy%2Fmyontology%23%3E%20SELECT%20%3Fcar%20WHERE%20
             %7B%20%3Fcar%20%20rdf%3Atype%20myOnt%3ACar%20%7D
Any of the short names listed in table 6.2.2.2-1, with the exception of 'atr', may be used in the query-string. The short
name 'atr' itself is not used. Instead, any of the resource attribute short names as listed in tables 8.2.3-1 to 8.2.3-5 in
ETSI TS 118 104 [3] may be used in the query-string in representations of attname=attvalue expressions, except those
that shall be omitted (see clause 7.3.3.17.9 in ETSI TS 118 104 [3]).
ETSI

---------------------- Page: 11 ----------------------
oneM2M TS-0009 version 2.6.1 Release 2 12 ETSI TS 118 109 V2.6.1 (2016-09)
Table 6.2.2.2-1: oneM2M request parameters mapped as query-string field
Request Primitive Parameter Query Field Multiplicity Note
Name
Response Type rt 0.1 responseType element of data type
responseTypeInfo (cf. clause 6.
...