1. REST API for Elastic Charging Engine
  2. Tasks
  3. Nchf Offline-Only Charging

Update Offline-Only Charging Resource

post

{apiRoot}/nchf-offlineonlycharging/v1/offlinechargingdata/{OfflineChargingDataRef}/update

Updates the specified offline-only charging resource.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Details about a converged charging session.
Show Source
Nested Schema : NEFChargingInformation
Type: object
Exposure Function Northbound API-specific information.
Show Source
Nested Schema : EASDeploymentChargingInformation
Type: object
Show Source
Nested Schema : EdgeInfrastructureUsageChargingInformation
Type: object
Show Source
Nested Schema : IMSChargingInformation
Type: object
Show Source
Nested Schema : LocationReportingChargingInformation
Type: object
The 5G N2 connection-specific information.
Show Source
Nested Schema : MMTelChargingInformation
Type: object
Show Source
Nested Schema : multipleUnitUsage
Type: array
Minimum Number of Items: 0
The parameters for the quota management request or usage report.
Show Source
Nested Schema : N2ConnectionChargingInformation
Type: object
Information about a 5G N2 charging connection.
Show Source
Nested Schema : NFIdentification
Type: object
A grouped field that contains a set of information identifying the NF consumer of the charging service.
Show Source
  • 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])$
    A string that identifies an IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: 198.51.100.1
  • A string that identifies an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation, as described in clause 5 of RFC5952, must not be used.
    Example: 2001:db8:85a3::8a2e:370:7334
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • Allowed Values: [ "AMF", "SMF", "SMS", "SMSF", "PGW_C_SMF", "NEFF", "SGW", "I_SMF", "ePDG", "CEF", "NEF", "MnS_Producer", "SGSN", "V_SMF", "5G_DDNMF", "IMS_Node", "EES", "PCF", "UDM", "UPF" ]
Nested Schema : NSMChargingInformation
Type: object
The Network Slice Management (NSM)-specific information.
Show Source
Nested Schema : NSPAChargingInformation
Type: object
The network slice information, which is reported to the CHF.
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : PDUSessionChargingInformation
Type: object
The 5G data connectivity-specific information.
Show Source
Nested Schema : ProseChargingInformation
Type: object
Show Source
Nested Schema : RegistrationChargingInformation
Type: object
The 5G registration-specific information.
Show Source
Nested Schema : RoamingQBCInformation
Type: object
The 5G data connectivity-specific information for roaming QBC.
Show Source
Nested Schema : SMSChargingInformation
Type: object
SMS-specific information.
Show Source
  • Allowed Values: [ "YES", "NO" ]
  • MessageClass
  • 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.
  • OriginatorInfo
  • 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.
  • recipientInfo
    Minimum Number of Items: 0
  • Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Allowed Values: [ "SUBMISSION", "DELIVERY_REPORT", "SM_SERVICE_REQUEST", "DELIVERY" ]
  • Allowed Values: [ "LOW", "NORMAL", "HIGH" ]
  • Allowed Values: [ "NO_REPLY_PATH_SET", "REPLY_PATH_SET" ]
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Allowed Values: [ "VAS4SMS_SHORT_MESSAGE_CONTENT_PROCESSING", "VAS4SMS_SHORT_MESSAGE_FORWARDING", "VAS4SMS_SHORT_MESSAGE_FORWARDING_MULTIPLE_SUBSCRIPTIONS", "VAS4SMS_SHORT_MESSAGE_FILTERING", "VAS4SMS_SHORT_MESSAGE_RECEIPT", "VAS4SMS_SHORT_MESSAGE_NETWORK_STORAGE", "VAS4SMS_SHORT_MESSAGE_TO_MULTIPLE_DESTINATIONS", "VAS4SMS_SHORT_MESSAGE_VIRTUAL_PRIVATE_NETWORK(VPN)", "VAS4SMS_SHORT_MESSAGE_AUTO_REPLY", "VAS4SMS_SHORT_MESSAGE_PERSONAL_SIGNATURE", "VAS4SMS_SHORT_MESSAGE_DEFERRED_DELIVERY" ]
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
  • Pattern: ^[0-7]?[0-9a-fA-F]$
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Refers to a string with format "time-numoffset" optionally appended by "daylightSavingTime", where - "time-numoffset" must represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339; - "daylightSavingTime" must represent the adjustment that has been made and must be encoded as "+1" or "+2" for a +1 or +2 hours adjustment. The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.
    Example: -08:00+1
  • Pattern: ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$
    Represents a Permanent Equipment Identifier, which can be an IMEI, IMEISV, or a MAC address for 5G-RG or FN-RG. If it's a MAC address, it might include "-untrusted" to indicate that it cannot be used for regulatory purposes. Examples include "imei-012345678901234" or "mac-00-11-22-33-44-55".
  • UserLocation
    One or more out of eutraLocation, nrLocation and n3gaLocation must be present.:3
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
The triggers for usage reporting associated to the rating group, which is supplied from the CHF.

The presence of the triggers attribute without any triggerType is used by CHF to disable all of the triggers to the associated rating group.

Show Source
Nested Schema : externalIndividualIdList
Type: array
Minimum Number of Items: 1
Show Source
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    Identifies a Gpsi, which can be either an External ID or an MSISDN. It is formatted as follows -External Identifier= "extid-'extid', where 'extid' is to be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier.
Nested Schema : EASRequirements
Type: object
Show Source
Nested Schema : AffinityAntiAffinity
Type: object
Show Source
Nested Schema : ServingLocation
Type: object
Show Source
Nested Schema : SoftwareImageInfo
Type: object
Show Source
Nested Schema : VirtualResource
Type: object
Show Source
Nested Schema : affinityEAS
Type: array
Show Source
Nested Schema : antiAffinityEAS
Type: array
Show Source
Nested Schema : GeoLoc
Type: object
Show Source
Nested Schema : TopologicalServiceArea
Type: object
Show Source
Nested Schema : GeographicalCoordinates
Type: object
Indicates the geographical coordinates.
Show Source
Nested Schema : cellIdList
Type: array
Show Source
Nested Schema : PlmnId
Type: object
When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
Nested Schema : TaiList
Type: array
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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)
    Indicates a 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the TAC must appear first in the string, and the character representing the 4 least significant bit of the TAC must appear last in the string.
