|
TECHNICAL SPECIFICATION
5G;
5G System;
Common Data Types for Service Based Interfaces;
Stage 3
(3GPP TS 29.571 version 15.0.0 Release 15)
---------------------- Page: 1 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 1 ETSI TS 129 571 V15.0.0 (2018-09)
Reference
RTS/TSGC-0429571vf00
Keywords
5G
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 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
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 2018.
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 protected for the benefit of its Members.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 2 ETSI TS 129 571 V15.0.0 (2018-09)
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 29.571 version 15.0.0 Release 15 3 ETSI TS 129 571 V15.0.0 (2018-09)
Contents
Intellectual Property Rights . 2
Foreword . 2
Modal verbs terminology . 2
Foreword . 5
1 Scope . 6
2 References . 6
3 Definitions and abbreviations . 7
3.1 Definitions . 7
3.2 Abbreviations . 7
4 Overview . 7
5 Common Data Types . 7
5.1 Introduction . 7
5.2 Data Types for Generic Usage . 7
5.2.1 Introduction. 7
5.2.2 Simple Data Types . 7
5.2.3 Enumerations . 11
5.2.3.1 Enumeration: PatchOperation . 11
5.2.4 Structured Data Types . 11
5.2.4.1 Type: ProblemDetails. 11
5.2.4.2 Type: Link . 11
5.2.4.3 Type PatchItem . 12
5.2.4.4 Type _LinksValueSchema . 12
5.2.4.5 Type _SelfLink . 12
5.2.4.6 Type: InvalidParam . 12
5.3 Data Types related to Subscription, Identification and Numbering . 13
5.3.1 Introduction. 13
5.3.2 Simple Data Types . 13
5.3.3 Enumerations . 14
5.3.3.1 Enumeration: . 14
5.3.4 Structured Data Types . 14
5.3.4.1 Type: Guami . 14
5.3.4.2 Type: NetworkId . 14
5.4 Data Types related to 5G Network . 14
5.4.1 Introduction. 14
5.4.2 Simple Data Types . 14
5.4.3 Enumerations . 16
5.4.3.1 Enumeration: AccessType . 16
5.4.3.2 Enumeration: RatType . 16
5.4.3.3 Enumeration: PduSessionType . 16
5.4.3.4 Enumeration: UpIntegrity . 16
5.4.3.5 Enumeration: UpConfidentiality . 16
5.4.3.6 Enumeration: SscMode . 17
5.4.4.7 Type: RefToBinaryData . 17
5.4.4 Structured Data Types . 17
5.4.4.1 Type: DefaultQosInformation . 17
5.4.4.2 Type: Snssai . 18
5.4.4.3 Type: PlmnId. 18
5.4.4.4 Type: Tai . 18
5.4.4.5 Type: Ecgi . 18
5.4.4.6 Type: Ncgi. 19
5.4.4.7 Type: UserLocation . 19
5.4.4.8 Type: EutraLocation. 19
5.4.4.9 Type: NrLocation . 19
5.4.4.10 Type: N3gaLocation. 19
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 4 ETSI TS 129 571 V15.0.0 (2018-09)
5.4.4.11 Type: UpSecurity . 20
5.5 Data Types related to 5G QoS . 20
5.5.1 Introduction. 20
5.5.2 Simple Data Types . 20
5.5.3 Enumerations . 21
5.5.3.1 Enumeration: PreemptionCapability . 21
5.5.3.2 Enumeration: PreemptionVulnerability . 22
5.5.3.3 Enumeration: ReflectiveQosAttribute . 22
5.5.3.4 Enumeration: DelayCritical. 22
5.5.3.5 Enumeration: NotificationControl . 22
5.5.4 Structured Data Types . 23
5.5.4.1 Type: Arp . 23
5.5.4.2 Type: Ambr . 23
Annex A (normative): OpenAPI specification . 24
A.1 General . 24
A.2 Data related to Common Data Types . 24
Annex B (informative): Change history . 32
History . 33
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 5 ETSI TS 129 571 V15.0.0 (2018-09)
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: 6 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 6 ETSI TS 129 571 V15.0.0 (2018-09)
1 Scope
The present document specifies the stage 3 protocol and data model for common data types that are used or may be
expected to be used by multiple Service Based Interface APIs supported by the same or different Network Function(s).
The Principles and Guidelines for Services Definition are specified in 3GPP TS 29.501 [2].
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] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
[3] OpenAPI: "OpenAPI 3.0.0 Specification", https://github.com/OAI/OpenAPI-
Specification/blob/master/versions/3.0.0.md.
[4] IETF RFC 1166: "Internet Numbers".
[5] IETF RFC 5952: "A recommendation for IPv6 address text representation".
[6] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax".
[7] 3GPP TS 23.003: "Numbering, addressing and identification".
[8] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
[9] IETF RFC 7807: "Problem Details for HTTP APIs".
[10] IETF RFC 3339: "Date and Time on the Internet: Timestamps".
[11] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP) ".
[12] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer".
[13] 3GPP TS 24.007: " Mobile radio interface signalling layer 3; General aspects".
[14] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch".
[15] IETF RFC 4122: "A Universally Unique IDentifier (UUID) URN Namespace"
[16] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1
Application Protocol (S1AP)".
[17] IETF RFC 7042: "IANA Considerations and IETF Protocol and Documentation Usage for IEEE
802 Parameters".
[18] IETF RFC 6733: "Diameter Base Protocol".
ETSI
---------------------- Page: 7 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 7 ETSI TS 129 571 V15.0.0 (2018-09)
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].
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].
5GC 5G Core Network
GPSI Generic Public Subscription Identifier
GUAMI Globally Unique AMF Identifier
PEI Permanent Equipment Identifier
SBI Service Based Interface
SUPI Subscription Permanent Identifier
4 Overview
For the different 5GC SBI API, data types shall be defined. Data types identified as common data types shall be defined
in this Technical specification and should be referenced from individual 5GC SBI API specifications.
Data types applicable or intended to be applicable to several 5GC SBI API specifications should be interpreted as
common data types.
5 Common Data Types
5.1 Introduction
In the following subclauses, common data types for the following areas are defined:
- Data types for generic usage
- Data types for Subscription, Identification and Numbering
- Data types related to 5G Network
- Data types related to 5G QoS
5.2 Data Types for Generic Usage
5.2.1 Introduction
This clause defines common data types for generic usage.
5.2.2 Simple Data Types
This subclause specifies common simple data types.
ETSI
---------------------- Page: 8 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 8 ETSI TS 129 571 V15.0.0 (2018-09)
Table 5.2.2-1: Simple Data Types
ETSI
---------------------- Page: 9 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 9 ETSI TS 129 571 V15.0.0 (2018-09)
Type Name Type Definition Description
Binary string String with format "binary" as defined in OpenAPI Specification [3]
Bytes string String with format "byte" as defined in OpenAPI Specification [3],
i.e, base64-encoded characters,
Date string String with format "date" as defined in OpenAPI Specification [3]
DateTime string String with format "date-time" as defined in
OpenAPI Specification [3]
DiameterIdentity string String with format “DiameterIdentity” according to clause 4.3 of
IETF RFC 6733 [18]. In an OpenAPI Specification [3] schema, the
format shall be designated as string with pattern as '^([A-Za-z0-
9]+(-[A-Za-z0-9]+).)+[a-z]{2,}$'.
Double number Number with format "double" as defined in
OpenAPI Specification [3]
DurationSec integer Unsigned integer identifying a period of time in units of seconds.
In an OpenAPI Specification [3] schema, the format shall be
designated as "DurationSec".
Float number Number with format "float" as defined in
OpenAPI Specification [3]
Uint16 integer Unsigned 16-bit integers, i.e. only value between 0 and 65535 are
permissible.
Int32 integer Integer with format "int32" as defined in OpenAPI Specification [3]
Int64 integer Integer with format "int64" as defined in OpenAPI Specification [3]
Ipv4Addr string String identifying a IPv4 address formatted in the "dotted decimal"
notation as defined in in IETF RFC 1166 [4]. In an
OpenAPI Specification [3] schema, the format shall be designated
as "Ipv4Addr".
Ipv6Addr string String identifying a IPv6 address formatted according to clause 4
of IETF RFC 5952 [5]. The mixed IPv4 IPv6 notation according to
clause 5 of IETF RFC 5952 [5] shall not be used. In an
OpenAPI Specification [3] schema, the format shall be designated
as "Ipv6Addr".
Ipv6Prefix string String identifying a IPv6 address prefix formatted according to
clause 4 of IETF RFC 5952 [5]. In an OpenAPI Specification [3]
schema, the format shall be designated as "Ipv6Prefix".
MacAddr48 string String identifying a MAC address formatted in the hexadecimal
notation according to subclause 1.1 and subclause 2.1 of
IETF RFC 7042 [17]. In an OpenAPI Specification [3] schema, the
format shall be designated as string with pattern of '^([0-9a-fA-
F]{2})((-[0-9a-fA-F]{2}){5})$'
SupportedFeatures string A string used to indicate the features supported by an API that is
used as defined in subclause 6.6 in 3GPP TS 29.501 [2].
n
The string shall contain a bitmask indicating supported features i
hexadecimal representation: Each character in the string shall
take a value of "0" to "9" or "A" to "F" and shall represent the
support of 4 features as described in table 5.2.2-3. The most
significant character representing the highest-numbered features
shall appear first in the string, and the character representing
features 1 to 4 shall appear last in the string. The list of features
and their numbering (starting with 1) are defined separately for
each API. If the string contains a lower number of characters than
there are defined features for an API, all features that would be
represented by characters that are not present in the string are
not supported.
In an OpenAPI Specification [3] schema, the format shall be
designated as "SupportedFeatures".
Uinteger integer Unsigned Integer, i.e. only value 0 and integers above 0 are
permissible. In an OpenAPI Specification [3] schema, the format
shall be designated as "Uinteger".
Uint32 integer Unsigned 32-bit integers, i.e. only value 0 and 32-bit integers
above 0 are permissible. In an OpenAPI Specification [3] schema,
the format shall be designated as "Uint32".
Uint64 integer Unsigned 64-bit integers, i.e. only value 0 and 64-bit integers
above 0 are permissible. In an OpenAPI Specification [3] schema,
the format shall be designated as "Uint64".
ETSI
---------------------- Page: 10 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 10 ETSI TS 129 571 V15.0.0 (2018-09)
Uri string String providing an URI formatted according to
IETF RFC 3986 [6]. In an OpenAPI Specification [3] schema, the
format shall be designated as "Uri".
TimeZone string String with format "" optionally appended by
"", where:
- shall represent the time zone adjusted for
daylight saving time and be encoded as time-numoffset as
defined in subclause 5.6 of IETF RFC 3339 [10];
- shall represent the adjustment that has
been made and be encoded as "+1" or "+2" for a +1 or +2 hours
adjustment.
In an OpenAPI Specification [3] schema, the format shall be
designated as "TimeZone".
Example: "-08:00+1" (for 8 hours behind UTC, +1 hour
adjustment for Daylight Saving Time).
Table 5.2.2-2: Reused OpenAPI data types
Type Name Description
boolean As defined in OpenAPI Specification [3]
integer As defined in OpenAPI Specification [3]
number As defined in OpenAPI Specification [3]
string As defined in OpenAPI Specification [3]
NOTE Data types defined in OpenAPI Specification [3] do not follow the
UpperCamel convention for data types in 3GPP TS 29.501 [2]
Table 5.2.2-3: Meaning of a Hexadecimal Character in SupportedFeatures Type
Character Feature n+3 Feature n+2 Feature n+1 Feature n
supported supported supported supported
0 no no no no
1 no no no yes
2 no no yes no
3 no no yes yes
4 no yes no no
5 no yes no yes
6 no yes yes no
7 no yes yes yes
8 yes no no no
9 yes no no yes
A yes no yes no
B yes no yes yes
C yes yes no no
D yes yes no yes
E yes yes yes no
F yes yes yes yes
NOTE 1 "n" shall be i * 4 + 1, where "i" is zero or a natural number, i.e
permissible values of "n" are 1, 5, 9, …
NOTE 2 If a feature is not defined, it shall be indicated with value "no".
For example, if only the first feature defined in the feature list is set to 1, the corresponding SupportedFeatures attribute
would have a value of "1", or "001" (any amount of 0's to the left of the 1 would result into an equivalent feature list). If
we have 32 features defined, and only the last feature in a feature list is set to 1, the corresponding SupportedFeatures
attribute would have a value of "80000000".
ETSI
---------------------- Page: 11 ----------------------
3GPP TS 29.571 version 15.0.0 Release 15 11 ETSI TS 129 571 V15.0.0 (2018-09)
5.2.3 Enumerations
5.2.3.1 Enumeration: PatchOperation
Table 5.2.3.1-1: Enumeration PatchOperation
Enumeration value Description
"add" Add operation as defined in IETF RFC 6902 [14].
"copy" Copy operation as defined in IETF RFC 6902 [14].
"move" Move operation as defined in IETF RFC 6902 [14].
"remove" Remove operation as defined in IETF RFC 6902 [14].
"replace" Replace operation as defined in IETF RFC 6902 [14].
"test" Test operation as defined in IETF RFC 6902 [14].
5.2.4 Structured Data Types
5.2.4.1 Type: ProblemDetails
Table 5.2.4-1: Definition of type ProblemDetails
Attribute name Data type P Cardinality Description
type Uri O 0.1 A URI reference according to IETF RFC 3986 [6]
that identifies the problem type.
title string O 0.1 A short, human-readable summary of the problem
type. It should not change from occurrence to
occurrence of the problem.
status integer O 0.1 The HTTP status code for this occurrence of the
problem.
detail string O 0.1 A human-readable explanation specific to this
occurrence of the problem.
instance Uri O 0.1 A URI reference that identifies the specific
occurrence of the problem.
cause string C 0.1 A machine-readable application error cause specific
to this occurrence of the problem
This IE should be present and provide application-
related error information, if available.
invalidParams array(InvalidPara O 0.N Description of invalid parameters, for a request
m) rejected due to invalid parameters.
NOTE 1: See IETF RFC 7807 [9] for detailed information and guidance for each attribute, and 3GPP TS 29.501 [2]
for gui
...