1. REST API Reference for Elastic Charging Engine
  2. Tasks
  3. Nchf Converged Charging

Create a Converged Charging Session

post

{apiRoot}/nchf-convergedcharging/v3/chargingdata

Creates an Nchf converged charging session and reserves an initial quota of service, such as 20 USD or 2 GB of data, for a subscriber.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
An offline-only charging request.
Show Source
Nested Schema : multipleUnitUsage
Type: array
Minimum Number of Items: 0
A list of multiple unit usage.
Show Source
Nested Schema : NFIdentification
Type: object
A Network Function (NF).
Show Source
  • The fully qualified domain name (FQDN) of the NF.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Allowed Values: [ "SMF", "SMSF", "I-SMF" ]
Nested Schema : PDUSessionChargingInformation
Type: object
Show Source
Nested Schema : RoamingQBCInformation
Type: object
The 5G data connectivity-specific information for roaming QBC.
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
A list of triggers.
Show Source
Nested Schema : MultipleUnitUsage
Type: object
The parameters for the quota management request and/or usage report.
Show Source
Nested Schema : PDUAddress
Type: object
A group of user IP addresses.
Show Source
  • Indicates whether the served IPv4 PDU address is dynamically allocated (true) or not (false). This field is missing when the address is static.
  • This field indicates whether the served IPv6 PDU address is dynamically allocated (true) or not (false). This field is missing if the address is static.
  • The length of the PDU address prefix for an IPv6 typed served PDU address. The field is not required for a prefix length of 64 bits.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
Nested Schema : usedUnitContainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : UsedUnitContainer
Type: object
The amount of used non-monetary service units.
Show Source
Nested Schema : eventTimeStamps
Type: array
Minimum Number of Items: 0
The date and time when the event occurred.
Show Source
Nested Schema : PDUContainerInformation
Type: object
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : SteeringMode
Type: object
Contains the steering mode value and parameters determined by the PCF.
Show Source
  • Minimum Value: 0
    Unsigned Integer, that is, only 0 and integers above 0 are permissible.
  • Allowed Values: [ "3GPP_ACCESS", "NON_3GPP_ACCESS" ]
    Indicates whether the access is via 3GPP or via non-3GPP.
  • Allowed Values: [ "3GPP_ACCESS", "NON_3GPP_ACCESS" ]
    Indicates whether the access is via 3GPP or via non-3GPP.
  • Allowed Values: [ "3GPP_ACCESS", "NON_3GPP_ACCESS", null ]
    Indicates whether the access is via 3GPP or via non-3GPP, but with OpenAPI as 'nullable: true' property."
  • Contains Autonomous load-balance indicator or UE-assistance indicator.
  • Allowed Values: [ "ACTIVE_STANDBY", "LOAD_BALANCING", "SMALLEST_DELAY", "PRIORITY_BASED" ]
    Indicates that the steering mode value determined by the PCF.
  • ThresholdValue
    Indicates the threshold value(s) for RTT and/or Packet Loss Rate.
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : QosCharacteristics
Type: object
Contains QoS characteristics for a non-standardized or a non-configured 5QI.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Minimum Value: 4096
    Maximum Value: 2000000
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Maximum Value: 4095
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
  • Allowed Values: [ "NON_GBR", "NON_CRITICAL_GBR", "CRITICAL_GBR" ]
    The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501). It should comply with the provisions defined in table 5.5.3.6-1.
Nested Schema : QosData
Type: object
Contains the QoS parameters.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates that the dynamic PCC rule should always have its binding with the QoS Flow associated with the default QoS rule
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.
  • Identifies the QoS control policy data within a PDU session.
  • Indicates whether the QoS information is reflective for the corresponding service data flow.
  • Indicates which PCC rules may share resources in the downlink direction, by containing the same value.
  • Indicates which PCC rules may share resources in the uplink direction, by containing the same value.
Nested Schema : servingNodeID
Type: array
Minimum Number of Items: 0
The list of AMF Identifiers (AmfId) of AMFs.
Show Source
Nested Schema : UserLocation
Type: object
At least one of eutraLocation, nrLocation, and n3gaLocation should be present, though multiple may be included.
Show Source
Nested Schema : ThresholdValue
Type: object
Indicates the threshold value(s) for RTT and/or Packet Loss Rate.
Show Source
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Unsigned Integer, that is, only 0 and integers above 0 are permissible with OpenAPI as 'nullable: true' property.
Nested Schema : PresenceInfo
Type: object
If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Show Source
  • This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas. When present, this IE should contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE.
  • ecgiList
    Minimum Number of Items: 1
    Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
  • globaleNbIdList
    Minimum Number of Items: 1
    Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
  • globalRanNodeIdList
    Minimum Number of Items: 1
    Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
  • ncgiList
    Minimum Number of Items: 1
    Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
  • Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003). This IE should be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. When present, it should be encoded as a string representing an integer within the following ranges: 0 to 8 388 607 for UE-dedicated PRA. 8 388 608 to 16 777 215 for Core Network predefined PRA. Examples: PRA ID 123 is encoded as "123". PRA ID 11 238 660 is encoded as "11238660".
  • Allowed Values: [ "IN_AREA", "OUT_OF_AREA", "UNKNOWN", "INACTIVE" ]
    Possible values are: -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not. -INACTIVE: Indicates that the presence reporting area is inactive in the serving node.
  • trackingAreaList
    Minimum Number of Items: 1
    Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Nested Schema : ecgiList
Type: array
Minimum Number of Items: 1
Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
Show Source
Nested Schema : globaleNbIdList
Type: array
Minimum Number of Items: 1
Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
Show Source
Nested Schema : globalRanNodeIdList
Type: array
Minimum Number of Items: 1
Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
Show Source
Nested Schema : ncgiList
Type: array
Minimum Number of Items: 1
Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
Show Source
Nested Schema : trackingAreaList
Type: array
Minimum Number of Items: 1
Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Show Source
Nested Schema : Ecgi
Type: object
Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{7}$
    28-bit string, identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : GlobalRanNodeId
Type: object
One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
Show Source
  • Pattern: ^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$
    This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413. The string should be formatted with the following pattern '^('MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5} |HomeeNB-[A-Fa-f0-9]{7})$'. The value of the eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing the padding 0, if required together with the 4 most significant bits of the eNB ID should appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) should appear last in the string.
  • GNbId
    Provides the G-NB identifier.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Pattern: ^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$
    This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413. The value of the ng-eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing padding 0, if required together with the 4 most significant bits of the ng-eNB ID should appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) should appear last in the string.
    Example: <b>SMacroNGeNB-34B89</b>
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID should appear first in the string, and the character representing the 4 least significant bit of the TNGF ID should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID should appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID should appear last in the string.
Match One Schema
Show Source
Nested Schema : GNbId
Type: object
Provides the G-NB identifier.
Show Source
  • Minimum Value: 22
    Maximum Value: 32
    Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32.
  • Pattern: ^[A-Fa-f0-9]{6,8}$
    This represents the identifier of the gNB. The value of the gNB ID should be encoded in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, with the most significant character representing the padding 0. If required together, the 4 most significant bits of the gNB ID should appear first in the string, and the character representing the 4 least significant bit of the gNB ID should appear last in the string.
Nested Schema : Ncgi
Type: object
Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • Pattern: ^[A-Fa-f0-9]{9}$
    36-bit string, identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : Tai
Type: object
Contains the tracking area identity as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)
    2 or 3-octet string, identifying a tracking area code as specified in clause 9.3.3.10 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TAC should appear first in the string, and the character representing the 4 least significant bit of the TAC should appear last in the string.
Nested Schema : Arp
Type: object
Contains Allocation and Retention Priority information.
Show Source
  • Allowed Values: [ "NOT_PREEMPT", "MAY_PREEMPT" ]
    The enumeration PreemptionCapability indicates the pre-emption capability of a request on other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.1-1.
  • Allowed Values: [ "NOT_PREEMPTABLE", "PREEMPTABLE" ]
    The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.2-1.
  • Minimum Value: 1
    Maximum Value: 15
    "nullable: true" should not be used for this attribute. Unsigned integer indicating the ARP Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501) within the range 1 to 15. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 15 as the lowest priority.
Nested Schema : ServingNetworkFunctionID
Type: object
An identifier for the serving NF.
Show Source
Nested Schema : EutraLocation
Type: object
Contains the E-UTRA user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Ecgi
    Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
    This flag should indicate that the Ecgi should be ignored. When present, it should be set as follows: - true: ecgi should be ignored. - false (default): ecgi should not be ignored.
  • Default Value: false
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : GeraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • Location number within the PLMN. See 3GPP TS 23.003, clause 4.5.
  • MSC number. See 3GPP TS 23.003 clause 5.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
  • VLR number. See 3GPP TS 23.003 clause 5.1.