Nested Schema : accessNetworkInfoChange
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : accessNetworkInformation
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : accessTransferInformation
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : applicationServerInformation
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : associatedURI
Type: array
Minimum Number of Items: 1
Show Source
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : calledAssertedIdentities
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : calledIdentityChanges
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : callingPartyAddresses
Type: array
Minimum Number of Items: 1
Show Source
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : IMSAddress
Type: object
Show Source
  • Pattern: ^[0-9a-fA-F]+$
  • 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])$
    A string that identifies an IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: 198.51.100.1
  • A string that identifies an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation, as described in clause 5 of RFC5952, must not be used.
    Example: 2001:db8:85a3::8a2e:370:7334
Nested Schema : earlyMediaDescription
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : SIPEventType
Type: object
Show Source
Nested Schema : interOperatorIdentifier
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : ISUPCause
Type: object
Show Source
Nested Schema : messageBodies
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : nniInformation
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : reasonHeader
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : requestedPartyAddress
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : sdpMediaComponent
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : sdpSessionDescription
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : ServerCapabilities
Type: object
Show Source
Nested Schema : transitIOIList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : TrunkGroupID
Type: object
Show Source
Nested Schema : UserInformation
Type: object
Show Source
  • Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    Identifies a Gpsi, which can be either an External ID or an MSISDN. It is formatted as follows -External Identifier= "extid-'extid', where 'extid' is to 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})|.+)$
    Represents a Permanent Equipment Identifier, which can be an IMEI, IMEISV, or a MAC address for 5G-RG or FN-RG. If it's a MAC address, it might include "-untrusted" to indicate that it cannot be used for regulatory purposes. Examples include "imei-012345678901234" or "mac-00-11-22-33-44-55".
Nested Schema : UserLocation
Type: object
One or more out of eutraLocation, nrLocation and n3gaLocation must be present.:3
Show Source
Nested Schema : AccessNetworkInfoChange
Type: object
Show Source
Nested Schema : accessNetworkInformation
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : AccessTransferInformation
Type: object
Show Source
Nested Schema : accessNetworkInformation
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : CalledIdentityChange
Type: object
Show Source
Nested Schema : EarlyMediaDescription
Type: object
Show Source
Nested Schema : sDPMediaComponent
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : sDPSessionDescription
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : SDPTimeStamps
Type: object
Show Source
Nested Schema : SDPMediaComponent
Type: object
Show Source
Nested Schema : SDPMediaDescription
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : InterOperatorIdentifier
Type: object
Show Source
Nested Schema : MessageBody
Type: object
Show Source
Nested Schema : NNIInformation
Type: object
Show Source
Nested Schema : mandatoryCapability
Type: array
Minimum Number of Items: 0
Show Source
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
Nested Schema : optionalCapability
Type: array
Minimum Number of Items: 0
Show Source
  • Minimum Value: 0
    Maximum Value: 4294967295
    Integer where the allowed values correspond to the value range of an unsigned 32-bit integer.
Nested Schema : serverName
Type: array
Minimum Number of Items: 0
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, eNbId must be present.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId must be present.
  • Default Value: false
    This flag indicates whether the Ecgi should be ignored. - When set to true, the Ecgi will be ignored. - When set to false (default), the Ecgi will not be ignored.
  • Default Value: false
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
Nested Schema : GeraLocation
Type: object
Refers to the Gera Location. You must add either one of CGI, SAI, or LAI in this field.
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.
  • Refers to the location number within the PLMN. For more information, see 3GPP TS 23.003, clause 4.5.
  • Refers to the MSC number. For more information, 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.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Refers to the VLR number. For more information, 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
  • Refers to the 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 must 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.
  • Refers to a string with format 'bytes' 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 contains the N3IWF identifier received over NGAP and is encoded as a string of hexadecimal characters. Each character in the string must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID must appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID must appear last in the string.
  • Minimum Value: 0
    Refers to an unsigned integer, with only values of 0 and above are permitted.
  • Allowed Values: [ "UDP", "TCP" ]
    This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. Possible values are: - UDP: User Datagram Protocol. - TCP: Transmission Control Protocol.
  • TnapId
    Contain the TNAP Identifier see clause5.6.2 of 3GPP TS 23.501.
  • TwapId
    Contains the TWAP IS 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])$
    A string that identifies an IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: 198.51.100.1
  • A string that identifies an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation, as described in clause 5 of RFC5952, must not be used.
    Example: 2001:db8:85a3::8a2e:370:7334
  • Allowed Values: [ "DSL", "PON" ]
    This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. Possible values are: - 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}$
    Refer 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, eNbId must 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.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
Nested Schema : UtraLocation
Type: object
Any one of cgi, sai or lai must 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.
  • 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.
  • Refers to a string with the format 'date-time', 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}$
    Indicates a 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id must appear first in the string, and the character representing the 4 least significant bit of the Cell Id must 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : GlobalRanNodeId
Type: object
One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId must 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 must 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 must be encoded in hexadecimal representation. Each character in the string must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The padding 0 must 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 must appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) must 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID must appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID must 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 must be encoded in hexadecimal representation. Each character in the string must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The padding 0 must 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 ng-eNB ID must appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) must appear last in the string.
    Example: SMacroNGeNB-34B89
  • 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID must appear first in the string, and the character representing the 4 least significant bit of the TNGF ID must 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID must appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID must 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
    Represents an 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 must be encoded in hexadecimal representation. Each character in the string must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The padding 0 must be added to make multiple nibbles, the most significant character representing the padding 0 if required together with the 4 most significant bits of the gNB ID must appear first in the string, and the character representing the 4 least significant bit of the gNB ID must 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
Contain the TNAP Identifier see clause5.6.2 of 3GPP TS 23.501.
Show Source
  • When present, it contains the BSSID of the access point to which the UE is attached, received over NGAP. For more information, see IEEE Std 802.11-2012.
  • Refers to a string with format 'bytes' as defined in OpenAPI.
  • Include this IE if the UE accesses the 5GC via a trusted WLAN access network. It contains the SSID of the access point to which the UE is attached, received over NGAP. For more information, see IEEE Std 802.11-2012.
Nested Schema : TwapId
Type: object
Contains the TWAP IS 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 contains the BSSID of the access point to which the UE is attached for a trusted WLAN access. For more information, see IEEE Std 802.11-2012.
  • Refers to a string with format 'bytes' as defined in OpenAPI.
  • This IE contains the SSID of the access point to which the UE is attached, received over NGAP. For more information, 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}$
    Indicates a 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id must appear first in the string, and the character representing the 4 least significant bit of the Cell Id must appear last in the string.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE must 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 must state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : PSCellInformation
