1. REST API for Elastic Charging Engine
  2. Tasks
  3. Nchf Spending Limit Control

Create a Spending Limit Control Subscription

post

{apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions

Creates a new spending limit retrieval subscription for a specified subscriber.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Represents the subscription data structure required for an individual CHF spending limit subscription.
Show Source
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • 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.
  • Refers to a string providing an URI formatted according to RFC 3986.
  • policyCounterIds
    Minimum Number of Items: 1
    Refers to a list of policy counter identifier(s), which identifies policy counters maintained per subscriber within the CHF.
  • 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.
  • 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.
Nested Schema : policyCounterIds
Type: array
Minimum Number of Items: 1
Refers to a list of policy counter identifier(s), which identifies policy counters maintained per subscriber within the CHF.
Show Source
Back to Top

Response

Supported Media Types

201 Response

The resource was created successfully.
Headers
  • Contains the URI of the created individual spending limit resource, according to the structure. {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}
Body ()
Root Schema : SpendingLimitStatus
Type: object
Represents the data structure presenting the statuses of policy counters.
Show Source
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • statusInfos
    Minimum Number of Properties: 1
    Additional Properties Allowed: PolicyCounterInfo
    Refers to the status of the requested policy counters. The key of the map is the attribute "policyCounterId".
  • 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.
  • 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.
Nested Schema : statusInfos
Type: object
Minimum Number of Properties: 1
Additional Properties Allowed
Show Source
Refers to the status of the requested policy counters. The key of the map is the attribute "policyCounterId".
Nested Schema : PolicyCounterInfo
Type: object
Represents the data structure presenting the policy counter status.
Show Source
Nested Schema : penPolCounterStatuses
Type: array
Minimum Number of Items: 1
Provides the pending policy counter status.
Show Source
Nested Schema : PendingPolicyCounterStatus
Type: object
Represents the data structure presenting the pending policy counter status.
Show Source
  • Refers to a string with the format 'date-time', as defined in OpenAPI.
  • Identifies the policy counter status applicable for a specific policy counter identified by the policyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP.

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.

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.

415 Response

The request entity has a media type which the server or resource does not support.
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.

429 Response

The user has sent too many requests in a given amount of time.
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.

Callbacks

statusNotification
Method: post
Path: {$request.body#/notifUri}/notify
subscriptionTermination
Method: post
Path: {$request.body#/notifUri}/terminate
Back to Top

Examples

The following example shows how to create a spending limit control subscription 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-spendinglimitcontrol/v1/subscriptions" -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 spending limit subscription to create.

Example of Request Body

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

{
   "supi": "imsi-6500000427",
   "expiry": "2022-07-12T03:12:10.293Z",
   "notifUri": "http://test.example.com",
   "policyCounterIds": [
      "BOOSTPCS"
   ],
   "supportedFeatures": "F"
}

Example of Response Body

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

connection: keep-alive
content-type: application/json
date: Tue, 12 Jul 2022 08:43:23 +0530
location: apiroot/nchf-spendinglimitcontrol/v1/subscriptions/imsi-6500000427
transfer-encoding: chunked

The following shows sample response body contents:

{
   "supi": "imsi-6500000427",
   "statusInfos": {
      "BOOSTPCS": {
         "policyCounterId": "BOOSTPCS",
         "currentStatus": "Active"
      }
   },
   "expiry": null,
   "supportedFeatures": null
}
Back to Top