API docs by Redocly

Npcf_SMPolicyControl API (1.3.1)

Download OpenAPI specification:

Session Management Policy Control Service
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.512 V18.7.0; 5G System; Session Management Policy Control Service.

SM Policies (Collection)

Create a new Individual SM Policy.

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required
object or object (AccNetChId)

Contains the access network charging identifier for the PCC rule(s) or for the whole PDU session.

object or object (AccNetChargingAddress)

Describes the network entity within the access network performing charging

gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier.

supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall 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 shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
invalidSupi
boolean

When this attribute is included and set to true, it indicates that the supi attribute contains an invalid value.This attribute shall be present if the SUPI is not available in the SMF or the SUPI is unauthenticated. When present it shall be set to true for an invalid SUPI and false (default) for a valid SUPI.

interGrpIds
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]
pduSessionId
required
integer (PduSessionId) [ 0 .. 255 ]

Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network.

required
string or string (PduSessionType)

PduSessionType indicates the type of a PDU session. It shall comply with the provisions defined in table 5.4.3.3-1.

chargingcharacteristics
string
dnn
required
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

string or string (DnnSelectionMode)

DNN Selection Mode. Possible values are

  • VERIFIED
  • UE_DNN_NOT_VERIFIED
  • NW_DNN_NOT_VERIFIED
notificationUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

accessType
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

string or string (RatType)

Indicates the radio access used.

object (AdditionalAccessInfo)

Indicates the combination of additional Access Type and RAT Type for a MA PDU session.

object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

ueTimeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

pei
string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a...

String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.

ipv4Address
string (Ipv4Addr) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2...

String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.

