OpenAPI
OpenAPI Version: 3.0.0
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Common data types are applicable to several 5GC SBI API specifications as defined in 3GPP TS 29.571 [5] andshould be referenced from individual 5GC SBI API specifications.
OpenAPI Version: 3.0.0
Version: '1.0.0'
Title: 'Common Data Types'
Description: 'Common Data Types for Service Based Interfaces '
Description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 15.2.0
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.571/'
# Common Data Types for Generic usage definitiones as defined in subclause 5.2
# COMMON SIMPLE DATA TYPES
format: binary
Type: string
format: binary
Type: string
nullable: true
format: byte
Type: string
format: byte
Type: string
nullable: true
format: date
Type: string
format: date
Type: string
nullable: true
format: date-time
Type: string
format: date-time
Type: string
nullable: true
Type: string
Pattern: '^([A-Za-z0-9]+(-[A-Za-z0-9]+).)+[a-z]{2,}$'
Type: string
Pattern: '^([A-Za-z0-9]+(-[A-Za-z0-9]+).)+[a-z]{2,}$'
nullable: true
format: double
Type: number
format: double
Type: number
nullable: true
Type: integer
Type: integer
nullable: true
format: float
Type: number
format: float
Type: number
nullable: true
format: int32
Type: integer
format: int32
Type: integer
nullable: true
Type: integer
format: int64
format: int64
Type: integer
nullable: true
Type: string
Pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'
example: '198.51.100.1'
Type: string
Pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'
example: '198.51.100.1'
nullable: true
Type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
example: '2001:db8:85a3::8a2e:370:7334'
Type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
example: '2001:db8:85a3::8a2e:370:7334'
nullable: true
Type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'
example: '2001:db8:abcd:12::0/64'
Type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'
nullable: true
Type: string
Pattern: '^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$'
Type: string
Pattern: '^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$'
nullable: true
Type: string
Pattern: '^[A-Fa-f0-9]*$'
Type: integer
Minimum: 0
Type: integer
Minimum: 0
nullable: true
Type: integer
Minimum: 0
Maximum: 65535
Type: integer
Minimum: 0
Maximum: 65535
nullable: true
format: int32
Type: integer
Minimum: 0
format: int32
Type: integer
Minimum: 0
nullable: true
format: int64
Type: integer
Minimum: 0
format: int64
Type: integer
Minimum: 0
nullable: true
Type: string
Type: string
nullable: true
Type: string
Pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$'
Type: string
Pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$'
nullable: true
Type: string
Type: string
nullable: true
# COMMON ENUMERATED DATA TYPES
anyOf:
- type: string
enum:
- add
- copy
- move
- remove
- replace
- test
- type: string
anyOf:
- type: string
enum:
- http
- https
- type: string
anyOf:
- type: string
enum:
- ADD
- MOVE
- REMOVE
- REPLACE
- type: string
# COMMON STRUCTURED DATA TYPES
Type: object
Properties:
Type:
Reference: '#/components/schemas/Uri'
title:
Type: string
status:
Type: integer
detail:
Type: string
instance:
Reference: '#/components/schemas/Uri'
cause:
Type: string
invalidParams:
Type: array
Items:
Reference: '#/components/schemas/InvalidParam'
minItems: 1
Type: object
Properties:
href:
Reference: '#/components/schemas/Uri'
Type: object
Properties:
href:
Reference: '#/components/schemas/Uri'
nullable: true
Type: object
Properties:
op:
Reference: '#/components/schemas/PatchOperation'
path:
Type: string
from:
Type: string
value:
nullable: true
Required:
- op
- path
oneOf:
- type: array
Items:
Reference: '#/components/schemas/Link'
minItems: 1
- $ref: '#/components/schemas/Link'
Type: object
Properties:
self:
Reference: '#/components/schemas/Link'
Required:
- self
Type: object
Properties:
param:
Type: string
reason:
Type: string
Required:
- param
Type: object
Properties:
op:
Reference: '#/components/schemas/ChangeType'
path:
Type: string
from:
Type: string
origValue: {}
newValue: {}
Required:
- op
- path
Type: object
Properties:
resourceId:
Reference: '#/components/schemas/Uri'
changes:
Type: array
Items:
Reference: '#/components/schemas/ChangeItem'
minItems: 1
oneOf:
- $ref: '#/components/schemas/Cnf'
- $ref: '#/components/schemas/Dnf'
Type: object
Required:
- cnfUnits
Properties:
cnfUnits:
Type: array
Items:
Reference: '#/components/schemas/CnfUnit'
minItems: 1
Type: object
Required:
- dnfUnits
Properties:
dnfUnits:
Type: array
Items:
Reference: '#/components/schemas/DnfUnit'
minItems: 1
Type: object
Required:
- cnfUnit
Properties:
cnfUnit:
Type: array
Items:
Reference: '#/components/schemas/Atom'
minItems: 1
Type: object
Required:
- dnfUnit
Properties:
dnfUnit:
Type: array
Items:
Reference: '#/components/schemas/Atom'
minItems: 1
Type: object
Required:
- attr
- value
Properties:
attr:
Type: string
value: {}
negative:
Type: boolean
# Data Types related to Subscription, Identification and Numbering as defined in subclause 5.3
# SIMPLE DATA TYPES
Type: string
Type: string
nullable: true
Type: string
Pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$'
Type: string
Pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$'
nullable: true
Type: string
Pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$'
Type: string
Pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$'
nullable: true
Type: string
Pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$'
Type: string
Pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$'
nullable: true
Type: string
Pattern: '^(imsi-[0-9]{5,15}|nai-.+|.+)$'
Type: string
Pattern: '^(imsi-[0-9]{5,15}|nai-.+|.+)$'
nullable: true
Type: string
format: uuid
Type: string
Pattern: '^[A-Fa-f0-9]{6}$'
Type: integer
Minimum: 1
Maximum: 256
Type: integer
Minimum: 1
Maximum: 256
nullable: true
Type: string
# STRUCTURED DATA TYPES
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
amfId:
Reference: '#/components/schemas/AmfId'
Required:
- plmnId
- amfId
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
amfId:
Reference: '#/components/schemas/AmfId'
Required:
- plmnId
- amfId
nullable: true
Type: object
Properties:
mnc:
Reference: '#/components/schemas/Mnc'
mcc:
Reference: '#/components/schemas/Mcc'
# Data Types related to 5G Network as defined in subclause 5.4
# SIMPLE DATA TYPES
Type: string
Type: string
nullable: true
Type: integer
Minimum: 0
Maximum: 255
Type: string
Pattern: '^\d{3}$'
Type: string
Pattern: '^\d{3}$'
nullable: true
Type: string
Pattern: '^\d{2,3}$'
Type: string
Pattern: '^\d{2,3}$'
nullable: true
Type: string
Pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)'
Type: string
Pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)'
nullable: true
Type: string
Pattern: '^[A-Fa-f0-9]{7}$'
Type: string
Pattern: '^[A-Fa-f0-9]{7}$'
nullable: true
Type: string
Pattern: '^[A-Fa-f0-9]{9}$'
Type: string
Pattern: '^[A-Fa-f0-9]{9}$'
nullable: true
Type: string
Type: string
nullable: true
Reference: '#/components/schemas/Uinteger'
Type: string
Type: string
Type: string
nullable: true
Type: string
Type: string
Pattern: '^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$'
# ENUMERATED DATA TYPES
Type: string
enum:
- 3GPP_ACCESS
- NON_3GPP_ACCESS
Type: string
enum:
- 3GPP_ACCESS
- NON_3GPP_ACCESS
nullable: true
anyOf:
- type: string
enum:
- NR
- EUTRA
- WLAN
- VIRTUAL
- type: string
anyOf:
- type: string
enum:
- NR
- EUTRA
- WLAN
- VIRTUAL
- type: string
nullable: true
anyOf:
- type: string
enum:
- IPV4
- IPV6
- IPV4V6
- UNSTRUCTURED
- ETHERNET
- type: string
anyOf:
- type: string
enum:
- IPV4
- IPV6
- IPV4V6
- UNSTRUCTURED
- ETHERNET
- type: string
nullable: true
anyOf:
- type: string
enum:
- REQUIRED
- PREFERRED
- NOT_NEEDED
- type: string
anyOf:
- type: string
enum:
- REQUIRED
- PREFERRED
- NOT_NEEDED
- type: string
nullable: true
anyOf:
- type: string
enum:
- REQUIRED
- PREFERRED
- NOT_NEEDED
- type: string
anyOf:
- type: string
enum:
- REQUIRED
- PREFERRED
- NOT_NEEDED
- type: string
nullable: true
anyOf:
- type: string
enum:
- SSC_MODE_1
- SSC_MODE_2
- SSC_MODE_3
- type: string
anyOf:
- type: string
enum:
- SSC_MODE_1
- SSC_MODE_2
- SSC_MODE_3
- type: string
nullable: true
anyOf:
- type: string
This string provides forward-compatibility with future
extensions to the enumeration but is not used to encode
content defined in the present version of this API.
Possible values are
- EARLY: Early notification of UP path reconfiguration.
- EARLY_LATE: Early and late notification of UP path reconfiguration. This value shall only be present in the subscription to the DNAI change event.
- LATE: Late notification of UP path reconfiguration.
anyOf:
- type: string
enum:
- EARLY
- EARLY_LATE
- LATE
- type: string
nullable: true
anyOf:
- type: string
enum:
- ALLOWED_AREAS
- NOT_ALLOWED_AREAS
- type: string
anyOf:
- type: string
enum:
- ALLOWED_AREAS
- NOT_ALLOWED_AREAS
- type: string
nullable: true
anyOf:
- type: string
enum:
- 5GC
- EPC
- type: string
anyOf:
- type: string
enum:
- 5GC
- EPC
- type: string
nullable: true
anyOf:
- type: string
enum:
- IN_AREA
- OUT_OF_AREA
- UNKNOWN
- INACTIVE
- type: string
# STRUCTURED DATA TYPES
Type: object
Properties:
sst:
Type: integer
Minimum: 0
Maximum: 255
sd:
Type: string
Pattern: '^[A-Fa-f0-9]{6}$'
Required:
- sst
Type: object
Properties:
mcc:
Reference: '#/components/schemas/Mcc'
mnc:
Reference: '#/components/schemas/Mnc'
Required:
- mcc
- mnc
Type: object
Properties:
mcc:
Reference: '#/components/schemas/Mcc'
mnc:
Reference: '#/components/schemas/Mnc'
Required:
- mcc
- mnc
nullable: true
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
tac:
Reference: '#/components/schemas/Tac'
Required:
- plmnId
- tac
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
tac:
Reference: '#/components/schemas/Tac'
Required:
- plmnId
- tac
nullable: true
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
# PLMN Identity
eutraCellId:
Reference: '#/components/schemas/EutraCellId'
Required:
- plmnId
- eutraCellId
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
# PLMN Identity
eutraCellId:
Reference: '#/components/schemas/EutraCellId'
Required:
- plmnId
- eutraCellId
nullable: true
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
nrCellId:
Reference: '#/components/schemas/NrCellId'
Required:
- plmnId
- nrCellId
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
nrCellId:
Reference: '#/components/schemas/NrCellId'
Required:
- plmnId
- nrCellId
nullable: true
Type: object
Properties:
eutraLocation:
Reference: '#/components/schemas/EutraLocation'
nrLocation:
Reference: '#/components/schemas/NrLocation'
n3gaLocation:
Reference: '#/components/schemas/N3gaLocation'
Type: object
Properties:
tai:
Reference: '#/components/schemas/Tai'
ecgi:
Reference: '#/components/schemas/Ecgi'
ageOfLocationInformation:
Type: integer
Minimum: 0
Maximum: 32767
ueLocationTimestamp:
Reference: '#/components/schemas/DateTime'
geographicalInformation:
Type: string
Pattern: '^[0-9A-F]{16}$'
geodeticInformation:
Type: string
Pattern: '^[0-9A-F]{20}$'
globalNgenbId:
Reference: '#/components/schemas/GlobalRanNodeId'
Required:
- tai
- ecgi
Type: object
Properties:
tai:
Reference: '#/components/schemas/Tai'
ecgi:
Reference: '#/components/schemas/Ecgi'
ageOfLocationInformation:
Type: integer
Minimum: 0
Maximum: 32767
ueLocationTimestamp:
Reference: '#/components/schemas/DateTime'
geographicalInformation:
Type: string
Pattern: '^[0-9A-F]{16}$'
geodeticInformation:
Type: string
Pattern: '^[0-9A-F]{20}$'
globalNgenbId:
Reference: '#/components/schemas/GlobalRanNodeId'
Required:
- tai
- ecgi
nullable: true
Type: object
Properties:
tai:
Reference: '#/components/schemas/Tai'
ncgi:
Reference: '#/components/schemas/Ncgi'
ageOfLocationInformation:
Type: integer
Minimum: 0
Maximum: 32767
ueLocationTimestamp:
Reference: '#/components/schemas/DateTime'
geographicalInformation:
Type: string
Pattern: '^[0-9A-F]{16}$'
geodeticInformation:
Type: string
Pattern: '^[0-9A-F]{20}$'
globalGnbId:
Reference: '#/components/schemas/GlobalRanNodeId'
Required:
- tai
- ncgi
Type: object
Properties:
tai:
Reference: '#/components/schemas/Tai'
ncgi:
Reference: '#/components/schemas/Ncgi'
ageOfLocationInformation:
Type: integer
Minimum: 0
Maximum: 32767
ueLocationTimestamp:
Reference: '#/components/schemas/DateTime'
geographicalInformation:
Type: string
Pattern: '^[0-9A-F]{16}$'
geodeticInformation:
Type: string
Pattern: '^[0-9A-F]{20}$'
globalGnbId:
Reference: '#/components/schemas/GlobalRanNodeId'
Required:
- tai
- ncgi
nullable: true
Type: object
Properties:
n3gppTai:
Reference: '#/components/schemas/Tai'
n3IwfId:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
ueIpv4Addr:
Reference: '#/components/schemas/Ipv4Addr'
ueIpv6Addr:
Reference: '#/components/schemas/Ipv6Addr'
portNumber:
Reference: '#/components/schemas/Uinteger'
Type: object
Properties:
upIntegr:
Reference: '#/components/schemas/UpIntegrity'
upConfid:
Reference: '#/components/schemas/UpConfidentiality'
Required:
- upIntegr
- upConfid
Type: object
Properties:
upIntegr:
Reference: '#/components/schemas/UpIntegrity'
upConfid:
Reference: '#/components/schemas/UpConfidentiality'
Required:
- upIntegr
- upConfid
nullable: true
Type: object
Properties:
group:
Reference: '#/components/schemas/Uinteger'
value:
Reference: '#/components/schemas/Uinteger'
Required:
- group
- value
Type: object
Properties:
backupAmf:
Reference: '#/components/schemas/AmfName'
guamiList:
Type: array
Items:
Reference: '#/components/schemas/Guami'
minItems: 1
Required:
- backupAmf
Type: object
Properties:
contentId:
Type: string
Required:
- contentId
Type: object
Properties:
contentId:
Type: string
Required:
- contentId
nullable: true
Type: object
Properties:
dnai:
Reference: '#/components/schemas/Dnai'
routeInfo:
Reference: '#/components/schemas/RouteInformation'
routeProfId:
Type: string
nullable: true
Required:
- dnai
nullable: true
Type: object
Properties:
ipv4Addr:
Reference: '#/components/schemas/Ipv4Addr'
ipv6Addr:
Reference: '#/components/schemas/Ipv6Addr'
portNumber:
Reference: '#/components/schemas/Uinteger'
Required:
- portNumber
nullable: true
Type: object
Required:
- 5qi
- arp
Properties:
5qi:
Reference: '#/components/schemas/5Qi'
arp:
Reference: '#/components/schemas/Arp'
priorityLevel:
Reference: '#/components/schemas/5QiPriorityLevel'
Type: object
oneOf:
- required:
- tacs
- required:
- areaCode
Properties:
tacs:
Type: array
Items:
Reference: '#/components/schemas/Tac'
minItems: 1
areaCodes:
Reference: '#/components/schemas/AreaCode'
Type: object
Properties:
restrictionType:
Reference: '#/components/schemas/RestrictionType'
areas:
Type: array
Items:
Reference: '#/components/schemas/Area'
maxNumOfTAs:
Reference: '#/components/schemas/Uinteger'
allOf:
#
# 1st condition: restrictionType and areas attributes shall be either both absent
# or both present
#
- oneOf:
- not:
Required: [ restrictionType ]
- required: [ areas ]
#
# 2nd condition: if restrictionType takes value NOT_ALLOWED_AREAS,
# then maxNumOfTAs shall be absent
#
- anyOf:
- not:
Required: [ restrictionType ]
Properties:
restrictionType:
Type: string
enum: [ NOT_ALLOWED_AREAS ]
- not:
Required: [ maxNumOfTAs ]
Type: object
Properties:
praId:
Type: string
presenceState:
Reference: '#/components/schemas/PresenceState'
trackingAreaList:
Type: array
Items:
Reference: '#/components/schemas/Tai'
minItems: 1
ecgiList:
Type: array
Items:
Reference: '#/components/schemas/Ecgi'
minItems: 1
ncgiList:
Type: array
Items:
Reference: '#/components/schemas/Ncgi'
minItems: 1
globalRanNodeIdList:
Type: array
Items:
Reference: '#/components/schemas/GlobalRanNodeId'
minItems: 1
Type: object
Properties:
praId:
Type: string
presenceState:
Reference: '#/components/schemas/PresenceState'
trackingAreaList:
Type: array
Items:
Reference: '#/components/schemas/Tai'
minItems: 0
ecgiList:
Type: array
Items:
Reference: '#/components/schemas/Ecgi'
minItems: 0
ncgiList:
Type: array
Items:
Reference: '#/components/schemas/Ncgi'
minItems: 0
globalRanNodeIdList:
Type: array
Items:
Reference: '#/components/schemas/GlobalRanNodeId'
nullable: true
Type: object
Properties:
plmnId:
Reference: '#/components/schemas/PlmnId'
n3IwfId:
Reference: '#/components/schemas/N3IwfId'
gNbId:
Reference: '#/components/schemas/GNbId'
ngeNbId:
Reference: '#/components/schemas/NgeNbId'
oneOf:
- required: [ n3IwfId ]
- required: [ gNbId ]
- required: [ ngeNbId ]
Required:
- plmnId
Type: object
Properties:
bitLength:
Type: integer
Minimum: 22
Maximum: 32
gNBValue:
Type: string
Pattern: '^[A-Fa-f0-9]{6,8}$'
Required:
- bitLength
- gNBValue
# Data Types related to 5G QoS as defined in subclause 5.5
# SIMPLE DATA TYPES
Type: integer
Minimum: 0
Maximum: 63
Type: integer
Minimum: 0
Maximum: 63
nullable: true
Type: integer
Minimum: 0
Maximum: 255
Type: integer
Minimum: 0
Maximum: 255
nullable: true
Type: string
Pattern: '^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$'
Type: string
Pattern: '^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$'
nullable: true
Type: integer
Minimum: 1
Maximum: 15
nullable: true
Type: integer
Minimum: 1
Maximum: 127
Type: integer
Minimum: 1
Maximum: 127
nullable: true
Type: integer
Minimum: 1
Type: integer
Minimum: 1
nullable: true
Type: string
Pattern: '^([0-9]E-[0-9])$'
Type: string
Pattern: '^([0-9]E-[0-9])$'
nullable: true
Type: integer
Minimum: 0
Maximum: 1000
Type: integer
Minimum: 0
Maximum: 1000
nullable: true
Type: integer
Minimum: 1
Maximum: 4095
Default: 2000
Type: integer
Maximum: 4095
Default: 2000
Minimum: 1
nullable: true
Type: integer
Minimum: 1
Maximum: 4095
Type: integer
Minimum: 1
Maximum: 4095
nullable: true
# ENUMERATED DATA TYPES
anyOf:
- type: string
enum:
- NOT_PREEMPT
- MAY_PREEMPT
- type: string
anyOf:
- type: string
enum:
- NOT_PREEMPT
- MAY_PREEMPT
- type: string
nullable: true
anyOf:
- type: string
enum:
- NOT_PREEMPTABLE
- PREEMPTABLE
- type: string
anyOf:
- type: string
enum:
- NOT_PREEMPTABLE
- PREEMPTABLE
- type: string
nullable: true
anyOf:
- type: string
enum:
- RQOS
- NO_RQOS
- type: string
anyOf:
- type: string
enum:
- RQOS
- NO_RQOS
- type: string
nullable: true
anyOf:
- type: string
enum:
- REQUESTED
- NOT_REQUESTED
- type: string
anyOf:
- type: string
enum:
- REQUESTED
- NOT_REQUESTED
- type: string
nullable: true
anyOf:
- type: string
enum:
- NON_GBR
- NON_CRITICAL_GBR
- CRITICAL_GBR
- type: string
anyOf:
- type: string
enum:
- NON_GBR
- NON_CRITICAL_GBR
- CRITICAL_GBR
- type: string
nullable: true
anyOf:
- type: string
enum:
- MORE_LIKELY
- type: string
nullable: true
# STRUCTURED DATA TYPES
Type: object
Properties:
priorityLevel:
Reference: '#/components/schemas/ArpPriorityLevel'
preemptCap:
Reference: '#/components/schemas/PreemptionCapability'
preemptVuln:
Reference: '#/components/schemas/PreemptionVulnerability'
Required:
- priorityLevel
- preemptCap
- preemptVuln
Type: object
Properties:
priorityLevel:
Reference: '#/components/schemas/ArpPriorityLevel'
preemptCap:
Reference: '#/components/schemas/PreemptionCapability'
preemptVuln:
Reference: '#/components/schemas/PreemptionVulnerability'
Required:
- priorityLevel
- preemptCap
- preemptVuln
nullable: true
Type: object
Properties:
uplink:
Reference: '#/components/schemas/BitRate'
downlink:
Reference: '#/components/schemas/BitRate'
Required:
- uplink
- downlink
Type: object
Properties:
uplink:
Reference: '#/components/schemas/BitRate'
downlink:
Reference: '#/components/schemas/BitRate'
Required:
- uplink
- downlink
nullable: true
Type: object
Properties:
resourceType:
Reference: '#/components/schemas/QosResourceType'
priorityLevel:
Reference: '#/components/schemas/5QiPriorityLevel'
packetDelayBudget:
Reference: '#/components/schemas/PacketDelBudget'
packetErrRate:
Reference: '#/components/schemas/PacketErrRate'
averWindow:
Reference: '#/components/schemas/AverWindow'
maxDataBurstVol:
Reference: '#/components/schemas/MaxDataBurstVol'
Required:
- resourceType
- priorityLevel
- packetDelayBudget
- packetErrRate
Type: object
Properties:
priorityLevel:
Reference: '#/components/schemas/5QiPriorityLevel'
averWindow:
Reference: '#/components/schemas/AverWindow'
maxDataBurstVol:
Reference: '#/components/schemas/MaxDataBurstVol'
minProperties: 0
# Data Types related to 5G Trace as defined in subclause 5.6
# SIMPLE DATA TYPES
# Enumerations
anyOf:
- type: string
enum:
- MINIMUM
- MEDIUM
- MAXIMUM
- MINIMUM_WO_VENDOR_EXTENSION
- MEDIUM_WO_VENDOR_EXTENSION
- MAXIMUM_WO_VENDOR_EXTENSION
- type: string
anyOf:
- type: string
enum:
- MINIMUM
- MEDIUM
- MAXIMUM
- MINIMUM_WO_VENDOR_EXTENSION
- MEDIUM_WO_VENDOR_EXTENSION
- MAXIMUM_WO_VENDOR_EXTENSION
- type: string
nullable: true
# STRUCTURED DATA TYPES
Type: object
nullable: true
Properties:
traceRef:
Type: string
Pattern: '^[0-9]{3}[0-9]{2,3}-[A-Fa-f0-9]{6}$'
traceDepth:
Reference: '#/components/schemas/TraceDepth'
neTypeList:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
eventList:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
collectionEntityIpv4Addr:
Reference: '#/components/schemas/Ipv4Addr'
collectionEntityIpv6Addr:
Reference: '#/components/schemas/Ipv6Addr'
interfaceList:
Type: string
Pattern: '^[A-Fa-f0-9]+$'
Required:
- traceRef
- traceDepth
- neTypeList
- eventList
# Data Types related to 5G ODB as defined in subclause 5.7
# SIMPLE DATA TYPES
# Enumerations
anyOf:
- type: string
enum:
- OUTSIDE_HOME_PLMN
- OUTSIDE_HOME_PLMN_COUNTRY
- type: string
anyOf:
- type: string
enum:
- ALL_PACKET_SERVICES
- ROAMER_ACCESS_HPLMN_AP
- ROAMER_ACCESS_VPLMN_AP
- type: string
nullable: true
# STRUCTURED DATA TYPES
Type: object
Properties:
roamingOdb:
Reference: '#/components/schemas/RoamingOdb'
odbPacketServices:
Reference: '#/components/schemas/OdbPacketServices'
# Data Types related to Charging as defined in subclause 5.8
# SIMPLE DATA TYPES
Reference: '#/components/schemas/Uint32'
Reference: '#/components/schemas/Uint32'
Reference: '#/components/schemas/Uint32'
# Enumerations
# STRUCTURED DATA TYPES
Type: object
Properties:
secondaryRatType:
Reference: '#/components/schemas/RatType'
qosFlowsUsageData:
Type: array
Items:
Reference: '#/components/schemas/QosFlowUsageReport'
minItems: 1
Required:
- secondaryRatType
- qosFlowsUsageData
Type: object
Properties:
qfi:
Reference: '#/components/schemas/Qfi'
startTimeStamp:
Reference: '#/components/schemas/DateTime'
endTimeStamp:
Reference: '#/components/schemas/DateTime'
downlinkVolume:
Reference: '#/components/schemas/Int64'
uplinkVolume:
Reference: '#/components/schemas/Int64'
Required:
- qfi
- startTimeStamp
- endTimeStamp
- downlinkVolume
- uplinkVolume
# HTTP responses
Description: Bad request
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Unauthorized
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Forbidden
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Not Found
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Method Not Allowed
Description: Request Timeout
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: 406 Not Acceptable
Description: Conflict
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Gone
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Length Required
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Precondition Failed
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Payload Too Large
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: URI Too Long
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Unsupported Media Type
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Too Many Requests
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Internal Server Error
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Not Implemented
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Service Unavailable
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Gateway Timeout
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'
Description: Generic Error
content:
application/problem+json:
schema:
Reference: '#/components/schemas/ProblemDetails'