Match One Schema
Show Source
Nested Schema : N3gaLocation
Type: object
Contains the Non-3GPP access user location.
Show Source
  • Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003. This should be encoded as a string per clause 28.15.4 of 3GPP TS 23.003, and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH.
  • String in 'bytes' format, as defined in OpenAPI.
  • HfcNodeId
    Represents the HFC Node Identifer received over NGAP.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • Pattern: ^[A-Fa-f0-9]+$
    This IE should contain the N3IWF identifier received over NGAP and should be encoded as a string of hexadecimal characters. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Minimum Value: 0
    Unsigned Integer, that is, only 0 and integers above 0 are permissible.
  • Allowed Values: [ "UDP", "TCP" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - UDP: User Datagram Protocol. - TCP: Transmission Control Protocol.
  • TnapId
    Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
  • TwapId
    Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • Allowed Values: [ "DSL", "PON" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - DSL: Identifies a DSL line. - PON: Identifies a PON line.
Nested Schema : NrLocation
Type: object
Contains the NR user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
  • Ncgi
    Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : UtraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
Match One Schema
Show Source
Nested Schema : CellGlobalId
Type: object
Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
Show Source
Nested Schema : LocationAreaId
Type: object
Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
Show Source
Nested Schema : RoutingAreaId
Type: object
Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
Show Source
Nested Schema : ServiceAreaId
Type: object
Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
Show Source
Nested Schema : HfcNodeId
Type: object
Represents the HFC Node Identifer received over NGAP.
Show Source
  • Maximum Length: 6
    This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters.
Nested Schema : TnapId
Type: object
Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should be present if the UE is accessing the 5GC via a trusted WLAN access network. When present, it should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : TwapId
Type: object
Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached for trusted WLAN access. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : Trigger
Type: object
A trigger event.
Show Source
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Indicates a time in seconds.
  • Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
  • Allowed Values: [ "FINAL", "ABNORMAL_RELEASE", "QOS_CHANGE", "VOLUME_LIMIT", "TIME_LIMIT", "EVENT_LIMIT", "PLMN_CHANGE", "USER_LOCATION_CHANGE", "RAT_CHANGE", "SESSION_AMBR_CHANGE", "UE_TIMEZONE_CHANGE", "TARIFF_TIME_CHANGE", "MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS", "MANAGEMENT_INTERVENTION", "CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA", "CHANGE_OF_3GPP_PS_DATA_OFF_STATUS", "SERVING_NODE_CHANGE", "REMOVAL_OF_UPF", "ADDITION_OF_UPF", "INSERTION_OF_ISMF", "REMOVAL_OF_ISMF", "CHANGE_OF_ISMF", "START_OF_SERVICE_DATA_FLOW", "GFBR_GUARANTEED_STATUS_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS" ]
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : PDUSessionInformation
Type: object
Information about a PDU session.
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
When the data type is present in the response message, it includes the PRA information provisioned by the CHF, in which case the presenceState attribute within the PresenceInfo data type shall not be supplied. When the data type is present in the request message, it is used to report user presence reporting area status. The praId attribute within the PresenceInfo data type shall be the key of the map.
Nested Schema : RANSecondaryRATUsageReport
Type: object
Show Source
  • qosFlowsUsageReports
  • Allowed Values: [ "NR", "EUTRA", "WLAN", "VIRTUAL", "NBIOT", "WIRELINE", "WIRELINE_CABLE", "WIRELINE_BBF", "LTE-M", "NR_U", "EUTRA_U", "TRUSTED_N3GA", "TRUSTED_WLAN", "UTRA", "GERA", "NR_LEO", "NR_MEO", "NR_GEO", "NR_OTHER_SAT", "NR_REDCAP", "WB_E_UTRAN_LEO", "WB_E_UTRAN_MEO", "WB_E_UTRAN_GEO", "WB_E_UTRAN_OTHERSAT", "NB_IOT_LEO", "NB_IOT_MEO", "NB_IOT_GEO", "NB_IOT_OTHERSAT", "LTE_M_LEO", "LTE_M_MEO", "LTE_M_GEO", "LTE_M_OTHERSAT" ]
    Indicates the radio access used.
Nested Schema : UserInformation
Type: object
Information about a user and user equipment.
Show Source
  • Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    String identifying a Gpsi should contain either an External Id or an MSISDN. It should be formatted as follows -External Identifier= "extid-'extid', where 'extid' should be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an external identifier.
  • Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$
    String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.
Nested Schema : AuthorizedDefaultQos
Type: object
Represents the Authorized Default QoS.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
Nested Schema : Ambr
Type: object
Contains the maximum aggregated uplink and downlink bit rates.
Show Source
Nested Schema : RanNasCauseList
Type: array
Show Source
Nested Schema : MAPDUSessionInformation
Type: object
Show Source
Nested Schema : NetworkSlicingInfo
Type: object
Information about a network slice serving the PDU session.
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : SubscribedDefaultQos
Type: object
Provides the subscribed 5QI and the ARP. It may also contain the priority level.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
Nested Schema : RanNasRelCause
Type: object
Contains the RAN/NAS release cause.
Show Source
Nested Schema : NgApCause
Type: object
Represents the NGAP cause.
Show Source
Nested Schema : AtsssCapability
Type: object
Containes Capability to support procedures related to Access Traffic Steering, Switching, and Splitting.
Show Source
  • Default Value: false
    Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501). true: Supported false (default): Not Supported
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : qosFlowsUsageReports
Type: array
Show Source
Nested Schema : QosFlowsUsageReport
Type: object
Show Source
Nested Schema : multipleQFIcontainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : RoamingChargingProfile
Type: object
Show Source
Nested Schema : MultipleQFIcontainer
Type: object
Show Source
Nested Schema : QFIContainerInformation
Type: object
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : servingNetworkFunctionID
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Back to Top

Response

Supported Media Types

201 Response

The converged charging session was created successfully.
Body ()
Root Schema : ChargingDataResponse
Type: object
A response to a request for offline-only charging.
Show Source
Nested Schema : InvocationResult
Type: object
The result of a charging service invocation by the NF consumer.
Show Source
Nested Schema : PDUSessionChargingInformation
Type: object
Show Source
Nested Schema : RoamingQBCInformation
Type: object
The 5G data connectivity-specific information for roaming QBC.
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."
Nested Schema : UserLocation
Type: object
At least one of eutraLocation, nrLocation, and n3gaLocation should be present, though multiple may be included.
Show Source
Nested Schema : PDUSessionInformation
Type: object
Information about a PDU session.
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
When the data type is present in the response message, it includes the PRA information provisioned by the CHF, in which case the presenceState attribute within the PresenceInfo data type shall not be supplied. When the data type is present in the request message, it is used to report user presence reporting area status. The praId attribute within the PresenceInfo data type shall be the key of the map.
Nested Schema : RANSecondaryRATUsageReport
Type: object
Show Source
  • qosFlowsUsageReports
  • Allowed Values: [ "NR", "EUTRA", "WLAN", "VIRTUAL", "NBIOT", "WIRELINE", "WIRELINE_CABLE", "WIRELINE_BBF", "LTE-M", "NR_U", "EUTRA_U", "TRUSTED_N3GA", "TRUSTED_WLAN", "UTRA", "GERA", "NR_LEO", "NR_MEO", "NR_GEO", "NR_OTHER_SAT", "NR_REDCAP", "WB_E_UTRAN_LEO", "WB_E_UTRAN_MEO", "WB_E_UTRAN_GEO", "WB_E_UTRAN_OTHERSAT", "NB_IOT_LEO", "NB_IOT_MEO", "NB_IOT_GEO", "NB_IOT_OTHERSAT", "LTE_M_LEO", "LTE_M_MEO", "LTE_M_GEO", "LTE_M_OTHERSAT" ]
    Indicates the radio access used.
Nested Schema : UserInformation
Type: object
Information about a user and user equipment.
Show Source
  • Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    String identifying a Gpsi should contain either an External Id or an MSISDN. It should be formatted as follows -External Identifier= "extid-'extid', where 'extid' should be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an external identifier.
  • Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$
    String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.
Nested Schema : EutraLocation
Type: object
Contains the E-UTRA user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Ecgi
    Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
    This flag should indicate that the Ecgi should be ignored. When present, it should be set as follows: - true: ecgi should be ignored. - false (default): ecgi should not be ignored.
  • Default Value: false
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : GeraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • Location number within the PLMN. See 3GPP TS 23.003, clause 4.5.
  • MSC number. See 3GPP TS 23.003 clause 5.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
  • VLR number. See 3GPP TS 23.003 clause 5.1.
Match One Schema
Show Source
Nested Schema : N3gaLocation
Type: object
Contains the Non-3GPP access user location.
Show Source
  • Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003. This should be encoded as a string per clause 28.15.4 of 3GPP TS 23.003, and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH.
  • String in 'bytes' format, as defined in OpenAPI.
  • HfcNodeId
    Represents the HFC Node Identifer received over NGAP.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • Pattern: ^[A-Fa-f0-9]+$
    This IE should contain the N3IWF identifier received over NGAP and should be encoded as a string of hexadecimal characters. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Minimum Value: 0
    Unsigned Integer, that is, only 0 and integers above 0 are permissible.
  • Allowed Values: [ "UDP", "TCP" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - UDP: User Datagram Protocol. - TCP: Transmission Control Protocol.
  • TnapId
    Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
  • TwapId
    Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • Allowed Values: [ "DSL", "PON" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - DSL: Identifies a DSL line. - PON: Identifies a PON line.
Nested Schema : NrLocation
Type: object
Contains the NR user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
  • Ncgi
    Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : UtraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
Match One Schema
Show Source
Nested Schema : Ecgi
Type: object
Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{7}$
    28-bit string, identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : GlobalRanNodeId
Type: object
One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
Show Source
  • Pattern: ^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$
    This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413. The string should be formatted with the following pattern '^('MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5} |HomeeNB-[A-Fa-f0-9]{7})$'. The value of the eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing the padding 0, if required together with the 4 most significant bits of the eNB ID should appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) should appear last in the string.
  • GNbId
    Provides the G-NB identifier.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Pattern: ^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$
    This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413. The value of the ng-eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing padding 0, if required together with the 4 most significant bits of the ng-eNB ID should appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) should appear last in the string.
    Example: <b>SMacroNGeNB-34B89</b>
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID should appear first in the string, and the character representing the 4 least significant bit of the TNGF ID should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID should appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID should appear last in the string.
Match One Schema
Show Source
Nested Schema : Tai
Type: object
Contains the tracking area identity as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)
    2 or 3-octet string, identifying a tracking area code as specified in clause 9.3.3.10 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TAC should appear first in the string, and the character representing the 4 least significant bit of the TAC should appear last in the string.