Type: object
Show Source
Nested Schema : PresenceInfo
Type: object
If the additionalPraId IE is present, this IE must 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 must state the presence information of the UE for the PRA identified by the praId IE.
Show Source
  • This IE may be present when the praId IE contains an identifier for a set of Core Network predefined Presence Reporting Areas. When present, it must contain the identifier of an individual PRA within that set.
  • ecgiList
    Minimum Number of Items: 1
    Represents the list of EUTRAN cell Ids that constitutes the area. This IE will 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 constitutes the area. This IE must 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 constitutes the area. This IE must 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 constitutes the area. This IE will be present if the Area of Interest subscribed is a list of NR cell Ids.
  • Represents the identifier of a Presence Reporting Area (PRA) as defined in clause 28.10 of 3GPP TS 23.003. This IE is present when the Area of Interest subscribed or reported is a PRA or a set of Core Network predefined PRAs. It is encoded as a string representing an integer within the following ranges: 0 to 8,388,607 for UE-dedicated PRAs 8,388,608 to 16,777,215 for Core Network predefined PRAs. 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 (TAs) that constitute the area of interest. This IE is mandatory when subscribing or reporting UE presence in specific TAs. For non-3GPP access, the TAI must be the N3GPP TAI.
Nested Schema : ecgiList
Type: array
Minimum Number of Items: 1
Represents the list of EUTRAN cell Ids that constitutes the area. This IE will 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 constitutes the area. This IE must 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 constitutes the area. This IE must 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 constitutes the area. This IE will 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 (TAs) that constitute the area of interest. This IE is mandatory when subscribing or reporting UE presence in specific TAs. For non-3GPP access, the TAI must be the N3GPP TAI.
Show Source
Nested Schema : supplementaryServices
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : SupplementaryService
Type: object
Show Source
Nested Schema : MultipleUnitUsage
Type: object
Show Source
Nested Schema : PDUAddress
Type: object
Show Source
Nested Schema : RequestedUnit
Type: object
Show Source
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
  • 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
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : usedUnitContainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : addIpv6AddrPrefixList
Type: array
Show Source
  • A string that identifies an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.
    Example: 2001:db8:abcd:12::0/64
Nested Schema : UsedUnitContainer
Type: object
Show Source
Nested Schema : eventTimeStamps
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : NSPAContainerInformation
Type: object
Show Source
Nested Schema : PC5ContainerInformation
Type: object
Show Source
Nested Schema : PDUContainerInformation
Type: object
Show Source
Nested Schema : triggers
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : Throughput
Type: object
Show Source
Nested Schema : NsiLoadLevelInfo
Type: object
Represents the network slice and optionally the associated network slice instance and the load level information.
Show Source
Nested Schema : ServiceExperienceInfo
Type: object
Represents service experience information.
Show Source
  • Indicates a string providing an application identifier.
  • AddrFqdn
    IP address and/or FQDN.
  • Minimum Value: 0
    Refers to an unsigned integer, with only values of 0 and above are permitted.
  • Refers to the DNAI (Data network access identifier), see clause 5.6.7 of 3GPP TS 23.501.
  • Represents a Data Network as defined in clause 9A of 3GPP TS 23.003. It must contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier,as specified in 3GPP TS 23.003 clauses 9.1.1 and 9.1.2. It must be coded as a string with labels separated by dots (e.g., "Label1.Label2.Label3").
  • NetworkAreaInfo
    Describes a network area information in which the NF service consumer requests the number of UEs.
  • Contains the Identifier of the selected Network Slice instance
  • RatFreqInformation
    Represents the RAT type and/or Frequency information.
  • Minimum Value: 1
    Maximum Value: 100
    Refers to the unsigned integer that indicates the sampling ratio, expressed in percent. For more information, see clauses 4.15.1 of 3GPP TS 23.502.
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
  • Possible values are: - VOICE: Indicates that the service experience analytics is for voice service. - VIDEO: Indicates that the service experience analytics is for video service. - OTHER: Indicates that the service experience analytics is for other service.
  • supis
    Minimum Number of Items: 1
  • SvcExperience
    Contains a mean opinion score with the customized range.
  • A string with format 'float' as defined in OpenAPI.
  • ueLocs
    Minimum Number of Items: 1
  • UpfInformation
    Represents the ID/address/FQDN of the UPF.
Nested Schema : NetworkAreaInfo
Type: object
Describes a network area information in which the NF service consumer requests the number of UEs.
Show Source
Nested Schema : NumberAverage
Type: object
Represents information about the average and variance.
Show Source
Nested Schema : ResourceUsage
Type: object
The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.
Show Source
  • Minimum Value: 0
    Refers to an unsigned integer, with only values of 0 and above are permitted.
  • Minimum Value: 0
    Refers to an unsigned integer, with only values of 0 and above are permitted.
  • Minimum Value: 0
    Refers to an unsigned integer, with only values of 0 and above are permitted.
Nested Schema : resUsgThrCrossTimePeriod
Type: array
Minimum Number of Items: 1
Each element indicates the time elapsed between times each threshold is met or exceeded or crossed. The start time and end time are the exact time stamps of the resource usage threshold is reached or exceeded. May be present if the "listOfAnaSubsets" attribute is provided and the maximum number of instances shall not exceed the value provided in the "numOfExceedLoadLevelThr" attribute.
Show Source
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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 : TimeWindow
Type: object
Represents a time window identified by a start time and a stop time.
Show Source
Nested Schema : ecgis
Type: array
Minimum Number of Items: 1
Contains a list of E-UTRA cell identities.
Show Source
Nested Schema : gRanNodeIds
Type: array
Minimum Number of Items: 1
Contains a list of NG RAN nodes.
Show Source
Nested Schema : ncgis
Type: array
Minimum Number of Items: 1
Contains a list of NR cell identities.
Show Source
Nested Schema : tais
Type: array
Minimum Number of Items: 1
Contains a list of tracking area identities.
Show Source
Nested Schema : AddrFqdn
Type: object
IP address and/or FQDN.
Show Source
Nested Schema : RatFreqInformation
Type: object
Represents the RAT type and/or Frequency information.
Show Source
  • Set to "true" to indicate to handle all the frequencies the NWDAF received, otherwise set to "false" or omit. The "allFreq" attribute and the "freq" attribute are mutually exclusive.
  • Set to "true" to indicate to handle all the RAT Types the NWDAF received, otherwise set to "false" or omit. The "allRat" attribute and the "ratType" attribute are mutually exclusive.
  • Minimum Value: 0
    Maximum Value: 3279165
    Indicates the ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR global frequency raster, as definition of "ARFCN-ValueNR" IE in clause 6.3.2 of 3GPP TS 38.331.
  • Possible values are: - ASCENDING: Threshold is crossed in ascending direction. - DESCENDING: Threshold is crossed in descending direction. - CROSSED: Threshold is crossed either in ascending or descending direction.
  • 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.
  • ThresholdLevel
    Represents a threshold level.
