|
TECHNICAL SPECIFICATION
LTE;
5G;
Management and orchestration;
Design rules for REpresentational State Transfer (REST)
Solution Sets (SS)
(3GPP TS 32.158 version 15.1.0 Release 15)
---------------------- Page: 1 ----------------------
3GPP TS 32.158 version 15.1.0 Release 15 1 ETSI TS 132 158 V15.1.0 (2019-04)
Reference
RTS/TSGS-0532158vf10
Keywords
5G,LTE
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:
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 prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
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
If you find errors in the present document, please send your comment to one of the following services:
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.
© ETSI 2019.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 32.158 version 15.1.0 Release 15 2 ETSI TS 132 158 V15.1.0 (2019-04)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables 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.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Foreword
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or
GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables.
The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under
.
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
---------------------- Page: 3 ----------------------
3GPP TS 32.158 version 15.1.0 Release 15 3 ETSI TS 132 158 V15.1.0 (2019-04)
Contents
Intellectual Property Rights . 2
Foreword . 2
Modal verbs terminology . 2
Foreword . 4
1 Scope . 5
2 References . 5
3 Definitions and abbreviations . 5
3.1 Definitions . 5
3.2 Abbreviations . 6
4 General rules . 6
4.1 Information models and resources . 6
4.1.1 Information models . 6
4.1.2 Resources . 6
4.1.3 Resource archetypes . 6
4.1.4 Mapping of information models to resources . 6
4.2 Managed object naming and resource identification . 7
4.2.1 Managed object naming . 7
4.2.2 Resource identification . 7
4.2.3 Mapping of DNs to URIs . 7
4.3 Media types . 7
4.4 URI structure . 8
4.5 Response status codes . 8
5 Basic design patterns . 8
5.1 Design pattern for creating a resource . 8
5.1.1 Creating a resource with identifier creation by the MnS Producer . 8
5.1.2 Creating a resource with identifier creation by the MnS Consumer . 8
5.2 Design pattern for reading a resource . 9
5.3 Design pattern for updating a resource . 9
5.4 Design pattern for deleting a resource . 10
5.5 Design pattern for subscribe/notify . 10
5.5.1 Concept . 10
5.5.2 Subscription creation . 10
5.5.3 Subscription deletion . 11
5.5.4 Notification emission . 11
5.5.5 Subscription retrieval . 12
6 Advanced design patterns . 12
6.1 Design pattern for scoping and filtering . 12
6.2 Design pattern for attribute selection. 13
6.3 Design pattern for partially updating a resource . 13
7 Resource representation formats . 13
7.1 Introduction . 13
7.2 Top-level object . 14
7.3 Data objects . 14
7.4 Data arrays. 14
7.5 Error objects . 14
7.6 Resource objects . 15
7.7 Resource objects carried in data objects and arrays . 15
8 REST SS specification template . 16
Annex A (informative): Change history . 20
History . 21
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 32.158 version 15.1.0 Release 15 4 ETSI TS 132 158 V15.1.0 (2019-04)
Foreword
This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
The contents of the present document are subject to continuing work within the TSG and may change following formal
TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an
identifying change of release date and an increase in version number as follows:
Version x.y.z
where:
x the first digit:
1 presented to TSG for information;
2 presented to TSG for approval;
3 or greater indicates TSG approved document under change control.
y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,
updates, etc.
z the third digit is incremented when editorial only changes have been incorporated in the document.
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 32.158 version 15.1.0 Release 15 5 ETSI TS 132 158 V15.1.0 (2019-04)
1 Scope
The present document defines design rules for REpresentational State Transfer (REST) Solution Sets (SS). These rules
are applied when specifying REST Solution Sets.
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present
document.
- References are either specific (identified by date of publication, edition number, version number, etc.) or
non-specific.
- For a specific reference, subsequent revisions do not apply.
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including
a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same
Release as the present document.
[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
[2] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content".
[3] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name
convention for Managed Objects".
[4] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax".
[5] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing".
[6] IETF RFC 7159: " The JavaScript Object Notation (JSON) Data Interchange Format".
[7] draft-wright-json-schema-01 (October 2017): "JSON Schema: A Media Type for Describing JSON
Documents".
Editor's note: The above document cannot be formally referenced until it is published as an RFC.
[8] draft-wright-json-schema-validation-01 (October 2017: "JSON Schema Validation: A Vocabulary
for Structural Validation of JSON".
Editor's note: The above document cannot be formally referenced until it is published as an RFC.
[9] draft-wright-json-schema-hyperschema-01 (October 2017): "JSON Hyper-Schema: A Vocabulary
for Hypermedia Annotation of JSON.
Editor's note: The above document cannot be formally referenced until it is published as an RFC.
[10] OpenAPI Specification (https://github.com/OAI/OpenAPI-Specification)
[11] IETF RFC 5789: "PATCH Method for HTTP".
[12] IETF RFC 7396: "JSON Merge Patch".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following
apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP
TR 21.905 [1].
ETSI
---------------------- Page: 6 ----------------------
3GPP TS 32.158 version 15.1.0 Release 15 6 ETSI TS 132 158 V15.1.0 (2019-04)
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An
abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in
3GPP TR 21.905 [1].
CRUD Create, Retrieve, Update, Delete
DN Distinguished Name
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation
LDN Local Distinguished Name
MnS Management Service
REST REpresentational State Transfer
RPC Remote Procedure Call
URI Uniform Resource Identifier
4 General rules
4.1 Information models and resources
4.1.1 Information models
An information model is a representation of a system. Typical models do not reflect all facets of the system, but only
certain aspects required to solve the management problem the model is designed for. 3GPP follows an object-oriented
modelling approach. Models are built from managed object classes. Relationships between classes represent the logical
connections. Models are specified formally with class diagrams of the Unified Modelling Language (UML).
The instantiation of a managed object is called managed object instance. All managed object instances together with the
relationships between them are depicted in an object diagram.
4.1.2 Resources
HTTP uses a different terminology based on the notion of resources, as defined in clause 2 of RFC 7231 [2]. Each
resource is represented by a resource representation as defined in clause 3 of RFC 7231 [2]. Valid resource
representations are e.g. XML instance documents or JSON instance documents.
4.1.3 Resource archetypes
Resources can be classified according to their structure and behaviour into resource archetypes. This helps specifying
clear and understandable interfaces. The following three archetypes are defined:
- Document resource: This is the standard resource containing data in form of name value pairs and links to
related resources. This kind of resource typically represents a real-world object or a logical concept.
- Collection resource: A collection resource is grouping resources of the same kind. The resources below the
collection resource are called items of the collection. An item of a collection is normally a document resource.
Collection resources typically contain links to the items of the collection and information about the collection
like the total number of items in the collection. Collection resources can be further distinguished into server-
managed and client-managed resources. Collection resources are also known as container resources.
- Operation resource: Operation resources represent executable functions. They may have input and output
parameters. Operation resources allow some sort of fall back to an RPC style design in case application specific
actions cannot be mapped easily to CRUD style operations.
4.1.4 Mapping of information models to resources
RESTful SS shall be specified in a way that managed object instances are described by document resources. Collection
resources have no equivalent in an information model unless some dedicated collection class is introduced.
ETSI
---------------------- Page: 7 ----------------------
3GPP TS 32.158 version 15.1.0 Release 15 7 ETSI TS 132 158 V15.1.0 (2019-04)
4.2 Managed object naming and resource identification
4.2.1 Managed object naming
According to TS 32.300 [3] a Distinguished Name (DN) is used in 3GPP to uniquely identify a managed object instance
within a specific name space. A DN is the concatenation of Relative Distinguished Names (RDNs). A RDN is a name
value pair. The name is the naming attribute of the managed object, which is equal to the class name of the managed
object.
A DN in the global name space is globally unique and starts with the RDN of the global root. A DN in a local name
space starts with the RDN of the local root and is unique only within this name space. A DN in a local namespace is
also referred to as Local Distinguished Name (LDN). The DN of the local root relative to the global root is called DN
prefix. The concatenation of DN prefix and LDN is equal to the globally unique DN of a managed object.
The local root is typically the root of the network resource model representing the managed network.
4.2.2 Resource identification
HTTP uses a subset of the generic Uniform Resource Identifier (URI) scheme (RFC 3986 [4]) defined in RFC 7230 [5]
for target resource identification.
http-URI = "http:" "//" authority path-abempty [ "?" query ] [ "#" fragment ]
The path component is an absolute path (one that starts with a single slash character) or empty.
4.2.3 Mapping of DNs to URIs
The slash "/"shall be used as delineator between the naming attribute name and naming attribute value when
constructing a RDN. The naming attribute name shall be equal to the class name.
RDN = "/"{namingAttribute} "/" {namingAttributeValue}
The LDN is the concatenation of RDNs separated as well by a slash "/".
LDN = *( "/" RDN )
The LDN is mapped to the rightmost part of the path component of URIs. The DN prefix is mapped to the remainder of
the path component and to the authority.
URIs ending with a naming attribute value identify a document resource representing a managed object instance.
URIs ending with a naming attribute name (class name) identify a collection resource representing all managed object
instances (document resources)
...