Nested Schema : GNbId
Type: object
Provides the G-NB identifier.
Show Source
  • Minimum Value: 22
    Maximum Value: 32
    Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32.
  • Pattern: ^[A-Fa-f0-9]{6,8}$
    This represents the identifier of the gNB. The value of the gNB ID should be encoded in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, with the most significant character representing the padding 0. If required together, the 4 most significant bits of the gNB ID should appear first in the string, and the character representing the 4 least significant bit of the gNB ID should appear last in the string.
Nested Schema : CellGlobalId
Type: object
Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
Show Source
Nested Schema : LocationAreaId
Type: object
Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
Show Source
Nested Schema : RoutingAreaId
Type: object
Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
Show Source
Nested Schema : ServiceAreaId
Type: object
Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
Show Source
Nested Schema : HfcNodeId
Type: object
Represents the HFC Node Identifer received over NGAP.
Show Source
  • Maximum Length: 6
    This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters.
Nested Schema : TnapId
Type: object
Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should be present if the UE is accessing the 5GC via a trusted WLAN access network. When present, it should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : TwapId
Type: object
Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached for trusted WLAN access. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : Ncgi
Type: object
Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • Pattern: ^[A-Fa-f0-9]{9}$
    36-bit string, identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : AuthorizedDefaultQos
Type: object
Represents the Authorized Default QoS.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
Nested Schema : Ambr
Type: object
Contains the maximum aggregated uplink and downlink bit rates.
Show Source
Nested Schema : RanNasCauseList
Type: array
Show Source
Nested Schema : MAPDUSessionInformation
Type: object
Show Source
Nested Schema : NetworkSlicingInfo
Type: object
Information about a network slice serving the PDU session.
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : PDUAddress
Type: object
A group of user IP addresses.
Show Source
  • Indicates whether the served IPv4 PDU address is dynamically allocated (true) or not (false). This field is missing when the address is static.
  • This field indicates whether the served IPv6 PDU address is dynamically allocated (true) or not (false). This field is missing if the address is static.
  • The length of the PDU address prefix for an IPv6 typed served PDU address. The field is not required for a prefix length of 64 bits.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
Nested Schema : ServingNetworkFunctionID
Type: object
An identifier for the serving NF.
Show Source
Nested Schema : SubscribedDefaultQos
Type: object
Provides the subscribed 5QI and the ARP. It may also contain the priority level.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
Nested Schema : Arp
Type: object
Contains Allocation and Retention Priority information.
Show Source
  • Allowed Values: [ "NOT_PREEMPT", "MAY_PREEMPT" ]
    The enumeration PreemptionCapability indicates the pre-emption capability of a request on other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.1-1.
  • Allowed Values: [ "NOT_PREEMPTABLE", "PREEMPTABLE" ]
    The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.2-1.
  • Minimum Value: 1
    Maximum Value: 15
    "nullable: true" should not be used for this attribute. Unsigned integer indicating the ARP Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501) within the range 1 to 15. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 15 as the lowest priority.
Nested Schema : RanNasRelCause
Type: object
Contains the RAN/NAS release cause.
Show Source
Nested Schema : NgApCause
Type: object
Represents the NGAP cause.
Show Source
Nested Schema : AtsssCapability
Type: object
Containes Capability to support procedures related to Access Traffic Steering, Switching, and Splitting.
Show Source
  • Default Value: false
    Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501). true: Supported false (default): Not Supported
Nested Schema : NFIdentification
Type: object
A Network Function (NF).
Show Source
  • The fully qualified domain name (FQDN) of the NF.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Allowed Values: [ "SMF", "SMSF", "I-SMF" ]
Nested Schema : PresenceInfo
Type: object
If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Show Source
  • This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas. When present, this IE should contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE.
  • ecgiList
    Minimum Number of Items: 1
    Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
  • globaleNbIdList
    Minimum Number of Items: 1
    Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
  • globalRanNodeIdList
    Minimum Number of Items: 1
    Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
  • ncgiList
    Minimum Number of Items: 1
    Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
  • Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003). This IE should be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. When present, it should be encoded as a string representing an integer within the following ranges: 0 to 8 388 607 for UE-dedicated PRA. 8 388 608 to 16 777 215 for Core Network predefined PRA. Examples: PRA ID 123 is encoded as "123". PRA ID 11 238 660 is encoded as "11238660".
  • Allowed Values: [ "IN_AREA", "OUT_OF_AREA", "UNKNOWN", "INACTIVE" ]
    Possible values are: -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not. -INACTIVE: Indicates that the presence reporting area is inactive in the serving node.
  • trackingAreaList
    Minimum Number of Items: 1
    Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Nested Schema : ecgiList
Type: array
Minimum Number of Items: 1
Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
Show Source
Nested Schema : globaleNbIdList
Type: array
Minimum Number of Items: 1
Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
Show Source
Nested Schema : globalRanNodeIdList
Type: array
Minimum Number of Items: 1
Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
Show Source
Nested Schema : ncgiList
Type: array
Minimum Number of Items: 1
Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
Show Source
Nested Schema : trackingAreaList
Type: array
Minimum Number of Items: 1
Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Show Source
Nested Schema : qosFlowsUsageReports
Type: array
Show Source
Nested Schema : QosFlowsUsageReport
Type: object
Show Source
Nested Schema : multipleQFIcontainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : RoamingChargingProfile
Type: object
Show Source
Nested Schema : MultipleQFIcontainer
Type: object
Show Source
Nested Schema : QFIContainerInformation
Type: object
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : QosCharacteristics
Type: object
Contains QoS characteristics for a non-standardized or a non-configured 5QI.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Minimum Value: 4096
    Maximum Value: 2000000
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Maximum Value: 4095
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
  • Allowed Values: [ "NON_GBR", "NON_CRITICAL_GBR", "CRITICAL_GBR" ]
    The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501). It should comply with the provisions defined in table 5.5.3.6-1.
Nested Schema : QosData
Type: object
Contains the QoS parameters.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates that the dynamic PCC rule should always have its binding with the QoS Flow associated with the default QoS rule
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.
  • Identifies the QoS control policy data within a PDU session.
  • Indicates whether the QoS information is reflective for the corresponding service data flow.
  • Indicates which PCC rules may share resources in the downlink direction, by containing the same value.
  • Indicates which PCC rules may share resources in the uplink direction, by containing the same value.
Nested Schema : servingNetworkFunctionID
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : Trigger
Type: object
A trigger event.
Show Source
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Indicates a time in seconds.
  • Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
  • Allowed Values: [ "FINAL", "ABNORMAL_RELEASE", "QOS_CHANGE", "VOLUME_LIMIT", "TIME_LIMIT", "EVENT_LIMIT", "PLMN_CHANGE", "USER_LOCATION_CHANGE", "RAT_CHANGE", "SESSION_AMBR_CHANGE", "UE_TIMEZONE_CHANGE", "TARIFF_TIME_CHANGE", "MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS", "MANAGEMENT_INTERVENTION", "CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA", "CHANGE_OF_3GPP_PS_DATA_OFF_STATUS", "SERVING_NODE_CHANGE", "REMOVAL_OF_UPF", "ADDITION_OF_UPF", "INSERTION_OF_ISMF", "REMOVAL_OF_ISMF", "CHANGE_OF_ISMF", "START_OF_SERVICE_DATA_FLOW", "GFBR_GUARANTEED_STATUS_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS" ]
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source

307 Response

The request should be repeated with another URI; however, future requests should still use the original URI
Headers
Body ()
Root Schema : RedirectResponse
Type: object
The response should include a Location header field containing a different URI (pointing to a different URI of an other service instance), or the same URI if a request is redirected to the same target resource via a different SCP.
Show Source

308 Response

The current and all future requests should be directed to the given URI.
Headers
Body ()
Root Schema : RedirectResponse
Type: object
The response should include a Location header field containing a different URI (pointing to a different URI of an other service instance), or the same URI if a request is redirected to the same target resource via a different SCP.
Show Source

400 Response

