5G Common Data Types for Service Based Interfaces

---

Abbreviations

Abbreviation	Description
5GC	5G Core Network
DNAI	Data Network Access Identifier
GPSI	Generic Public Subscription Identifier
GUAMI	Globally Unique AMF Identifier
PEI	Permanent Equipment Identifier
SBI	Service Based Interface
SUPI	Subscription Permanent Identifier

Simple Data Types

Type Name	Type Definition	Description
Binary	string	String with format "binary" as defined in OpenAPI Specification [3]
BinaryRm	string	This data type is defined in the same way as the "Binary" data type, but with the OpenAPI "nullable: true" property.
Bytes	string	String with format "byte" as defined in OpenAPI Specification [3], i.e, base64-encoded characters,
BytesRm	string	This data type is defined in the same way as the "Bytes" data type, but with the OpenAPI "nullable: true" property.
Date	string	String with format "date" as defined in OpenAPI Specification [3]
DateRm	string	This data type is defined in the same way as the "Date" data type, but with the OpenAPI "nullable: true" property.
DateTime	string	String with format "date-time" as defined in OpenAPI Specification [3]
DateTimeRm	string	This data type is defined in the same way as the "DateTime" data type, but with the OpenAPI "nullable: true" property.
DiameterIdentity	string	String containing a Diameter Identity, according to clause 4.3 of IETF RFC 6733 [18].
DiameterIdentityRm	string	This data type is defined in the same way as the "DiameterIdentity" data type, but with the OpenAPI "nullable: true" property.
Double	number	Number with format "double" as defined in OpenAPI Specification [3]
DoubleRm	number	This data type is defined in the same way as the "Double" data type, but with the OpenAPI "nullable: true" property.
DurationSec	integer	Unsigned integer identifying a period of time in units of seconds.
DurationSecRm	integer	This data type is defined in the same way as the "DurationSec" data type, but with the OpenAPI "nullable: true" property.
Float	number	Number with format "float" as defined in OpenAPI Specification [3]
FloatRm	number	This data type is defined in the same way as the "Float" data type, but with the OpenAPI "nullable: true" property.
Uint16	integer	Unsigned 16-bit integers, i.e. only value between 0 and 65535 are permissible.
Uint16Rm	integer	This data type is defined in the same way as the "Uint16" data type, but with the OpenAPI "nullable: true" property.
Int32	integer	Integer with format "int32" as defined in OpenAPI Specification [3]
Int32Rm	integer	This data type is defined in the same way as the "Int32" data type, but with the OpenAPI "nullable: true" property.
Int64	integer	Integer with format "int64" as defined in OpenAPI Specification [3]
Int64Rm	integer	This data type is defined in the same way as the "Int64" data type, but with the OpenAPI "nullable: true" property.
Ipv4Addr	string	String identifying a IPv4 address formatted in the "dotted decimal" notation as defined in in IETF RFC 1166 [4].
Ipv4AddrRm	string	This data type is defined in the same way as the "Ipv4Addr" data type, but with the OpenAPI "nullable: true" property.
Ipv6Addr	string	String identifying an 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.
Ipv6AddrRm	string	This data type is defined in the same way as the "Ipv6Addr" data type, but with the OpenAPI "nullable: true" property.
Ipv6Prefix	string	String identifying an IPv6 address prefix formatted according to clause 4 of IETF RFC 5952 [5].
Ipv6PrefixRm	string	This data type is defined in the same way as the "Ipv6Prefix" data type, but with the OpenAPI "nullable: true" property.
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].
MacAddr48Rm	string	This data type is defined in the same way as the "MacAddr48" data type, but with the OpenAPI "nullable: true" property.
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.500 [1]. The string shall contain a bitmask indicating supported features in 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.
Uinteger	integer	Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.
UintegerRm	integer	This data type is defined in the same way as the "Uinteger" data type, but with the OpenAPI "nullable: true" property.
Uint32	integer	Unsigned 32-bit integers, i.e. only value 0 and 32-bit integers above 0 are permissible.
Uint32Rm	integer	This data type is defined in the same way as the "UInt32" data type, but with the OpenAPI "nullable: true" property.
Uint64	integer	Unsigned 64-bit integers, i.e. only value 0 and 64-bit integers above 0 are permissible.
Uint64Rm	integer	This data type is defined in the same way as the "Uint64" data type, but with the OpenAPI "nullable: true" property.
Uri	string	String providing an URI formatted according to IETF RFC 3986 [6].
UriRm	string	This data type is defined in the same way as the "Uri" data type, but with the OpenAPI "nullable: true" property.
VarUeId	string	String represents the SUPI or GPSI.
VarUeIdRm	string	This data type is defined in the same way as the "VarUeId" data type, but with the OpenAPI "nullable: true" property.
TimeZone	string	String with format "time-numoffset" optionally appended by "daylightSavingTime"
TimeZoneRm	string	This data type is defined in the same way as the "TimeZone" data type, but with the OpenAPI "nullable: true" property.