Nested Schema : supis
Type: array
Minimum Number of Items: 1
Show Source
  • Pattern: ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$
    Identifies a Subscriber Identity (Supi), which can be an IMSI, a Network-Specific Identifier (NAI), a Global Cable Identifier (GCI), or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. For IMSI: Formatted as "imsi-" where follows the format defined in clause 2.2 of 3GPP TS 23.003. For NAI: Formatted as "nai-" where follows the format defined in clause 28.7.2 of 3GPP TS 23.003. For GCI: Formatted as "gci-" where follows the format defined in clause 28.15.2 of 3GPP TS 23.003. For GLI: Formatted as "gli-" where follows the format defined in clause 28.16.2 of 3GPP TS 23.003.
Nested Schema : SvcExperience
Type: object
Contains a mean opinion score with the customized range.
Show Source
Nested Schema : ueLocs
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : UpfInformation
Type: object
Represents the ID/address/FQDN of the UPF.
Show Source
Nested Schema : IpAddr
Type: object
Contains the IP address.
Show Source
  • 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])$
    A string that identifies an IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: 198.51.100.1
  • A string that identifies an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation, as described in clause 5 of RFC5952, must not be used.
    Example: 2001:db8:85a3::8a2e:370:7334
  • A string that identifies an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.
    Example: 2001:db8:abcd:12::0/64
Match One Schema
Show Source
Nested Schema : ThresholdLevel
Type: object
Represents a threshold level.
Show Source
Nested Schema : LocationInfo
Type: object
Represents UE location information.
Show Source
  • Minimum Value: 0
    Refers to an unsigned integer, with only values of 0 and above are permitted.
  • UserLocation
    One or more out of eutraLocation, nrLocation and n3gaLocation must be present.:3
  • Minimum Value: 1
    Maximum Value: 100
    Refers to the unsigned integer that indicates the sampling ratio, expressed in percent. For more information, see clauses 4.15.1 of 3GPP TS 23.502.
Nested Schema : coverageInfoList
Type: array
Show Source
Nested Schema : radioParameterSetInfoList
Type: array
Show Source
Nested Schema : transmitterInfoList
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : CoverageInfo
Type: object
Show Source
Nested Schema : locationInfo
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : RadioParameterSetInfo
Type: object
Show Source
Nested Schema : radioParameterSetValues
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : TransmitterInfo
Type: object
Show Source
Nested Schema : SteeringMode
Type: object
Contains the steering mode value and parameters determined by the PCF.
Show Source
  • Minimum Value: 0
    Refers to an unsigned integer, with only values of 0 and above are permitted.
  • 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 the OpenAPI 'nullable: true' property."
  • Contains an autonomous load-balance indicator or UE-assistance indicator.
  • Allowed Values: [ "ACTIVE_STANDBY", "LOAD_BALANCING", "SMALLEST_DELAY", "PRIORITY_BASED" ]
    Indicates 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 must 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 must 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
    Refers to the unsigned integer representing a 5G QoS Identifier, within the range 0 to 255. For more information, see clause 5.7.2.1 of 3GPP TS 23.501.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    Refers to the unsigned integer indicating the averaging window, expressed in milliseconds. For more information, see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 4096
    Maximum Value: 2000000
    Refers to the unsigned integer that indicates the maximum data burst volume, expressed in Bytes. For more information, see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 1
    Maximum Value: 4095
    Refers to the unsigned integer indicating the Maximum Data Burst Volume, expressed in Bytes. For more information, see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 1
    Refers to the unsigned integer that indicates the Packet Delay Budget, expressed in milliseconds. For more information, see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501.
  • Pattern: ^([0-9]E-[0-9])$
    Represents the Packet Error Rate expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as one decimal digit. For more information, see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 1
    Maximum Value: 127
    This unsigned integer indicates the 5QI Priority Level (1-127, see 3GPP TS 23.501 clauses 5.7.3.3 and 5.7.4). Lower values indicate higher priority (1 is highest, 127 is lowest).
  • Allowed Values: [ "NON_GBR", "NON_CRITICAL_GBR", "CRITICAL_GBR" ]
    Indicates if a QoS Flow is non-GBR, delay critical GBR, or a non-delay critical GBR. For more information, 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
    Refers to the unsigned integer representing a 5G QoS Identifier, within the range 0 to 255. For more information, see clause 5.7.2.1 of 3GPP TS 23.501.
  • 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 the OpenAPI nullable: true property.
  • Indicates that the dynamic PCC rule must always be bound to 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI nullable: true property.
  • Minimum Value: 1
    Refers to the unsigned integer that indicates the Packet Delay Budget, expressed in milliseconds. For more information, see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501.
  • Pattern: ^([0-9]E-[0-9])$
    Represents the Packet Error Rate expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as one decimal digit. For more information, see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the 5QiPriorityLevel data type, but with the OpenAPI 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.
  • Uniquely 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 can share resources in the downlink direction by containing the same value.
  • Indicates which PCC rules can share resources in the uplink direction by containing the same value.
Nested Schema : qosMonitoringReport
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : servingNodeID
Type: array
Minimum Number of Items: 0
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 the OpenAPI nullable: true property.
  • Minimum Value: 0
    Refers to an unsigned Integer, i.e. only value 0 and integers above 0 are permissible with the OpenAPI 'nullable: true' property.
Nested Schema : Arp
Type: object
Contains Allocation and Retention Priority information.
Show Source
  • Allowed Values: [ "NOT_PREEMPT", "MAY_PREEMPT" ]
    Indicates the pre-emption capability of a request on other QoS flows. For more information, 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" ]
    Indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. For more information, 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
    This attribute is not nullable. It contains an unsigned integer representing the ARP Priority Level (1-15, see 3GPP TS 23.501 clause 5.7.2.2). Lower values indicate higher priority (1 is highest, 15 is lowest).