The request isn't valid.
Body ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : ChargingDataResponse
Type: object
A response to a request for offline-only charging.
Show Source
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."
Nested Schema : InvocationResult
Type: object
The result of a charging service invocation by the NF consumer.
Show Source
Nested Schema : PDUSessionChargingInformation
Type: object
Show Source
Nested Schema : RoamingQBCInformation
Type: object
The 5G data connectivity-specific information for roaming QBC.
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : UserLocation
Type: object
At least one of eutraLocation, nrLocation, and n3gaLocation should be present, though multiple may be included.
Show Source
Nested Schema : PDUSessionInformation
Type: object
Information about a PDU session.
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
When the data type is present in the response message, it includes the PRA information provisioned by the CHF, in which case the presenceState attribute within the PresenceInfo data type shall not be supplied. When the data type is present in the request message, it is used to report user presence reporting area status. The praId attribute within the PresenceInfo data type shall be the key of the map.
Nested Schema : RANSecondaryRATUsageReport
Type: object
Show Source
  • qosFlowsUsageReports
  • Allowed Values: [ "NR", "EUTRA", "WLAN", "VIRTUAL", "NBIOT", "WIRELINE", "WIRELINE_CABLE", "WIRELINE_BBF", "LTE-M", "NR_U", "EUTRA_U", "TRUSTED_N3GA", "TRUSTED_WLAN", "UTRA", "GERA", "NR_LEO", "NR_MEO", "NR_GEO", "NR_OTHER_SAT", "NR_REDCAP", "WB_E_UTRAN_LEO", "WB_E_UTRAN_MEO", "WB_E_UTRAN_GEO", "WB_E_UTRAN_OTHERSAT", "NB_IOT_LEO", "NB_IOT_MEO", "NB_IOT_GEO", "NB_IOT_OTHERSAT", "LTE_M_LEO", "LTE_M_MEO", "LTE_M_GEO", "LTE_M_OTHERSAT" ]
    Indicates the radio access used.
Nested Schema : UserInformation
Type: object
Information about a user and user equipment.
Show Source
  • Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    String identifying a Gpsi should contain either an External Id or an MSISDN. It should be formatted as follows -External Identifier= "extid-'extid', where 'extid' should be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an external identifier.
  • Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$
    String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.
Nested Schema : EutraLocation
Type: object
Contains the E-UTRA user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Ecgi
    Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
    This flag should indicate that the Ecgi should be ignored. When present, it should be set as follows: - true: ecgi should be ignored. - false (default): ecgi should not be ignored.
  • Default Value: false
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : GeraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • Location number within the PLMN. See 3GPP TS 23.003, clause 4.5.
  • MSC number. See 3GPP TS 23.003 clause 5.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
  • VLR number. See 3GPP TS 23.003 clause 5.1.
Match One Schema
Show Source
Nested Schema : N3gaLocation
Type: object
Contains the Non-3GPP access user location.
Show Source
  • Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003. This should be encoded as a string per clause 28.15.4 of 3GPP TS 23.003, and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH.
  • String in 'bytes' format, as defined in OpenAPI.
  • HfcNodeId
    Represents the HFC Node Identifer received over NGAP.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • Pattern: ^[A-Fa-f0-9]+$
    This IE should contain the N3IWF identifier received over NGAP and should be encoded as a string of hexadecimal characters. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Minimum Value: 0
    Unsigned Integer, that is, only 0 and integers above 0 are permissible.
  • Allowed Values: [ "UDP", "TCP" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - UDP: User Datagram Protocol. - TCP: Transmission Control Protocol.
  • TnapId
    Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
  • TwapId
    Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • Allowed Values: [ "DSL", "PON" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - DSL: Identifies a DSL line. - PON: Identifies a PON line.
Nested Schema : NrLocation
Type: object
Contains the NR user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
  • Ncgi
    Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : UtraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
Match One Schema
Show Source
Nested Schema : Ecgi
Type: object
Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{7}$
    28-bit string, identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : GlobalRanNodeId
Type: object
One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
Show Source
  • Pattern: ^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$
    This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413. The string should be formatted with the following pattern '^('MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5} |HomeeNB-[A-Fa-f0-9]{7})$'. The value of the eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing the padding 0, if required together with the 4 most significant bits of the eNB ID should appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) should appear last in the string.
  • GNbId
    Provides the G-NB identifier.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Pattern: ^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$
    This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413. The value of the ng-eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing padding 0, if required together with the 4 most significant bits of the ng-eNB ID should appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) should appear last in the string.
    Example: <b>SMacroNGeNB-34B89</b>
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID should appear first in the string, and the character representing the 4 least significant bit of the TNGF ID should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID should appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID should appear last in the string.
Match One Schema
Show Source
Nested Schema : Tai
Type: object
Contains the tracking area identity as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)
    2 or 3-octet string, identifying a tracking area code as specified in clause 9.3.3.10 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TAC should appear first in the string, and the character representing the 4 least significant bit of the TAC should appear last in the string.
Nested Schema : GNbId
Type: object
Provides the G-NB identifier.
Show Source
  • Minimum Value: 22
    Maximum Value: 32
    Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32.
  • Pattern: ^[A-Fa-f0-9]{6,8}$
    This represents the identifier of the gNB. The value of the gNB ID should be encoded in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, with the most significant character representing the padding 0. If required together, the 4 most significant bits of the gNB ID should appear first in the string, and the character representing the 4 least significant bit of the gNB ID should appear last in the string.
Nested Schema : CellGlobalId
Type: object
Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
Show Source
Nested Schema : LocationAreaId
Type: object
Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
Show Source
Nested Schema : RoutingAreaId
Type: object
Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
Show Source
Nested Schema : ServiceAreaId
Type: object
Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
Show Source
Nested Schema : HfcNodeId
Type: object
Represents the HFC Node Identifer received over NGAP.
Show Source
  • Maximum Length: 6
    This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters.
Nested Schema : TnapId
Type: object
Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should be present if the UE is accessing the 5GC via a trusted WLAN access network. When present, it should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : TwapId
Type: object
Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached for trusted WLAN access. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : Ncgi
Type: object
Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • Pattern: ^[A-Fa-f0-9]{9}$
    36-bit string, identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : AuthorizedDefaultQos
Type: object
Represents the Authorized Default QoS.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
Nested Schema : Ambr
Type: object
Contains the maximum aggregated uplink and downlink bit rates.
Show Source
Nested Schema : RanNasCauseList
Type: array
Show Source
Nested Schema : MAPDUSessionInformation
Type: object
Show Source
Nested Schema : NetworkSlicingInfo
Type: object
Information about a network slice serving the PDU session.
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : PDUAddress
Type: object
A group of user IP addresses.
Show Source
  • Indicates whether the served IPv4 PDU address is dynamically allocated (true) or not (false). This field is missing when the address is static.
  • This field indicates whether the served IPv6 PDU address is dynamically allocated (true) or not (false). This field is missing if the address is static.
  • The length of the PDU address prefix for an IPv6 typed served PDU address. The field is not required for a prefix length of 64 bits.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
Nested Schema : ServingNetworkFunctionID
Type: object
An identifier for the serving NF.
Show Source
Nested Schema : SubscribedDefaultQos
Type: object
Provides the subscribed 5QI and the ARP. It may also contain the priority level.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
Nested Schema : Arp
Type: object
Contains Allocation and Retention Priority information.
Show Source
  • Allowed Values: [ "NOT_PREEMPT", "MAY_PREEMPT" ]
    The enumeration PreemptionCapability indicates the pre-emption capability of a request on other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.1-1.
  • Allowed Values: [ "NOT_PREEMPTABLE", "PREEMPTABLE" ]
    The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.2-1.
  • Minimum Value: 1
    Maximum Value: 15
    "nullable: true" should not be used for this attribute. Unsigned integer indicating the ARP Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501) within the range 1 to 15. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 15 as the lowest priority.
Nested Schema : RanNasRelCause
Type: object
Contains the RAN/NAS release cause.
Show Source
Nested Schema : NgApCause
Type: object
Represents the NGAP cause.
Show Source
Nested Schema : AtsssCapability
Type: object
Containes Capability to support procedures related to Access Traffic Steering, Switching, and Splitting.
Show Source
  • Default Value: false
    Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501). true: Supported false (default): Not Supported
Nested Schema : NFIdentification
Type: object
A Network Function (NF).
Show Source
  • The fully qualified domain name (FQDN) of the NF.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Allowed Values: [ "SMF", "SMSF", "I-SMF" ]
Nested Schema : PresenceInfo
Type: object
If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Show Source
  • This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas. When present, this IE should contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE.
  • ecgiList
    Minimum Number of Items: 1
    Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
  • globaleNbIdList
    Minimum Number of Items: 1
    Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
  • globalRanNodeIdList
    Minimum Number of Items: 1
    Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
  • ncgiList
    Minimum Number of Items: 1
    Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
  • Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003). This IE should be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. When present, it should be encoded as a string representing an integer within the following ranges: 0 to 8 388 607 for UE-dedicated PRA. 8 388 608 to 16 777 215 for Core Network predefined PRA. Examples: PRA ID 123 is encoded as "123". PRA ID 11 238 660 is encoded as "11238660".
  • Allowed Values: [ "IN_AREA", "OUT_OF_AREA", "UNKNOWN", "INACTIVE" ]
    Possible values are: -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not. -INACTIVE: Indicates that the presence reporting area is inactive in the serving node.
  • trackingAreaList
    Minimum Number of Items: 1
    Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Nested Schema : ecgiList