ipv6AddressPrefix
string (Ipv6Prefix) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((...

String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.

ipDomain
string

Indicates the IPv4 address domain

object (Ambr)

Contains the maximum aggregated uplink and downlink bit rates.

authProfIndex
string

Indicates the DN-AAA authorization profile index

object (SubscribedDefaultQos)

Provides the subsribed 5QI and the ARP, it may contain the priority level.

object (VplmnQos)

VPLMN QoS

numOfPackFilter
integer

Contains the number of supported packet filter for signalled QoS rules.

online
boolean

If it is included and set to true, the online charging is applied to the PDU session.

offline
boolean

If it is included and set to true, the offline charging is applied to the PDU session.

3gppPsDataOffStatus
boolean

If it is included and set to true, the 3GPP PS Data Off is activated by the UE.

refQosIndication
boolean

If it is included and set to true, the reflective QoS is supported by the UE.

object or null (TraceData)

contains Trace control and configuration parameters.

required
object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

string or string (QosFlowUsage)

Indicates a QoS flow usage information.
Possible values are

  • GENERAL: Indicate no specific QoS flow usage information is available.
  • IMS_SIG: Indicate that the QoS flow is used for IMS signalling only.
object (ServingNfIdentity)

Contains the serving Network Function identity.

suppFeat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

smfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

recoveryTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

string or string (MaPduIndication)

Contains the MA PDU session indication, i.e., MA PDU Request or MA PDU Network-Upgrade Allowed.

string or string (AtsssCapability)

Contains the ATSSS capability supported for the MA PDU Session.

ipv4FrameRouteList
Array of strings (Ipv4AddrMask) non-empty [ items^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... ]
ipv6FrameRouteList
Array of strings (Ipv6Prefix) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]
string or string (SatelliteBackhaulCategory)

Indicates the satellite backhaul used.

object or null (PcfUeCallbackInfo)

Contains the PCF for the UE information necessary for the PCF for the PDU session to send SM Policy Association Establishment and Termination events.

Array of objects or objects or objects (ServerAddressingInfo) non-empty
onboardInd
boolean

If it is included and set to true, it indicates that the PDU session is used for UE Onboarding.

Array of objects (NwdafData) non-empty
urspEnfInfo
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

string or string (SscMode)

represents the service and session continuity mode It shall comply with the provisions defined in table 5.4.3.6-1.

ueReqDnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

string or string (PduSessionType)

PduSessionType indicates the type of a PDU session. It shall comply with the provisions defined in table 5.4.3.3-1.

hrsboInd
boolean

HR-SBO support indication. If present and set to "true", it indicates that the HR-SBO is supported. Default value is "false" if omitted.

(N1N2MessageTransferCause (N1N2MessageTransferCause (string) or N1N2MessageTransferCause (string))) or (N1N2MessTransferErrorReply (N1N2MessTransferErrorReply (string) or N1N2MessTransferErrorReply (string))) (UePolicyTransferFailureCause)

UE Policy Transfer Failure Cause.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "accNetChId": {
    },
  • "chargEntityAddr": {
    },
  • "gpsi": "string",
  • "supi": "string",
  • "invalidSupi": true,
  • "interGrpIds": [
    ],
  • "pduSessionId": 255,
  • "pduSessionType": "IPV4",
  • "chargingcharacteristics": "string",
  • "dnn": "string",
  • "dnnSelMode": "VERIFIED",
  • "notificationUri": "string",
  • "accessType": "3GPP_ACCESS",
  • "ratType": "NR",
  • "addAccessInfo": {
    },
  • "servingNetwork": {
    },
  • "userLocationInfo": {
    },
  • "ueTimeZone": "-08:00+1",
  • "pei": "string",
  • "ipv4Address": "198.51.100.1",
  • "ipv6AddressPrefix": "2001:db8:abcd:12::0/64",
  • "ipDomain": "string",
  • "subsSessAmbr": {
    },
  • "authProfIndex": "string",
  • "subsDefQos": {
    },
  • "vplmnQos": {
    },
  • "numOfPackFilter": 0,
  • "online": true,
  • "offline": true,
  • "3gppPsDataOffStatus": true,
  • "refQosIndication": true,
  • "traceReq": {
    },
  • "sliceInfo": {
    },
  • "altSliceInfo": {
    },
  • "qosFlowUsage": "GENERAL",
  • "servNfId": {
    },
  • "suppFeat": "string",
  • "smfId": "0f68cfce-0f8d-4135-9a5a-e1cc0a6fe527",
  • "recoveryTime": "2019-08-24T14:15:22Z",
  • "maPduInd": "MA_PDU_REQUEST",
  • "atsssCapab": "MPTCP_ATSSS_LL_WITH_ASMODE_UL",
  • "ipv4FrameRouteList": [
    ],
  • "ipv6FrameRouteList": [
    ],
  • "satBackhaulCategory": "GEO",
  • "pcfUeInfo": {
    },
  • "pvsInfo": [
    ],
  • "onboardInd": true,
  • "nwdafDatas": [
    ],
  • "urspEnfInfo": "string",
  • "sscMode": "SSC_MODE_1",
  • "ueReqDnn": "string",
  • "ueReqPduSessionType": "IPV4",
  • "hrsboInd": true,
  • "uePolFailReport": "ATTEMPTING_TO_REACH_UE"
}

Response samples

Content type
application/json
{
  • "sessRules": {
    },
  • "pccRules": {
    },
  • "pcscfRestIndication": true,
  • "qosDecs": {
    },
  • "chgDecs": {
    },
  • "chargingInfo": {
    },
  • "traffContDecs": {
    },
  • "umDecs": {
    },
  • "qosChars": {
    },
  • "qosMonDecs": {
    },
  • "reflectiveQoSTimer": 0,
  • "conds": {
    },
  • "revalidationTime": "2019-08-24T14:15:22Z",
  • "offline": true,
  • "online": true,
  • "offlineChOnly": false,
  • "policyCtrlReqTriggers": [
    ],
  • "lastReqRuleData": [
    ],
  • "lastReqUsageData": {
    },
  • "praInfos": {
    },
  • "ipv4Index": 0,
  • "ipv6Index": 0,
  • "qosFlowUsage": "GENERAL",
  • "relCause": "UNSPECIFIED",
  • "suppFeat": "string",
  • "tsnBridgeManCont": {
    },
  • "tsnPortManContDstt": {
    },
  • "tsnPortManContNwtts": [
    ],
  • "tscNotifUri": "string",
  • "tscNotifCorreId": "string",
  • "redSessIndication": true,
  • "uePolCont": "string",
  • "sliceUsgCtrlInfo": {
    },
  • "vplmnOffloadInfos": [
    ],
  • "vplmnDlAmbr": {
    }
}

Callback payload samples

Callback
Content type
application/json
{
  • "resourceUri": "string",
  • "smPolicyDecision": {
    }
}