Nested Schema : QosMonitoringReport
Type: object
Contains reporting information on QoS monitoring.
Show Source
Nested Schema : dlDelays
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : refPccRuleIds
Type: array
Minimum Number of Items: 1
An array of PCC rule id references to the PCC rules associated with the QoS monitoring report.
Show Source
Nested Schema : rtDelays
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : ulDelays
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : ServingNetworkFunctionID
Type: object
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    Indicates a string identifying the AMF ID composed of AMF Region ID (8 bits), AMF Set ID (10 bits) and AMF Pointer (6 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded as a string of 6 hexadecimal characters (i.e., 24 bits).
  • NFIdentification
    A grouped field that contains a set of information identifying the NF consumer of the charging service.
Nested Schema : Trigger
Type: object
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.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • An integer that indicates time in seconds.
  • Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
  • Allowed Values: [ "QUOTA_THRESHOLD", "QHT", "FINAL", "QUOTA_EXHAUSTED", "VALIDITY_TIME", "OTHER_QUOTA_TYPE", "FORCED_REAUTHORISATION", "UNUSED_QUOTA_TIMER", "UNIT_COUNT_INACTIVITY_TIMER", "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", "ECGI_CHANGE", "TAI_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "GFBR_GUARANTEED_STATUS_CHANGE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS", "REDUNDANT_TRANSMISSION_CHANGE", "CGI_SAI_CHANGE", "RAI_CHANGE", "VSMF_CHANGE" ]
  • 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
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : allowedNSSAI
Type: array
Minimum Number of Items: 0
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : forbiddenAreaList
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : restrictedCnList
Type: array
Minimum Number of Items: 0
Show Source
  • Allowed Values: [ "5GC", "EPC" ]
    It contains the Core Network type 5GC or EPC.
Nested Schema : restrictedRatList
Type: array
Minimum Number of Items: 0
Show Source
  • 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 : serviceAreaRestriction
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : Area
Type: object
Provides area information.
Show Source
Match One Schema
Show Source
Nested Schema : tacs
Type: array
Minimum Number of Items: 1
Show Source
  • Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)
    Indicates a 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the TAC must appear first in the string, and the character representing the 4 least significant bit of the TAC must appear last in the string.
Nested Schema : ServiceAreaRestriction
Type: object
Provides information about allowed or not allowed areas.
Show Source
Match All
Provides information about allowed or not allowed areas.
Provides information about allowed or not allowed areas.
Provides information about allowed or not allowed areas.
Show Source
Nested Schema : areas
Type: array
Show Source
Nested Schema : ServiceAreaRestriction-allOf[0]
Match One Schema
Show Source
Nested Schema : listOfserviceProfileChargingInformation
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : ServiceProfileChargingInformation
Type: object
Show Source
Nested Schema : sNSSAIList
Type: array
Minimum Number of Items: 0
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : PDUSessionInformation
Type: object
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 must 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 must state the presence information of the UE for the PRA identified by the praId IE.
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 : 5GLANTypeService
Type: object
Show Source
  • Pattern: ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$
    Identifies a group of devices with a network-internal globally unique ID, as specified in clause 19.9 of 3GPP TS 23.003. This ID identifies a set of IMSIs.
Nested Schema : AuthorizedDefaultQos
Type: object
Represents the Authorized Default QoS.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Refers to the unsigned integer representing a 5G QoS Identifier, within the range 0 to 255. For more information, see clause 5.7.2.1 of 3GPP TS 23.501.
  • 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : SubscribedDefaultQos
Type: object
Provides the subsribed 5QI and the ARP, it may contain the priority level.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Refers to the unsigned integer representing a 5G QoS Identifier, within the range 0 to 255. For more information, see clause 5.7.2.1 of 3GPP TS 23.501.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 127
    This unsigned integer indicates the 5QI Priority Level (1-127, see 3GPP TS 23.501 clauses 5.7.3.3 and 5.7.4). Lower values indicate higher priority (1 is highest, 127 is lowest).
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
Contains Capability to support procedures related to Access Traffic Steering, Switching, Splitting.
Show Source
  • Default Value: false
    Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, 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, 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 : qosFlowsUsageReports
Type: array
Show Source
Nested Schema : QosFlowsUsageReport
Type: object
Show Source
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Minimum Value: 0
    Maximum Value: 63
    Refers to the unsigned integer that identifies a QoS flow, within the range 0 to 63.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : applicationSpecificDataList
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : pFIContainerInformation
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : receptionDataContainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : transmissionDataContainer
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : PFIContainerInformation
Type: object
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 must 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 must state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : PC5DataContainer
Type: object
Show Source
Nested Schema : allowedNSSAI
Type: array
Minimum Number of Items: 0
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : nSSAIMapList
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : rejectedNSSAI
Type: array
Minimum Number of Items: 0
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : requestedNSSAI
Type: array
Minimum Number of Items: 0
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : serviceAreaRestriction
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : taiList
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : NSSAIMap
Type: object
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
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 : enhancedDiagnostics
Type: array
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 must 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 must 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
Nested Schema : MessageClass
Type: object
Show Source
Nested Schema : OriginatorInfo
Type: object
Show Source
Nested Schema : recipientInfo
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : SMAddressInfo
Type: object
Show Source
Nested Schema : SMInterface
Type: object
Show Source
Nested Schema : SMAddressDomain
Type: object
Show Source
Nested Schema : RecipientInfo
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

The charging data resource was updated successfully.
Body ()
Root Schema : ChargingDataResponse
Type: object
Show Source
Nested Schema : InvocationResult
Type: object
The result.
Show Source
Nested Schema : LocationReportingChargingInformation
Type: object
The 5G N2 connection-specific information.
Show Source
Nested Schema : multipleUnitInformation
Type: array
Minimum Number of Items: 0
The parameters for quota management or usage reporting. It may have multiple occurrences.
Show Source
Nested Schema : PDUSessionChargingInformation
Type: object
The 5G data connectivity-specific information.
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
The triggers for usage reporting associated to the rating group, which is supplied from the CHF.

The presence of the triggers attribute without a triggerType is used by CHF to disable all triggers to the associated rating group.

Show Source
Nested Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.
Nested Schema : presenceReportingAreaInformation
Type: object
Minimum Number of Properties: 0
Additional Properties Allowed
Show Source
  • PresenceInfo
    If the additionalPraId IE is present, this IE must 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 must state the presence information of the UE for the PRA identified by the praId IE.
Nested Schema : PSCellInformation
Type: object
Show Source
Nested Schema : UserInformation
Type: object
Show Source
  • Allowed Values: [ "IN_BOUND", "OUT_BOUND" ]
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    Identifies a Gpsi, which can be either an External ID or an MSISDN. It is formatted as follows -External Identifier= "extid-'extid', where 'extid' is to 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})|.+)$
    Represents a Permanent Equipment Identifier, which can be an IMEI, IMEISV, or a MAC address for 5G-RG or FN-RG. If it's a MAC address, it might include "-untrusted" to indicate that it cannot be used for regulatory purposes. Examples include "imei-012345678901234" or "mac-00-11-22-33-44-55".
Nested Schema : UserLocation
Type: object
One or more out of eutraLocation, nrLocation and n3gaLocation must be present.:3
Show Source
Nested Schema : PresenceInfo
Type: object
If the additionalPraId IE is present, this IE must 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 must state the presence information of the UE for the PRA identified by the praId IE.
Show Source
  • This IE may be present when the praId IE contains an identifier for a set of Core Network predefined Presence Reporting Areas. When present, it must contain the identifier of an individual PRA within that set.
  • ecgiList
    Minimum Number of Items: 1
    Represents the list of EUTRAN cell Ids that constitutes the area. This IE will 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 constitutes the area. This IE must 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 constitutes the area. This IE must 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 constitutes the area. This IE will be present if the Area of Interest subscribed is a list of NR cell Ids.
  • Represents the identifier of a Presence Reporting Area (PRA) as defined in clause 28.10 of 3GPP TS 23.003. This IE is present when the Area of Interest subscribed or reported is a PRA or a set of Core Network predefined PRAs. It is encoded as a string representing an integer within the following ranges: 0 to 8,388,607 for UE-dedicated PRAs 8,388,608 to 16,777,215 for Core Network predefined PRAs. 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 (TAs) that constitute the area of interest. This IE is mandatory when subscribing or reporting UE presence in specific TAs. For non-3GPP access, the TAI must be the N3GPP TAI.
Nested Schema : ecgiList
Type: array
Minimum Number of Items: 1
Represents the list of EUTRAN cell Ids that constitutes the area. This IE will 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 constitutes the area. This IE must 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 constitutes the area. This IE must 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 constitutes the area. This IE will 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 (TAs) that constitute the area of interest. This IE is mandatory when subscribing or reporting UE presence in specific TAs. For non-3GPP access, the TAI must 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}$
    Indicates a 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id must appear first in the string, and the character representing the 4 least significant bit of the Cell Id must 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : GlobalRanNodeId