Type: array
Minimum Number of Items: 1
Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
Show Source
Nested Schema : globaleNbIdList
Type: array
Minimum Number of Items: 1
Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
Show Source
Nested Schema : globalRanNodeIdList
Type: array
Minimum Number of Items: 1
Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
Show Source
Nested Schema : ncgiList
Type: array
Minimum Number of Items: 1
Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
Show Source
Nested Schema : trackingAreaList
Type: array
Minimum Number of Items: 1
Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Show Source
Nested Schema : qosFlowsUsageReports
Type: array
Show Source
Nested Schema : QosFlowsUsageReport
Type: object
Show Source
Nested Schema : multipleQFIcontainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : RoamingChargingProfile
Type: object
Show Source
Nested Schema : MultipleQFIcontainer
Type: object
Show Source
Nested Schema : QFIContainerInformation
Type: object
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : QosCharacteristics
Type: object
Contains QoS characteristics for a non-standardized or a non-configured 5QI.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Minimum Value: 4096
    Maximum Value: 2000000
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Maximum Value: 4095
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
  • Allowed Values: [ "NON_GBR", "NON_CRITICAL_GBR", "CRITICAL_GBR" ]
    The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501). It should comply with the provisions defined in table 5.5.3.6-1.
Nested Schema : QosData
Type: object
Contains the QoS parameters.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates that the dynamic PCC rule should always have its binding with the QoS Flow associated with the default QoS rule
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.
  • Identifies the QoS control policy data within a PDU session.
  • Indicates whether the QoS information is reflective for the corresponding service data flow.
  • Indicates which PCC rules may share resources in the downlink direction, by containing the same value.
  • Indicates which PCC rules may share resources in the uplink direction, by containing the same value.
Nested Schema : servingNetworkFunctionID
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : Trigger
Type: object
A trigger event.
Show Source
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Indicates a time in seconds.
  • Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
  • Allowed Values: [ "FINAL", "ABNORMAL_RELEASE", "QOS_CHANGE", "VOLUME_LIMIT", "TIME_LIMIT", "EVENT_LIMIT", "PLMN_CHANGE", "USER_LOCATION_CHANGE", "RAT_CHANGE", "SESSION_AMBR_CHANGE", "UE_TIMEZONE_CHANGE", "TARIFF_TIME_CHANGE", "MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS", "MANAGEMENT_INTERVENTION", "CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA", "CHANGE_OF_3GPP_PS_DATA_OFF_STATUS", "SERVING_NODE_CHANGE", "REMOVAL_OF_UPF", "ADDITION_OF_UPF", "INSERTION_OF_ISMF", "REMOVAL_OF_ISMF", "CHANGE_OF_ISMF", "START_OF_SERVICE_DATA_FLOW", "GFBR_GUARANTEED_STATUS_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS" ]
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source

401 Response

The request is not authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."

403 Response

The request wasn't authorized.
Body ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : ChargingDataResponse
Type: object
A response to a request for offline-only charging.
Show Source
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."
Nested Schema : InvocationResult
Type: object
The result of a charging service invocation by the NF consumer.
Show Source
Nested Schema : PDUSessionChargingInformation
Type: object
Show Source
Nested Schema : RoamingQBCInformation
Type: object
The 5G data connectivity-specific information for roaming QBC.
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : UserLocation
Type: object
At least one of eutraLocation, nrLocation, and n3gaLocation should be present, though multiple may be included.
Show Source
Nested Schema : PDUSessionInformation
Type: object
Information about a PDU session.
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
When the data type is present in the response message, it includes the PRA information provisioned by the CHF, in which case the presenceState attribute within the PresenceInfo data type shall not be supplied. When the data type is present in the request message, it is used to report user presence reporting area status. The praId attribute within the PresenceInfo data type shall be the key of the map.
Nested Schema : RANSecondaryRATUsageReport
Type: object
Show Source
  • qosFlowsUsageReports
  • Allowed Values: [ "NR", "EUTRA", "WLAN", "VIRTUAL", "NBIOT", "WIRELINE", "WIRELINE_CABLE", "WIRELINE_BBF", "LTE-M", "NR_U", "EUTRA_U", "TRUSTED_N3GA", "TRUSTED_WLAN", "UTRA", "GERA", "NR_LEO", "NR_MEO", "NR_GEO", "NR_OTHER_SAT", "NR_REDCAP", "WB_E_UTRAN_LEO", "WB_E_UTRAN_MEO", "WB_E_UTRAN_GEO", "WB_E_UTRAN_OTHERSAT", "NB_IOT_LEO", "NB_IOT_MEO", "NB_IOT_GEO", "NB_IOT_OTHERSAT", "LTE_M_LEO", "LTE_M_MEO", "LTE_M_GEO", "LTE_M_OTHERSAT" ]
    Indicates the radio access used.
Nested Schema : UserInformation
Type: object
Information about a user and user equipment.
Show Source
  • Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    String identifying a Gpsi should contain either an External Id or an MSISDN. It should be formatted as follows -External Identifier= "extid-'extid', where 'extid' should be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an external identifier.
  • Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$
    String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.
Nested Schema : EutraLocation
Type: object
Contains the E-UTRA user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Ecgi
    Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
    This flag should indicate that the Ecgi should be ignored. When present, it should be set as follows: - true: ecgi should be ignored. - false (default): ecgi should not be ignored.
  • Default Value: false
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : GeraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • Location number within the PLMN. See 3GPP TS 23.003, clause 4.5.
  • MSC number. See 3GPP TS 23.003 clause 5.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
  • VLR number. See 3GPP TS 23.003 clause 5.1.
Match One Schema
Show Source
Nested Schema : N3gaLocation
Type: object
Contains the Non-3GPP access user location.
Show Source
  • Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003. This should be encoded as a string per clause 28.15.4 of 3GPP TS 23.003, and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH.
  • String in 'bytes' format, as defined in OpenAPI.
  • HfcNodeId
    Represents the HFC Node Identifer received over NGAP.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • Pattern: ^[A-Fa-f0-9]+$
    This IE should contain the N3IWF identifier received over NGAP and should be encoded as a string of hexadecimal characters. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Minimum Value: 0
    Unsigned Integer, that is, only 0 and integers above 0 are permissible.
  • Allowed Values: [ "UDP", "TCP" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - UDP: User Datagram Protocol. - TCP: Transmission Control Protocol.
  • TnapId
    Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
  • TwapId
    Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • Allowed Values: [ "DSL", "PON" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - DSL: Identifies a DSL line. - PON: Identifies a PON line.
Nested Schema : NrLocation
Type: object
Contains the NR user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
  • Ncgi
    Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : UtraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
Match One Schema
Show Source
Nested Schema : Ecgi
Type: object
Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{7}$
    28-bit string, identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : GlobalRanNodeId
Type: object
One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
Show Source
  • Pattern: ^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$
    This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413. The string should be formatted with the following pattern '^('MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5} |HomeeNB-[A-Fa-f0-9]{7})$'. The value of the eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing the padding 0, if required together with the 4 most significant bits of the eNB ID should appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) should appear last in the string.
  • GNbId
    Provides the G-NB identifier.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Pattern: ^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$
    This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413. The value of the ng-eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing padding 0, if required together with the 4 most significant bits of the ng-eNB ID should appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) should appear last in the string.
    Example: <b>SMacroNGeNB-34B89</b>
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID should appear first in the string, and the character representing the 4 least significant bit of the TNGF ID should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID should appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID should appear last in the string.
Match One Schema
Show Source
Nested Schema : Tai
Type: object
Contains the tracking area identity as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)
    2 or 3-octet string, identifying a tracking area code as specified in clause 9.3.3.10 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TAC should appear first in the string, and the character representing the 4 least significant bit of the TAC should appear last in the string.
Nested Schema : GNbId
Type: object
Provides the G-NB identifier.
Show Source
  • Minimum Value: 22
    Maximum Value: 32
    Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32.
  • Pattern: ^[A-Fa-f0-9]{6,8}$
    This represents the identifier of the gNB. The value of the gNB ID should be encoded in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, with the most significant character representing the padding 0. If required together, the 4 most significant bits of the gNB ID should appear first in the string, and the character representing the 4 least significant bit of the gNB ID should appear last in the string.
Nested Schema : CellGlobalId
Type: object
Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
Show Source
Nested Schema : LocationAreaId
Type: object
Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
Show Source
Nested Schema : RoutingAreaId
Type: object
Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
Show Source
Nested Schema : ServiceAreaId
Type: object
Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
Show Source
Nested Schema : HfcNodeId
Type: object
Represents the HFC Node Identifer received over NGAP.
Show Source
  • Maximum Length: 6
    This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters.
Nested Schema : TnapId
Type: object
Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should be present if the UE is accessing the 5GC via a trusted WLAN access network. When present, it should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : TwapId
Type: object
Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached for trusted WLAN access. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : Ncgi
Type: object
Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • Pattern: ^[A-Fa-f0-9]{9}$
    36-bit string, identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : AuthorizedDefaultQos
Type: object
Represents the Authorized Default QoS.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
Nested Schema : Ambr
Type: object
Contains the maximum aggregated uplink and downlink bit rates.
Show Source
Nested Schema : RanNasCauseList
Type: array
Show Source
Nested Schema : MAPDUSessionInformation
Type: object
Show Source
Nested Schema : NetworkSlicingInfo
Type: object
Information about a network slice serving the PDU session.
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : PDUAddress
Type: object
A group of user IP addresses.
Show Source
  • Indicates whether the served IPv4 PDU address is dynamically allocated (true) or not (false). This field is missing when the address is static.
  • This field indicates whether the served IPv6 PDU address is dynamically allocated (true) or not (false). This field is missing if the address is static.
  • The length of the PDU address prefix for an IPv6 typed served PDU address. The field is not required for a prefix length of 64 bits.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
Nested Schema : ServingNetworkFunctionID
Type: object
An identifier for the serving NF.
Show Source
Nested Schema : SubscribedDefaultQos
Type: object
Provides the subscribed 5QI and the ARP. It may also contain the priority level.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
Nested Schema : Arp
Type: object
Contains Allocation and Retention Priority information.
Show Source
  • Allowed Values: [ "NOT_PREEMPT", "MAY_PREEMPT" ]
    The enumeration PreemptionCapability indicates the pre-emption capability of a request on other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.1-1.
  • Allowed Values: [ "NOT_PREEMPTABLE", "PREEMPTABLE" ]
    The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.2-1.
  • Minimum Value: 1
    Maximum Value: 15
    "nullable: true" should not be used for this attribute. Unsigned integer indicating the ARP Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501) within the range 1 to 15. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 15 as the lowest priority.
Nested Schema : RanNasRelCause
Type: object
Contains the RAN/NAS release cause.
Show Source
Nested Schema : NgApCause
Type: object
Represents the NGAP cause.
Show Source
Nested Schema : AtsssCapability
Type: object
Containes Capability to support procedures related to Access Traffic Steering, Switching, and Splitting.
Show Source
  • Default Value: false
    Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501). true: Supported false (default): Not Supported
Nested Schema : NFIdentification
Type: object
A Network Function (NF).
Show Source
  • The fully qualified domain name (FQDN) of the NF.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Allowed Values: [ "SMF", "SMSF", "I-SMF" ]
Nested Schema : PresenceInfo
Type: object
If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Show Source
  • This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas. When present, this IE should contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE.
  • ecgiList
    Minimum Number of Items: 1
    Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
  • globaleNbIdList
    Minimum Number of Items: 1
    Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
  • globalRanNodeIdList
    Minimum Number of Items: 1
    Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
  • ncgiList
    Minimum Number of Items: 1
    Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
  • Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003). This IE should be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. When present, it should be encoded as a string representing an integer within the following ranges: 0 to 8 388 607 for UE-dedicated PRA. 8 388 608 to 16 777 215 for Core Network predefined PRA. Examples: PRA ID 123 is encoded as "123". PRA ID 11 238 660 is encoded as "11238660".
  • Allowed Values: [ "IN_AREA", "OUT_OF_AREA", "UNKNOWN", "INACTIVE" ]
    Possible values are: -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not. -INACTIVE: Indicates that the presence reporting area is inactive in the serving node.
  • trackingAreaList
    Minimum Number of Items: 1
    Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Nested Schema : ecgiList
Type: array
Minimum Number of Items: 1
Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
Show Source
Nested Schema : globaleNbIdList
Type: array
Minimum Number of Items: 1
Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
Show Source
Nested Schema : globalRanNodeIdList
Type: array
Minimum Number of Items: 1
Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
Show Source
Nested Schema : ncgiList
Type: array
Minimum Number of Items: 1
Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
Show Source
Nested Schema : trackingAreaList
Type: array
Minimum Number of Items: 1
Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Show Source
Nested Schema : qosFlowsUsageReports
Type: array
Show Source
Nested Schema : QosFlowsUsageReport
Type: object
Show Source
Nested Schema : multipleQFIcontainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : RoamingChargingProfile
Type: object
Show Source
Nested Schema : MultipleQFIcontainer
Type: object
Show Source
Nested Schema : QFIContainerInformation
Type: object
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : QosCharacteristics
Type: object
Contains QoS characteristics for a non-standardized or a non-configured 5QI.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Minimum Value: 4096
    Maximum Value: 2000000
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Maximum Value: 4095
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
  • Allowed Values: [ "NON_GBR", "NON_CRITICAL_GBR", "CRITICAL_GBR" ]
    The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501). It should comply with the provisions defined in table 5.5.3.6-1.
Nested Schema : QosData
Type: object
Contains the QoS parameters.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates that the dynamic PCC rule should always have its binding with the QoS Flow associated with the default QoS rule
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.
  • Identifies the QoS control policy data within a PDU session.
  • Indicates whether the QoS information is reflective for the corresponding service data flow.
  • Indicates which PCC rules may share resources in the downlink direction, by containing the same value.
  • Indicates which PCC rules may share resources in the uplink direction, by containing the same value.
Nested Schema : servingNetworkFunctionID
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : Trigger
Type: object
A trigger event.
Show Source
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Indicates a time in seconds.
  • Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
  • Allowed Values: [ "FINAL", "ABNORMAL_RELEASE", "QOS_CHANGE", "VOLUME_LIMIT", "TIME_LIMIT", "EVENT_LIMIT", "PLMN_CHANGE", "USER_LOCATION_CHANGE", "RAT_CHANGE", "SESSION_AMBR_CHANGE", "UE_TIMEZONE_CHANGE", "TARIFF_TIME_CHANGE", "MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS", "MANAGEMENT_INTERVENTION", "CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA", "CHANGE_OF_3GPP_PS_DATA_OFF_STATUS", "SERVING_NODE_CHANGE", "REMOVAL_OF_UPF", "ADDITION_OF_UPF", "INSERTION_OF_ISMF", "REMOVAL_OF_ISMF", "CHANGE_OF_ISMF", "START_OF_SERVICE_DATA_FLOW", "GFBR_GUARANTEED_STATUS_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS" ]
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source

404 Response

The requested resource couldn't be found.
Body ()
Root Schema : schema
Match One Schema
Show Source
Nested Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : ChargingDataResponse
Type: object
A response to a request for offline-only charging.
Show Source
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."
Nested Schema : InvocationResult
Type: object
The result of a charging service invocation by the NF consumer.
Show Source
Nested Schema : PDUSessionChargingInformation
Type: object
Show Source
Nested Schema : RoamingQBCInformation
Type: object
The 5G data connectivity-specific information for roaming QBC.
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : UserLocation
Type: object
At least one of eutraLocation, nrLocation, and n3gaLocation should be present, though multiple may be included.
Show Source
Nested Schema : PDUSessionInformation
Type: object
Information about a PDU session.
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
When the data type is present in the response message, it includes the PRA information provisioned by the CHF, in which case the presenceState attribute within the PresenceInfo data type shall not be supplied. When the data type is present in the request message, it is used to report user presence reporting area status. The praId attribute within the PresenceInfo data type shall be the key of the map.
Nested Schema : RANSecondaryRATUsageReport
Type: object
Show Source
  • qosFlowsUsageReports
  • Allowed Values: [ "NR", "EUTRA", "WLAN", "VIRTUAL", "NBIOT", "WIRELINE", "WIRELINE_CABLE", "WIRELINE_BBF", "LTE-M", "NR_U", "EUTRA_U", "TRUSTED_N3GA", "TRUSTED_WLAN", "UTRA", "GERA", "NR_LEO", "NR_MEO", "NR_GEO", "NR_OTHER_SAT", "NR_REDCAP", "WB_E_UTRAN_LEO", "WB_E_UTRAN_MEO", "WB_E_UTRAN_GEO", "WB_E_UTRAN_OTHERSAT", "NB_IOT_LEO", "NB_IOT_MEO", "NB_IOT_GEO", "NB_IOT_OTHERSAT", "LTE_M_LEO", "LTE_M_MEO", "LTE_M_GEO", "LTE_M_OTHERSAT" ]
    Indicates the radio access used.
Nested Schema : UserInformation
Type: object
Information about a user and user equipment.
Show Source
  • Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    String identifying a Gpsi should contain either an External Id or an MSISDN. It should be formatted as follows -External Identifier= "extid-'extid', where 'extid' should be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an external identifier.
  • Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$
    String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.
Nested Schema : EutraLocation
Type: object
Contains the E-UTRA user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Ecgi
    Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
    This flag should indicate that the Ecgi should be ignored. When present, it should be set as follows: - true: ecgi should be ignored. - false (default): ecgi should not be ignored.
  • Default Value: false
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : GeraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • Location number within the PLMN. See 3GPP TS 23.003, clause 4.5.
  • MSC number. See 3GPP TS 23.003 clause 5.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
  • VLR number. See 3GPP TS 23.003 clause 5.1.