Individual SM Policy (Document)

Read an Individual SM Policy

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
smPolicyId
required
string

Identifier of a policy association.

Responses

Response samples

Content type
application/json
{
  • "context": {
    },
  • "policy": {
    }
}

Update an existing Individual SM Policy

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
smPolicyId
required
string

Identifier of a policy association.

Request Body schema: application/json
required
Array of strings or strings (PolicyControlRequestTrigger) non-empty

The policy control reqeust trigges which are met.

Array of objects or objects (AccNetChId) non-empty

Indicates the access network charging identifier for the PCC rule(s) or whole PDU session.

accessType
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

string or string (RatType)

Indicates the radio access used.

object (AdditionalAccessInfo)

Indicates the combination of additional Access Type and RAT Type for a MA PDU session.

object (AdditionalAccessInfo)

Indicates the combination of additional Access Type and RAT Type for a MA PDU session.

object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

ueTimeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

relIpv4Address
string (Ipv4Addr) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2...

String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.

ipv4Address
string (Ipv4Addr) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2...

String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166.

ipDomain
string

Indicates the IPv4 address domain

ipv6AddressPrefix
string (Ipv6Prefix) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((...

String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.

relIpv6AddressPrefix
string (Ipv6Prefix) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((...

String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.

addIpv6AddrPrefixes
string (Ipv6Prefix) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((...

String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.

addRelIpv6AddrPrefixes
string (Ipv6Prefix) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((...

String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address.

multiIpv6Prefixes
Array of strings (Ipv6Prefix) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]

The multiple allocated IPv6 prefixes of the served UE.

multiRelIpv6Prefixes
Array of strings (Ipv6Prefix) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]

The multiple released IPv6 prefixes of the served UE.

relUeMac
string (MacAddr48) ^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$

String identifying a MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042.

ueMac
string (MacAddr48) ^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$

String identifying a MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042.

object (Ambr)

Contains the maximum aggregated uplink and downlink bit rates.

authProfIndex
string

Indicates the DN-AAA authorization profile index

object (SubscribedDefaultQos)

Provides the subsribed 5QI and the ARP, it may contain the priority level.

object (VplmnQos)

VPLMN QoS

vplmnQosNotApp
boolean

If it is included and set to true, indicates that the QoS constraints in the VPLMN are not applicable.

numOfPackFilter
integer

Contains the number of supported packet filter for signalled QoS rules.

Array of objects (AccuUsageReport) non-empty

Contains the usage report

3gppPsDataOffStatus
boolean

If it is included and set to true, the 3GPP PS Data Off is activated by the UE.

Array of objects (AppDetectionInfo) non-empty

Report the start/stop of the application traffic and detected SDF descriptions if applicable.

Array of objects (RuleReport) non-empty

Used to report the PCC rule failure.

Array of objects (SessionRuleReport) non-empty

Used to report the session rule failure.

Array of objects (QosNotificationControlInfo) non-empty

QoS Notification Control information.

Array of objects (QosMonitoringReport) non-empty

QoS Monitoring reporting information.

Array of objects (QosMonitoringReport) non-empty
Array of objects (QosMonitoringReport) non-empty
userLocationInfoTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

object non-empty

Reports the changes of presence reporting area. The praId attribute within the PresenceInfo data type is the key of the map.

object (UeInitiatedResourceRequest)

Indicates that a UE requests specific QoS handling for the selected SDF.

refQosIndication
boolean

If it is included and set to true, the reflective QoS is supported by the UE. If it is included and set to false, the reflective QoS is revoked by the UE.

string or string (QosFlowUsage)

Indicates a QoS flow usage information.
Possible values are

  • GENERAL: Indicate no specific QoS flow usage information is available.
  • IMS_SIG: Indicate that the QoS flow is used for IMS signalling only.
string or string (CreditManagementStatus)

Indicates the reason of the credit management session failure.

object (ServingNfIdentity)

Contains the serving Network Function identity.

object or null (TraceData)

contains Trace control and configuration parameters.

string or string (MaPduIndication)

Contains the MA PDU session indication, i.e., MA PDU Request or MA PDU Network-Upgrade Allowed.

string or string (AtsssCapability)

Contains the ATSSS capability supported for the MA PDU Session.

object (TsnBridgeInfo)

Contains parameters that describe and identify the TSC user plane node.

object (BridgeManagementContainer)

Contains the UMIC.

object (PortManagementContainer)

Contains the port management information container for a port.

Array of objects (PortManagementContainer) non-empty
tscNotifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

tscNotifCorreId
string

Correlation identifier for TSC management information notifications.

Array of objects (IpMulticastAddressInfo) non-empty
Array of strings or strings (PolicyDecisionFailureCode) non-empty

Contains the type(s) of failed policy decision and/or condition data.

Array of objects (InvalidParam) non-empty

Indicates the invalid parameters for the reported type(s) of the failed policy decision and/or condition data.

Array of objects (DddTrafficDescriptor) non-empty
pccRuleId
string

Contains the identifier of the PCC rule which is used for traffic detection of event.

Array of strings or strings (DlDataDeliveryStatus) non-empty
interGrpIds
Array of strings (GroupId) non-empty [ items^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0... ]
string or string (SatelliteBackhaulCategory)

Indicates the satellite backhaul used.

object or null (PcfUeCallbackInfo)

Contains the PCF for the UE information necessary for the PCF for the PDU session to send SM Policy Association Establishment and Termination events.

Array of objects or null (NwdafData) non-empty
anGwStatus
boolean

When it is included and set to true, it indicates that the AN-Gateway has failed and that the PCF should refrain from sending policy decisions to the SMF until it is informed that the AN-Gateway has been recovered.

uePolCont
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

(N1N2MessageTransferCause (N1N2MessageTransferCause (string) or N1N2MessageTransferCause (string))) or (N1N2MessTransferErrorReply (N1N2MessTransferErrorReply (string) or N1N2MessTransferErrorReply (string))) (UePolicyTransferFailureCause)

UE Policy Transfer Failure Cause.

urspEnfInfo
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

string or string (SscMode)

represents the service and session continuity mode It shall comply with the provisions defined in table 5.4.3.6-1.

ueReqDnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

string or string (PduSessionType)

PduSessionType indicates the type of a PDU session. It shall comply with the provisions defined in table 5.4.3.3-1.

Array of objects (L4sSupportInfo) non-empty

ECN marking for L4S support availability in 5GS.

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

object (BatOffsetInfoPcc)

Indicates the offset of the BAT and the optionally adjusted periodicity.

hrsboInd
boolean

HR-SBO support indication. If present and set to "true", it indicates that the HR-SBO is supported. If present and set to "false", it indicates that the HR-SBO is not supported.

string or string (UeReachabilityStatus)

Indicates the UE rechability status.
Possible values are:

  • REACHABLE: Indicates that the UE is reachable.
  • UNREACHABLE: Indicates that the UE is unreachable.
retryAfter
integer (Uinteger) >= 0

Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.

Responses

Request samples

Content type
application/json
{
  • "repPolicyCtrlReqTriggers": [
    ],
  • "accNetChIds": [
    ],
  • "accessType": "3GPP_ACCESS",
  • "ratType": "NR",
  • "addAccessInfo": {
    },
  • "relAccessInfo": {
    },
  • "servingNetwork": {
    },
  • "userLocationInfo": {
    },
  • "ueTimeZone": "-08:00+1",
  • "relIpv4Address": "198.51.100.1",
  • "ipv4Address": "198.51.100.1",
  • "ipDomain": "string",
  • "ipv6AddressPrefix": "2001:db8:abcd:12::0/64",
  • "relIpv6AddressPrefix": "2001:db8:abcd:12::0/64",
  • "addIpv6AddrPrefixes": "2001:db8:abcd:12::0/64",
  • "addRelIpv6AddrPrefixes": "2001:db8:abcd:12::0/64",
  • "multiIpv6Prefixes": [
    ],
  • "multiRelIpv6Prefixes": [
    ],
  • "relUeMac": "string",
  • "ueMac": "string",
  • "subsSessAmbr": {
    },
  • "authProfIndex": "string",
  • "subsDefQos": {
    },
  • "vplmnQos": {
    },
  • "vplmnQosNotApp": true,
  • "numOfPackFilter": 0,
  • "accuUsageReports": [
    ],
  • "3gppPsDataOffStatus": true,
  • "appDetectionInfos": [
    ],
  • "ruleReports": [
    ],
  • "sessRuleReports": [
    ],
  • "qncReports": [
    ],
  • "qosMonReports": [
    ],
  • "qosMonDatRateReps": [
    ],
  • "qosMonCongReps": [
    ],
  • "userLocationInfoTime": "2019-08-24T14:15:22Z",
  • "repPraInfos": {
    },
  • "ueInitResReq": {
    },
  • "refQosIndication": true,
  • "qosFlowUsage": "GENERAL",
  • "creditManageStatus": "END_USER_SER_DENIED",
  • "servNfId": {
    },
  • "traceReq": {
    },
  • "maPduInd": "MA_PDU_REQUEST",
  • "atsssCapab": "MPTCP_ATSSS_LL_WITH_ASMODE_UL",
  • "tsnBridgeInfo": {
    },
  • "tsnBridgeManCont": {
    },
  • "tsnPortManContDstt": {
    },
  • "tsnPortManContNwtts": [
    ],
  • "tscNotifUri": "string",
  • "tscNotifCorreId": "string",
  • "mulAddrInfos": [
    ],
  • "policyDecFailureReports": [
    ],
  • "invalidPolicyDecs": [
    ],
  • "trafficDescriptors": [
    ],
  • "pccRuleId": "string",
  • "typesOfNotif": [
    ],
  • "interGrpIds": [
    ],
  • "satBackhaulCategory": "GEO",
  • "pcfUeInfo": {
    },
  • "nwdafDatas": [
    ],
  • "anGwStatus": true,
  • "uePolCont": "string",
  • "uePolFailReport": "ATTEMPTING_TO_REACH_UE",
  • "urspEnfInfo": "string",
  • "sscMode": "SSC_MODE_1",
  • "ueReqDnn": "string",
  • "ueReqPduSessionType": "IPV4",
  • "l4sReports": [
    ],
  • "altSliceInfo": {
    },
  • "batOffsetInfo": {
    },
  • "hrsboInd": true,
  • "ueReachStatus": "REACHABLE",
  • "retryAfter": 0
}

Response samples

Content type
application/json
{
  • "sessRules": {
    },
  • "pccRules": {
    },
  • "pcscfRestIndication": true,
  • "qosDecs": {
    },
  • "chgDecs": {
    },
  • "chargingInfo": {
    },
  • "traffContDecs": {
    },
  • "umDecs": {
    },
  • "qosChars": {
    },
  • "qosMonDecs": {
    },
  • "reflectiveQoSTimer": 0,
  • "conds": {
    },
  • "revalidationTime": "2019-08-24T14:15:22Z",
  • "offline": true,
  • "online": true,
  • "offlineChOnly": false,
  • "policyCtrlReqTriggers": [
    ],
  • "lastReqRuleData": [
    ],
  • "lastReqUsageData": {
    },
  • "praInfos": {
    },
  • "ipv4Index": 0,
  • "ipv6Index": 0,
  • "qosFlowUsage": "GENERAL",
  • "relCause": "UNSPECIFIED",
  • "suppFeat": "string",
  • "tsnBridgeManCont": {
    },
  • "tsnPortManContDstt": {
    },
  • "tsnPortManContNwtts": [
    ],
  • "tscNotifUri": "string",
  • "tscNotifCorreId": "string",
  • "redSessIndication": true,
  • "uePolCont": "string",
  • "sliceUsgCtrlInfo": {
    },
  • "vplmnOffloadInfos": [
    ],
  • "vplmnDlAmbr": {
    }
}

Delete an existing Individual SM Policy.

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
smPolicyId
required
string

Identifier of a policy association.

Request Body schema: application/json
required
object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

ueTimeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

userLocationInfoTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

Array of objects (RanNasRelCause) non-empty

Contains the RAN and/or NAS release cause.

Array of objects (AccuUsageReport) non-empty

Contains the usage report

string or string (PduSessionRelCause)

Contains the SMF PDU Session release cause.

Responses

Request samples

Content type
application/json
{
  • "userLocationInfo": {
    },
  • "ueTimeZone": "-08:00+1",
  • "servingNetwork": {
    },
  • "userLocationInfoTime": "2019-08-24T14:15:22Z",
  • "ranNasRelCauses": [
    ],
  • "accuUsageReports": [
    ],
  • "pduSessRelCause": "PS_TO_CS_HO"
}

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}