Type: object
One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId must 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 must 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 must be encoded in hexadecimal representation. Each character in the string must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The padding 0 must 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 must appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) must 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID must appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID must 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 must be encoded in hexadecimal representation. Each character in the string must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The padding 0 must 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 ng-eNB ID must appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) must appear last in the string.
    Example: SMacroNGeNB-34B89
  • 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID must appear first in the string, and the character representing the 4 least significant bit of the TNGF ID must 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID must appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID must 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
    Represents an 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 must be encoded in hexadecimal representation. Each character in the string must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The padding 0 must be added to make multiple nibbles, the most significant character representing the padding 0 if required together with the 4 most significant bits of the gNB ID must appear first in the string, and the character representing the 4 least significant bit of the gNB ID must 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}$
    Indicates a 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id must appear first in the string, and the character representing the 4 least significant bit of the Cell Id must appear last in the string.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • Pattern: (^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)
    Indicates a 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 must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the TAC must appear first in the string, and the character representing the 4 least significant bit of the TAC must appear last in the string.
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, eNbId must be present.
  • GlobalRanNodeId
    One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId must be present.
  • Default Value: false
    This flag indicates whether the Ecgi should be ignored. - When set to true, the Ecgi will be ignored. - When set to false (default), the Ecgi will not be ignored.
  • Default Value: false
  • Tai
    Contains the tracking area identity as described in 3GPP 23.003.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
Nested Schema : GeraLocation
Type: object
Refers to the Gera Location. You must add either one of CGI, SAI, or LAI in this field.
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.
  • Refers to the location number within the PLMN. For more information, see 3GPP TS 23.003, clause 4.5.
  • Refers to the MSC number. For more information, 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.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Refers to the VLR number. For more information, 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
  • Refers to the 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 must 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.
  • Refers to a string with format 'bytes' 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 contains the N3IWF identifier received over NGAP and is encoded as a string of hexadecimal characters. Each character in the string must take a value of "0" to "9", "a" to "f" or "A" to "F" and must represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID must appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID must appear last in the string.
  • Minimum Value: 0
    Refers to an unsigned integer, with only values of 0 and above are permitted.
  • Allowed Values: [ "UDP", "TCP" ]
    This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. Possible values are: - UDP: User Datagram Protocol. - TCP: Transmission Control Protocol.
  • TnapId
    Contain the TNAP Identifier see clause5.6.2 of 3GPP TS 23.501.
  • TwapId
    Contains the TWAP IS 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])$
    A string that identifies an IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: 198.51.100.1
  • A string that identifies an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation, as described in clause 5 of RFC5952, must not be used.
    Example: 2001:db8:85a3::8a2e:370:7334
  • Allowed Values: [ "DSL", "PON" ]
    This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. Possible values are: - 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}$
    Refer 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, eNbId must 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.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
Nested Schema : UtraLocation
Type: object
Any one of cgi, sai or lai must 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.
  • 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.
  • Refers to a string with the format 'date-time', 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
Contain the TNAP Identifier see clause5.6.2 of 3GPP TS 23.501.
Show Source
  • When present, it contains the BSSID of the access point to which the UE is attached, received over NGAP. For more information, see IEEE Std 802.11-2012.
  • Refers to a string with format 'bytes' as defined in OpenAPI.
  • Include this IE if the UE accesses the 5GC via a trusted WLAN access network. It contains the SSID of the access point to which the UE is attached, received over NGAP. For more information, see IEEE Std 802.11-2012.
Nested Schema : TwapId
Type: object
Contains the TWAP IS 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 contains the BSSID of the access point to which the UE is attached for a trusted WLAN access. For more information, see IEEE Std 802.11-2012.
  • Refers to a string with format 'bytes' as defined in OpenAPI.
  • This IE contains the SSID of the access point to which the UE is attached, received over NGAP. For more information, see IEEE Std 802.11-2012.
Nested Schema : MultipleUnitInformation
Type: object
Show Source
Nested Schema : AnnouncementInformation
Type: object
Show Source
Nested Schema : FinalUnitIndication
Type: object
Show Source
Nested Schema : GrantedUnit
Type: object
Show Source
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • 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
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an 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
Nested Schema : variableParts
Type: array
Minimum Number of Items: 0
Show Source
Nested Schema : VariablePart
Type: object
Show Source
Nested Schema : variablePartValue
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : filterIdList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : RedirectServer
Type: object
Show Source
  • Possible values are - IPV4_ADDR: Indicates that the address type is in the form of "dotted-decimal" IPv4 address. - IPV6_ADDR: Indicates that the address type is in the form of IPv6 address. - URL: Indicates that the address type is in the form of Uniform Resource Locator. - SIP_URI: Indicates that the address type is in the form of SIP Uniform Resource Identifier.