Match One Schema
Show Source
Nested Schema : N3gaLocation
Type: object
Contains the Non-3GPP access user location.
Show Source
  • Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003. This should be encoded as a string per clause 28.15.4 of 3GPP TS 23.003, and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH.
  • String in 'bytes' format, as defined in OpenAPI.
  • HfcNodeId
    Represents the HFC Node Identifer received over NGAP.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • Pattern: ^[A-Fa-f0-9]+$
    This IE should contain the N3IWF identifier received over NGAP and should be encoded as a string of hexadecimal characters. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Minimum Value: 0
    Unsigned Integer, that is, only 0 and integers above 0 are permissible.
  • Allowed Values: [ "UDP", "TCP" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - UDP: User Datagram Protocol. - TCP: Transmission Control Protocol.
  • TnapId
    Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
  • TwapId
    Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • Allowed Values: [ "DSL", "PON" ]
    This string provides forward-compatibility with future extensions to the enumeration, but it is not used to encode content defined in the present version of this API. Possible values are: - DSL: Identifies a DSL line. - PON: Identifies a PON line.
Nested Schema : NrLocation
Type: object
Contains the NR user location.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
  • Default Value: false
  • Ncgi
    Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • String in 'date-time' format, as defined in OpenAPI.
Nested Schema : UtraLocation
Type: object
Exactly one of "cgi", "sai", or "lai" should be present.
Show Source
  • Minimum Value: 0
    Maximum Value: 32767
    The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure when the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 clause 17.7.8.
  • CellGlobalId
    Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
  • Pattern: ^[0-9A-F]{20}$
    Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • Pattern: ^[0-9A-F]{16}$
    Refers to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
  • LocationAreaId
    Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
  • RoutingAreaId
    Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
  • ServiceAreaId
    Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
  • String in 'date-time' format, as defined in OpenAPI.
Match One Schema
Show Source
Nested Schema : Ecgi
Type: object
Contains the ECGI (E-UTRAN Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{7}$
    28-bit string, identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : GlobalRanNodeId
Type: object
One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, or eNbId should be present.
Show Source
  • Pattern: ^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$
    This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413. The string should be formatted with the following pattern '^('MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5} |HomeeNB-[A-Fa-f0-9]{7})$'. The value of the eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing the padding 0, if required together with the 4 most significant bits of the eNB ID should appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) should appear last in the string.
  • GNbId
    Provides the G-NB identifier.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID should appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID should appear last in the string.
  • Pattern: ^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$
    This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413. The value of the ng-eNB ID should be encoded in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, so the most significant character representing padding 0, if required together with the 4 most significant bits of the ng-eNB ID should appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) should appear last in the string.
    Example: <b>SMacroNGeNB-34B89</b>
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID should appear first in the string, and the character representing the 4 least significant bit of the TNGF ID should appear last in the string.
  • Pattern: ^[A-Fa-f0-9]+$
    This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID should appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID should appear last in the string.
Match One Schema
Show Source
Nested Schema : Tai
Type: object
Contains the tracking area identity as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)
    2 or 3-octet string, identifying a tracking area code as specified in clause 9.3.3.10 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the TAC should appear first in the string, and the character representing the 4 least significant bit of the TAC should appear last in the string.
Nested Schema : GNbId
Type: object
Provides the G-NB identifier.
Show Source
  • Minimum Value: 22
    Maximum Value: 32
    Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32.
  • Pattern: ^[A-Fa-f0-9]{6,8}$
    This represents the identifier of the gNB. The value of the gNB ID should be encoded in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The padding 0 should be added to make multiple nibbles, with the most significant character representing the padding 0. If required together, the 4 most significant bits of the gNB ID should appear first in the string, and the character representing the 4 least significant bit of the gNB ID should appear last in the string.
Nested Schema : CellGlobalId
Type: object
Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1.
Show Source
Nested Schema : LocationAreaId
Type: object
Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1.
Show Source
Nested Schema : RoutingAreaId
Type: object
Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2.
Show Source
Nested Schema : ServiceAreaId
Type: object
Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5.
Show Source
Nested Schema : HfcNodeId
Type: object
Represents the HFC Node Identifer received over NGAP.
Show Source
  • Maximum Length: 6
    This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters.
Nested Schema : TnapId
Type: object
Contains the TNAP Identifier, see clause5.6.2 of 3GPP TS 23.501.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should be present if the UE is accessing the 5GC via a trusted WLAN access network. When present, it should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : TwapId
Type: object
Contains the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402.
Show Source
  • When present, it should contain the BSSID of the access point to which the UE is attached for trusted WLAN access. See IEEE Std 802.11-2012.
  • String in 'bytes' format, as defined in OpenAPI.
  • This IE should contain the SSID of the access point to which the UE is attached, that is received over NGAP. See IEEE Std 802.11-2012.
Nested Schema : Ncgi
Type: object
Contains the NCGI (NR Cell Global Identity) as described in 3GPP 23.003.
Show Source
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
  • Pattern: ^[A-Fa-f0-9]{9}$
    36-bit string, identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string should take a value from "0" to "9", "a" to "f" or "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id should appear first in the string, and the character representing the 4 least significant bit of the Cell Id should appear last in the string.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : AuthorizedDefaultQos
Type: object
Represents the Authorized Default QoS.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
Nested Schema : Ambr
Type: object
Contains the maximum aggregated uplink and downlink bit rates.
Show Source
Nested Schema : RanNasCauseList
Type: array
Show Source
Nested Schema : MAPDUSessionInformation
Type: object
Show Source
Nested Schema : NetworkSlicingInfo
Type: object
Information about a network slice serving the PDU session.
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : PDUAddress
Type: object
A group of user IP addresses.
Show Source
  • Indicates whether the served IPv4 PDU address is dynamically allocated (true) or not (false). This field is missing when the address is static.
  • This field indicates whether the served IPv6 PDU address is dynamically allocated (true) or not (false). This field is missing if the address is static.
  • The length of the PDU address prefix for an IPv6 typed served PDU address. The field is not required for a prefix length of 64 bits.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
Nested Schema : ServingNetworkFunctionID
Type: object
An identifier for the serving NF.
Show Source
Nested Schema : SubscribedDefaultQos
Type: object
Provides the subscribed 5QI and the ARP. It may also contain the priority level.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
Nested Schema : Arp
Type: object
Contains Allocation and Retention Priority information.
Show Source
  • Allowed Values: [ "NOT_PREEMPT", "MAY_PREEMPT" ]
    The enumeration PreemptionCapability indicates the pre-emption capability of a request on other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.1-1.
  • Allowed Values: [ "NOT_PREEMPTABLE", "PREEMPTABLE" ]
    The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It should comply with the provisions defined in table 5.5.3.2-1.
  • Minimum Value: 1
    Maximum Value: 15
    "nullable: true" should not be used for this attribute. Unsigned integer indicating the ARP Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501) within the range 1 to 15. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 15 as the lowest priority.
Nested Schema : RanNasRelCause
Type: object
Contains the RAN/NAS release cause.
Show Source
Nested Schema : NgApCause
Type: object
Represents the NGAP cause.
Show Source
Nested Schema : AtsssCapability
Type: object
Containes Capability to support procedures related to Access Traffic Steering, Switching, and Splitting.
Show Source
  • Default Value: false
    Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, and Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). true: Supported false (default): Not Supported
  • Default Value: false
    This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501). true: Supported false (default): Not Supported
Nested Schema : NFIdentification
Type: object
A Network Function (NF).
Show Source
  • The fully qualified domain name (FQDN) of the NF.
  • 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])$
    String identifying an IPv4 address, formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: <b>'198.51.100.1'</b>
  • String identifying an IPv6 address, formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation should not be used according to clause 5 of RFC5952.
    Example: <b>'2001:db8:85a3::8a2e:370:7334'</b>
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • Allowed Values: [ "SMF", "SMSF", "I-SMF" ]
Nested Schema : PresenceInfo
Type: object
If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Show Source
  • This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas. When present, this IE should contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE.
  • ecgiList
    Minimum Number of Items: 1
    Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
  • globaleNbIdList
    Minimum Number of Items: 1
    Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
  • globalRanNodeIdList
    Minimum Number of Items: 1
    Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
  • ncgiList
    Minimum Number of Items: 1
    Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
  • Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003). This IE should be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. When present, it should be encoded as a string representing an integer within the following ranges: 0 to 8 388 607 for UE-dedicated PRA. 8 388 608 to 16 777 215 for Core Network predefined PRA. Examples: PRA ID 123 is encoded as "123". PRA ID 11 238 660 is encoded as "11238660".
  • Allowed Values: [ "IN_AREA", "OUT_OF_AREA", "UNKNOWN", "INACTIVE" ]
    Possible values are: -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not. -INACTIVE: Indicates that the presence reporting area is inactive in the serving node.
  • trackingAreaList
    Minimum Number of Items: 1
    Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Nested Schema : ecgiList
Type: array
Minimum Number of Items: 1
Represents the list of EUTRAN cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of EUTRAN cell IDs.
Show Source
Nested Schema : globaleNbIdList
Type: array
Minimum Number of Items: 1
Represents the list of eNodeB identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of eNodeB identifiers.
Show Source
Nested Schema : globalRanNodeIdList
Type: array
Minimum Number of Items: 1
Represents the list of NG RAN node identifiers that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
Show Source
Nested Schema : ncgiList
Type: array
Minimum Number of Items: 1
Represents the list of NR cell IDs that constitute the area. This IE should be present if the Area of Interest subscribed is a list of NR cell IDs.
Show Source
Nested Schema : trackingAreaList
Type: array
Minimum Number of Items: 1
Represents the list of tracking areas that constitute the area. This IE should be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access, the TAI shall be the N3GPP TAI.
Show Source
Nested Schema : qosFlowsUsageReports
Type: array
Show Source
Nested Schema : QosFlowsUsageReport
Type: object
Show Source
Nested Schema : multipleQFIcontainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : RoamingChargingProfile
Type: object
Show Source
Nested Schema : MultipleQFIcontainer
Type: object
Show Source
Nested Schema : QFIContainerInformation
Type: object
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE should state the presence information of the UE for the individual PRA identified by the additionalPraId IE. If the additionalPraId IE is not present, this IE should state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : QosCharacteristics
Type: object
Contains QoS characteristics for a non-standardized or a non-configured 5QI.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Minimum Value: 4096
    Maximum Value: 2000000
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Maximum Value: 4095
    Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501) expressed in Bytes.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501) within the range 1 to 127. Values are ordered in decreasing order of priority, that is, with 1 as the highest priority and 127 as the lowest priority.
  • Allowed Values: [ "NON_GBR", "NON_CRITICAL_GBR", "CRITICAL_GBR" ]
    The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501). It should comply with the provisions defined in table 5.5.3.6-1.
