1. REST API Reference 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
  • String in 'date-time' format, as defined in OpenAPI.
  • Pattern: ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$
    String identifying a Gpsi should contain either an External Id or an MSISDN. It should be formatted as follows -External Identifier= "extid-'extid', where 'extid' should be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an external identifier.
  • String providing a 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-.+|.+)$
    String identifying a Supi that should contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI), or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It should be formatted as follows - for an IMSI "imsi-", where should be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI. - for a network specific identifier "nai-, where should be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI. - for a GCI "gci-", where should be formatted according to clause 28.15.2 of 3GPP TS 23.003. - for a GLI "gli-", where should be formatted according to clause 28.16.2 of 3GPP TS 23.003. To enable the value to be used as part of a URI, the string should only contain characters that are allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
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
  • String in 'date-time' format, 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-.+|.+)$
    String identifying a Supi that should contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI), or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It should be formatted as follows - for an IMSI "imsi-", where should be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI. - for a network specific identifier "nai-, where should be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI. - for a GCI "gci-", where should be formatted according to clause 28.15.2 of 3GPP TS 23.003. - for a GLI "gli-", where should be formatted according to clause 28.16.2 of 3GPP TS 23.003. To enable the value to be used as part of a URI, the string should only contain characters that are allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
  • Pattern: ^[A-Fa-f0-9]*$
    A string indicating the features supported by an API, as defined in clause 6.6 in 3GPP TS 29.500. The string should contain a bitmask indicating supported features in hexadecimal representation. Each character in the string takes a value between "0" to "9", "a" to "f" or "A" to "F" and represents the support of 4 features, as described in table 5.2.2-3. The most significant character, representing the highest-numbered features, appears first in the string, and the character representing features 1 to 4 appear last in the string. The list of features and their numbering (starting from 1) is defined separately for each API. If the string contains fewer number of characters than the total number of defined features for an API, all features that are represented by characters missing in the string are not supported.
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

400 Response

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

401 Response

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

403 Response

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

404 Response

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

411 Response

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

413 Response

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

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

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

500 Response

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

503 Response

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

Default Response

Generic Error

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