Nested Schema : restrictionFilterRuleList
Type: array
Minimum Number of Items: 1
Show Source
Nested Schema : Trigger
Type: object
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.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • An integer that indicates time in seconds.
  • Allowed Values: [ "IMMEDIATE_REPORT", "DEFERRED_REPORT" ]
  • Allowed Values: [ "QUOTA_THRESHOLD", "QHT", "FINAL", "QUOTA_EXHAUSTED", "VALIDITY_TIME", "OTHER_QUOTA_TYPE", "FORCED_REAUTHORISATION", "UNUSED_QUOTA_TIMER", "UNIT_COUNT_INACTIVITY_TIMER", "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", "ECGI_CHANGE", "TAI_CHANGE", "HANDOVER_CANCEL", "HANDOVER_START", "HANDOVER_COMPLETE", "GFBR_GUARANTEED_STATUS_CHANGE", "ADDITION_OF_ACCESS", "REMOVAL_OF_ACCESS", "START_OF_SDF_ADDITIONAL_ACCESS", "REDUNDANT_TRANSMISSION_CHANGE", "CGI_SAI_CHANGE", "RAI_CHANGE", "VSMF_CHANGE" ]
  • 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
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
Nested Schema : PDUSessionInformation
Type: object
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 must 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 must state the presence information of the UE for the PRA identified by the praId IE.
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 : 5GLANTypeService
Type: object
Show Source
  • Pattern: ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$
    Identifies a group of devices with a network-internal globally unique ID, as specified in clause 19.9 of 3GPP TS 23.003. This ID identifies a set of IMSIs.
Nested Schema : AuthorizedDefaultQos
Type: object
Represents the Authorized Default QoS.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Refers to the unsigned integer representing a 5G QoS Identifier, within the range 0 to 255. For more information, see clause 5.7.2.1 of 3GPP TS 23.501.
  • 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : PDUAddress
Type: object
Show Source
Nested Schema : ServingNetworkFunctionID
Type: object
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    Indicates a string identifying the AMF ID composed of AMF Region ID (8 bits), AMF Set ID (10 bits) and AMF Pointer (6 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded as a string of 6 hexadecimal characters (i.e., 24 bits).
  • NFIdentification
    A grouped field that contains a set of information identifying the NF consumer of the charging service.
Nested Schema : SubscribedDefaultQos
Type: object
Provides the subsribed 5QI and the ARP, it may contain the priority level.
Show Source
  • Minimum Value: 0
    Maximum Value: 255
    Refers to the unsigned integer representing a 5G QoS Identifier, within the range 0 to 255. For more information, see clause 5.7.2.1 of 3GPP TS 23.501.
  • Arp
    Contains Allocation and Retention Priority information.
  • Minimum Value: 1
    Maximum Value: 127
    This unsigned integer indicates the 5QI Priority Level (1-127, see 3GPP TS 23.501 clauses 5.7.3.3 and 5.7.4). Lower values indicate higher priority (1 is highest, 127 is lowest).
Nested Schema : Arp
Type: object
Contains Allocation and Retention Priority information.
Show Source
  • Allowed Values: [ "NOT_PREEMPT", "MAY_PREEMPT" ]
    Indicates the pre-emption capability of a request on other QoS flows. For more information, 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" ]
    Indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. For more information, 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
    This attribute is not nullable. It contains an unsigned integer representing the ARP Priority Level (1-15, see 3GPP TS 23.501 clause 5.7.2.2). Lower values indicate higher priority (1 is highest, 15 is lowest).
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
Contains Capability to support procedures related to Access Traffic Steering, Switching, Splitting.
Show Source
  • Default Value: false
    Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, 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, 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 : addIpv6AddrPrefixList
Type: array
Show Source
  • A string that identifies an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.
    Example: 2001:db8:abcd:12::0/64
Nested Schema : NFIdentification
Type: object
A grouped field that contains a set of information identifying the NF consumer of the charging service.
Show Source
  • 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])$
    A string that identifies an IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.
    Example: 198.51.100.1
  • A string that identifies an IPv6 address formatted according to clause 4 of RFC5952. The mixed IPv4 IPv6 notation, as described in clause 5 of RFC5952, must not be used.
    Example: 2001:db8:85a3::8a2e:370:7334
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • Allowed Values: [ "AMF", "SMF", "SMS", "SMSF", "PGW_C_SMF", "NEFF", "SGW", "I_SMF", "ePDG", "CEF", "NEF", "MnS_Producer", "SGSN", "V_SMF", "5G_DDNMF", "IMS_Node", "EES", "PCF", "UDM", "UPF" ]
Nested Schema : qosFlowsUsageReports
Type: array
Show Source
Nested Schema : QosFlowsUsageReport
Type: object
Show Source
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Minimum Value: 0
    Maximum Value: 63
    Refers to the unsigned integer that identifies a QoS flow, within the range 0 to 63.
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Minimum Value: 0
    Maximum Value: 18446744073709552000
    Refers to an integer where the allowed values correspond to the value range of an unsigned 64-bit integer.
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 : enhancedDiagnostics
Type: array
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 must 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 must 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
    Refers to the unsigned integer representing a 5G QoS Identifier, within the range 0 to 255. For more information, see clause 5.7.2.1 of 3GPP TS 23.501.
  • Minimum Value: 1
    Maximum Value: 4095
    Default Value: 2000
    Refers to the unsigned integer indicating the averaging window, expressed in milliseconds. For more information, see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 4096
    Maximum Value: 2000000
    Refers to the unsigned integer that indicates the maximum data burst volume, expressed in Bytes. For more information, see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 1
    Maximum Value: 4095
    Refers to the unsigned integer indicating the Maximum Data Burst Volume, expressed in Bytes. For more information, see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 1
    Refers to the unsigned integer that indicates the Packet Delay Budget, expressed in milliseconds. For more information, see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501.
  • Pattern: ^([0-9]E-[0-9])$
    Represents the Packet Error Rate expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as one decimal digit. For more information, see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 1
    Maximum Value: 127
    This unsigned integer indicates the 5QI Priority Level (1-127, see 3GPP TS 23.501 clauses 5.7.3.3 and 5.7.4). Lower values indicate higher priority (1 is highest, 127 is lowest).
  • Allowed Values: [ "NON_GBR", "NON_CRITICAL_GBR", "CRITICAL_GBR" ]
    Indicates if a QoS Flow is non-GBR, delay critical GBR, or a non-delay critical GBR. For more information, 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
    Refers to the unsigned integer representing a 5G QoS Identifier, within the range 0 to 255. For more information, see clause 5.7.2.1 of 3GPP TS 23.501.
  • 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 the OpenAPI nullable: true property.
  • Indicates that the dynamic PCC rule must always be bound to 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI 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 the OpenAPI nullable: true property.
  • Minimum Value: 1
    Refers to the unsigned integer that indicates the Packet Delay Budget, expressed in milliseconds. For more information, see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501.
  • Pattern: ^([0-9]E-[0-9])$
    Represents the Packet Error Rate expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as one decimal digit. For more information, see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501.
  • Minimum Value: 1
    Maximum Value: 127
    This data type is defined in the same way as the 5QiPriorityLevel data type, but with the OpenAPI 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.
  • Uniquely 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 can share resources in the downlink direction by containing the same value.
  • Indicates which PCC rules can 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 : triggers