Nested Schema : QosData
Type: object
Contains the QoS parameters.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501) within the range 0 to 255.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    This data type is defined in the same way as the 'AverWindow' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates that the dynamic PCC rule should always have its binding with the QoS Flow associated with the default QoS rule
  • Minimum Value: 4096
    Maximum Value: 2000000
    This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Pattern: ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$
    This data type is defined in the same way as the 'BitRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Maximum Value: 4095
    This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 0
    Maximum Value: 1000
    This data type is defined in the same way as the 'PacketLossRate' data type, but with OpenAPI as 'nullable: true' property.
  • Minimum Value: 1
    Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501) expressed in milliseconds.
  • Pattern: ^([0-9]E-[0-9])$
    String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501) expressed as a "scalar x 10-k", where the scalar and the exponent k are encoded as one decimal digit.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the '5QiPriorityLevel' data type, but with OpenAPI as 'nullable: true' property.
  • Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow.
  • Identifies the QoS control policy data within a PDU session.
  • Indicates whether the QoS information is reflective for the corresponding service data flow.
  • Indicates which PCC rules may share resources in the downlink direction, by containing the same value.
  • Indicates which PCC rules may share resources in the uplink direction, by containing the same value.
Nested Schema : servingNetworkFunctionID
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : Trigger
Type: object
A trigger event.
Show Source
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Indicates a time in seconds.
  • Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
  • Allowed Values: [ "FINAL", "ABNORMAL_RELEASE", "QOS_CHANGE", "VOLUME_LIMIT", "TIME_LIMIT", "EVENT_LIMIT", "PLMN_CHANGE", "USER_LOCATION_CHANGE", "RAT_CHANGE", "SESSION_AMBR_CHANGE", "UE_TIMEZONE_CHANGE", "TARIFF_TIME_CHANGE", "MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS", "MANAGEMENT_INTERVENTION", "CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA", "CHANGE_OF_3GPP_PS_DATA_OFF_STATUS", "SERVING_NODE_CHANGE", "REMOVAL_OF_UPF", "ADDITION_OF_UPF", "INSERTION_OF_ISMF", "REMOVAL_OF_ISMF", "CHANGE_OF_ISMF", "START_OF_SERVICE_DATA_FLOW", "GFBR_GUARANTEED_STATUS_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS" ]
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source

405 Response

The HTTP method specified in the request (DELETE, GET, POST, PUT) is not supported for this request URI

408 Response

The server timed out waiting for the request.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."

410 Response

Indicates that the resource requested was previously in use but is no longer available and will not be available again.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."

411 Response

The request did not specify the length of its content, which is required by the requested resource.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."

413 Response

The request is larger than the server is willing or able to process.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."

500 Response

The server encountered an unexpected condition that prevented it from fulfilling the request.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."

503 Response

The server cannot handle the request (because it is overloaded or down for maintenance). Usually a temporary state.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Error returned in the access token response message.
  • AccessTokenReq
    Contains information related to an access token request.
  • 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.
  • A human-readable explanation specific to this occurrence of the problem.
  • String providing a URI formatted according to RFC 3986.
  • invalidParams
    Minimum Number of Items: 1
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
  • String providing a URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to an access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • String providing a URI formatted according to RFC 3986.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • Minimum Length: 4
    Maximum Length: 253
    Pattern: ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$
    Fully Qualified Domain Name.
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • requesterPlmnList
    Minimum Number of Items: 2
  • requesterSnpnList
    Minimum Number of Items: 1
  • requesterSnssaiList
    Minimum Number of Items: 1
  • Pattern: ^([a-zA-Z0-9_:-]+)( [a-zA-Z0-9_:-]+)*$
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • String uniquely identifying an NF instance. The format of the NF Instance ID should be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following string "set.sn.nfi.5gc.mnc.mcc", or encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as defined in clause 5.4.2 ("Nid" data type definition). encoded as defined in clause 5.3.2. encoded as defined in 3GPP TS 29.510. encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit should be inserted at the left side to fill the 3 digit coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9), and/or the hyphen (-) and that should end with either an alphabetic character or a digit.
  • Allowed Values: [ "NRF", "UDM", "AMF", "SMF", "AUSF", "NEF", "PCF", "SMSF", "NSSF", "UDR", "LMF", "GMLC", "5G_EIR", "SEPP", "UPF", "N3IWF", "AF", "UDSF", "BSF", "CHF", "NWDAF", "PCSCF", "CBCF", "HSS", "UCMF", "SOR_AF", "SPAF", "MME", "SCSAS", "SCEF", "SCP", "NSSAAF", "ICSCF", "SCSCF", "DRA", "IMS_AS", "AANF", "5G_DDNMF", "NSACF", "MFAF", "EASDF", "DCCF", "MB_SMF", "TSCTSF", "ADRF", "GBA_BSF", "CEF", "MB_UPF", "NSWOF", "PKMF", "MNPF", "SMS_GMSC", "SMS_IWMSC", "MBSF", "MBSTF", "PANF", "IP_SM_GW", "SMS_ROUTER" ]
    NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
  • targetSnssaiList
    Minimum Number of Items: 1
Nested Schema : invalidParams
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnId
Type: object
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : requesterPlmnList
Type: array
Minimum Number of Items: 2
Show Source
  • PlmnId
    When PlmnId needs to be converted to string (e.g. when used in maps as key), the string should be composed of three digit "mcc" followed by "-" and two or three digit "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : targetNsiList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : PlmnIdNid
Type: object
Contains the serving core network operator PLMN ID. For an SNPN, the NID together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Mobile Country Code is a part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Mobile Network Code is a part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^[A-Fa-f0-9]{11}$
    This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1).
Nested Schema : targetSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Nested Schema : Snssai
Type: object
When Snssai needs to be converted to string (e.g. when used in maps as key), the string should be composed of one to three digit "sst" optionally followed by "-" and 6 hexadecimal digit "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    3-octet string representing the Slice Differentiator in hexadecimal format. Each character in the string should take a value from "0" to "9", from "a" to "f", or from "A" to "F" and should represent 4 bits. The most significant character representing the 4 most significant bits of the SD should appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string. This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE should be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services. Values from 0 to 127 correspond to the standardized SST range and values from 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501.
Nested Schema : InvalidParam
Type: object
It contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute in a JSON body, this IE should contain the attribute's name and be encoded as a JSON Pointer. If the invalid parameter is an HTTP header, this IE should be formatted as the concatenation of the string "header" plus the header name. If the invalid parameter is a query parameter, this IE should be formatted as the concatenation of the string "query " plus the query parameter name. If the invalid parameter is a variable part of a resource URI path, this IE should contain the variable name, including the "{" and "}" symbols used in the OpenAPI specification to represent variable path segments.
  • A human-readable reason, for example, "must be a positive integer". In cases involving failed operations in a PATCH request, the reason string should identify the failed operation that using the operation's array index to help correlate the invalid parameter with the failed operation, for example, " Replacement value invalid for attribute (failed operation index= 4)."

Default Response

Generic Error
Back to Top

Examples

The following example shows how to create an Nchf converged charging session by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

The -d option specifies the file to attach as the request body. 

curl -X POST 'apiRoot/nchf-convergedcharging/v2/chargingdata/' -H "accept: */*" -H "Content-Type: application/json" -d @file.json

where:

  • apiRoot is for accessing the HTTP Gateway server at either http://hostname:httpPort or https://hostname:httpsPort.

  • file.json is the JSON file that specifies the converged charging session to create.

Example of Request Body

The following is an example of the contents of file.json sent as the request body: 

{
   "invocationTimeStamp": "2019-11-08T13:00:33.882+05:30",
   "invocationSequenceNumber": 1,
   "multipleUnitInformation": [
      {
         "resultCode": "SUCCESS",
         "ratingGroup": 10,
         "grantedUnit": {},
         "validityTime": 3600
      }
   ]
}

Example of Response Body

If successful, the response code 201 is returned along with a header. For example:

connection: keep-alive
 content-type: application/json
 date: Tue, 12 Jul 2022 08:14:13 +0530
 location: http://[0:0:0:0:0:0:0:1]:8080/nchf-convergedcharging/v2/chargingdata/7e5f7eb2-6f5a-8d7d-63df-5202fadbc512
 transfer-encoding: chunked

If the request fails, the response includes the appropriate HTTP code. For a 4xx/5xx code, the message body also contains a ProblemDetails structure with the cause attribute set to the appropriate application error.

Back to Top