Type: array
Minimum Number of Items: 0
Show Source

400 Response

The request isn't valid.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

401 Response

Unauthorized request.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

403 Response

The request wasn't authorized.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

404 Response

The requested resource couldn't be found.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

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
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

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
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

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
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

500 Response

The system encountered an internal error.
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

503 Response

The server cannot handle the request (because it is overloaded or down for maintenance).
Body ()
Root Schema : ProblemDetails
Type: object
Provides additional information in an error response.
Show Source
  • AccessTokenErr
    Indicates error returned in the access token response message.
  • AccessTokenReq
    Contains information related to the 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.
  • Refers to a string providing an 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}\.?$
    A Fully Qualified Domain Name.
  • Pattern: ^[A-Fa-f0-9]*$
    This string indicates the features supported by an API, as defined in clause 6.6 of 3GPP TS 29.500. It is a hexadecimal representation of a bitmask, where each character represents the support of 4 features as described in table 5.2.2-3. The string is ordered with the most significant character, representing the highest-numbered features, appearing first. The character representing features 1 to 4 appears last. The list of features and their numbering (starting with 1) are defined separately for each API. If the string's length is less than the total number of features defined for an API, all features corresponding to missing characters are considered unsupported.
  • Refers to a string providing an URI formatted according to RFC 3986.
Nested Schema : AccessTokenErr
Type: object
Indicates error returned in the access token response message.
Show Source
Nested Schema : AccessTokenReq
Type: object
Contains information related to the access token request.
Show Source
  • Allowed Values: [ "client_credentials" ]
  • Refers to a string providing an URI formatted according to RFC 3986.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must 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" ]
    Indicates 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}\.?$
    A Fully Qualified Domain Name.
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "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_:-]+)*$
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates a string uniquely identifying a NF instance. The format of the NF Instance ID must be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must end with either an alphabetic character or a digit.
  • Indicates the 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 must be inserted at the left side to fill the 3 digits 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 must 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" ]
    Indicates NF types known to NRF.
  • targetNsiList
    Minimum Number of Items: 1
  • PlmnId
    When converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, PlmnId is represented as three digits "mcc" followed by "-" and two or three digits "mnc".
Nested Schema : requesterSnpnList
Type: array
Minimum Number of Items: 1
Show Source
  • PlmnIdNid
    Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Nested Schema : requesterSnssaiList
Type: array
Minimum Number of Items: 1
Show Source
  • Snssai
    When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "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 and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
Show Source
  • Pattern: ^\d{3}$
    Indicates the Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413.
  • Pattern: ^\d{2,3}$
    Indicates the Mobile Network Code 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 converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Nested Schema : Snssai
Type: object
When converted to a string, for example, when used in maps as key, Snssai is represented as one to three digits "sst" optionally followed by a hyphen "-" and 6 hexadecimal digits "sd".
Show Source
  • Pattern: ^[A-Fa-f0-9]{6}$
    A 3-octet string representing the Slice Differentiator (SD) in hexadecimal format. Each character takes a value from "0" to "9", "a" to "f" or "A" to "F", representing 4 bits. The most significant bits are represented by the first character, and the least significant bits by the last. This is an optional parameter used to differentiate between multiple Network Slices of the same Slice/Service type. This IE must be absent if no SD value is associated with the SST.
  • Minimum Value: 0
    Maximum Value: 255
    Indicates an 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 0 to 127 correspond to the standardized SST range. Values 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
Contains an invalid parameter and a related description.
Show Source
  • If the invalid parameter is an attribute within a JSON body, the "invalidParameter" IE must be encoded as a JSON Pointer. For invalid HTTP headers, the IE must be formatted as "header " concatenated with the header name. For invalid query parameters, it must be formatted as "query " concatenated with the query parameter name. For invalid variable path segments, the IE must contain the variable name within curly braces ("{}"), as defined in the OpenAPI specification.
  • A human-readable reason for the error must be provided, such as "must be a positive integer." In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index, for example: "Replacement value invalid for attribute (failed operation index= 4)." This helps correlate the invalid parameter with the specific failed operation.

Default Response

Refers to a Generic Error.
Back to Top

Examples

The following example shows how to update an existing Nchf offline-only 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/v1/offlinechargingdata/87cfb534-9efa-5192-41fd-cbcfdb053226%20/update" -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 offline-only charging session to update.

Example of Request Body

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

{
   "invocationSequenceNumber": 2,
   "invocationTimeStamp": "2024-09-24T08:30:33.882Z",
   "multipleUnitUsage": [
      {
         "ratingGroup": 10,
         "usedUnitContainer": [{
            "localSequenceNumber": 0,
            "quotaManagementIndicator": "OFFLINE_CHARGING",
            "time": 600
         }],
         "uPFID": "123e4567-e89b-12d3-a456-426655440000"
      }
   ],
   "notifyUri": "http://test-notification-url",
   "nfConsumerIdentification": {
      "nodeFunctionality": "SMF"
   },
   "pDUSessionChargingInformation": {
      "chargingId": 1000,
      "pduSessionInformation": {
         "pduSessionID": 1,
         "dnnId": "1"
      }
   },
   "roamingQBCInformation": {},
   "subscriberIdentifier": "imsi-4900000001",
   "triggers": [
      {
         "triggerCategory": "IMMEDIATE_REPORT",
         "triggerType": "QUOTA_THRESHOLD"
      }
   ]
}

Example of Response Body

If successful, the response code 200 is returned along with a header and response body. The following shows sample header content:

connection: keep-alive
content-length: 154
content-type: application/json
date: Tue, 12 Jul 2025 08:35:49 +0530

The following shows sample response body content:

{
   "invocationTimeStamp": "2024-09-24T14:00:33.882+05:30",
   "invocationSequenceNumber": 2,
   "multipleUnitInformation": [
      {
         "resultCode": "SUCCESS",
         "ratingGroup": 10
      }
   ]
}

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