AlternativeServiceRequirementsData

3GPP TS 29.514 [52]

Contains alternative QoS related parameters and a reference to them.

BitRate

3GPP TS 29.571 [45]

String representing a bit rate that shall be formatted as follows:

Pattern: ‘^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$’

Examples:

"125 Mbps", "0.125 Gbps", "125000 Kbps"

BitRateRm

3GPP TS 29.571 [45]

This data type is defined in the same way as the "BitRate" data type, but with the OpenAPI "nullable: true" property.

Dnn

3GPP TS 29.571 [45]

Identifies a DNN.

EthFlowDescription

3GPP TS 29.514 [52]

Defines a packet filter for an Ethernet flow.(NOTE 1)

ExtMaxDataBurstVol

3GPP TS 29.571 [45]

Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in Bytes.

Minimum = 4096. Maximum = 2000000.

ExtMaxDataBurstVolRm

3GPP TS 29.571 [45]

This data type is defined in the same way as the "ExtMaxDataBurstVol" data type, but with the OpenAPI "nullable: true" property.

IpAddr

3GPP TS 29.571 [45]

UE IP Address.

MacAddr48

3GPP TS 29.571 [45]

MAC Address.

PacketDelBudget

3GPP TS 29.571 [45]

Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501 [8])), expressed in milliseconds.

Minimum = 1.

PacketDelBudgetRm

3GPP TS 29.571 [45]

This data type is defined in the same way as the "PacketDelBudget" data type, but with the OpenAPI "nullable: true" property.

PlmnIdNid

3GPP TS 29.571 [45]

Identifies the network: the PLMN Identifier (the mobile country code and the mobile network code) or the SNPN Identifier (the PLMN Identifier and the NID).

RatType

3GPP TS 29.571 [45]

Identifies the RAT Type.

ReportingFrequency

3GPP TS 29.512 [8]

Indicates the frequency for the reporting, such as event triggered, periodic, when the PDU Session is released, and/or any combination. (NOTE 2)

RequestedQosMonitoringParameter

3GPP TS 29.512 [8]

Indicate the UL packet delay, DL packet delay or round trip packet delay between the UE and the UPF is to be monitored when the QoS Monitoring for URLLC is enabled for the service data flow. (NOTE 2)

Snssai

3GPP TS 29.571 [45]

Identifies the S-NSSAI.

SupportedFeatures

3GPP TS 29.571 [45]

Used to negotiate the applicability of the optional features defined in table 5.14.4-1.

TscaiInputContainer

3GPP TS 29.514 [52]

TSCAI Input information container.

TscPriorityLevel

3GPP TS 29.514 [52]

Represents priority of TSC Flows.

TscPriorityLevelRm

3GPP TS 29.514 [52]

Represents the same as the TscPriorityLevel data type, but with the OpenAPI "nullable: true" property.

Uinteger

3GPP TS 29.571 [45]

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

Minimum = 0.

UintegerRm

3GPP TS 29.571 [45]

This data type is defined in the same way as the "Uinteger" data type, but with the OpenAPI "nullable: true" property.

NOTE 1: In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange_5G as specified in clause 5.14.4 shall be supported.

NOTE 2: In order to support QoS Monitoring, feature QoSMonitoring_5G as specified in clause 5.14.4 shall be supported.

AsSessionWithQoSSubscription

5.14.2.1.2

Represents an individual AS session with required QoS subscription resource.

AsSessionWithQoSSubscriptionPatch

5.14.2.1.3

Represents parameters to modify an AS session with specific QoS subscription.

QosMonitoringInformation

5.14.2.1.6

Represents QoS monitoring information.

QoSMonitoring_5G

QosMonitoringInformationRm

5.14.2.1.7

Represents the same as the QosMonitoringInformation data type but with the "nullable: true" property.

QoSMonitoring_5G

QosMonitoringReport

5.14.2.1.8

Represents a QoS monitoring report.

QoSMonitoring_5G

TscQosRequirement

5.14.2.1.9

Represents QoS requirements for time sensitive communication.

TSC_5G

TscQosRequirementRm

5.14.2.1.10

Represents the same as the TscQosRequirement data type but with the "nullable: true" property.

TSC_5G

UserPlaneEvent

5.14.2.2.3

Represents the user plane event.

enNB

UserPlaneEventReport

5.14.2.1.5

Represents an event report for user plane.

enNB

UserPlaneNotificationData

5.14.2.1.4

Represents the parameters to be conveyed in a user plane event(s) notification.

enNB

self

Link

0..1

Link to the resource "Individual AS Session with Required QoS Subscription".

This parameter shall be supplied by the SCEF in HTTP responses.

dnn

Dnn

0..1

Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 3)

snssai

Snssai

0..1

Identifies an S-NSSAI. (NOTE 3)

supportedFeatures

SupportedFeatures

0..1

Used to negotiate the supported optional features of the API as described in clause 5.2.7.

This attribute shall be provided in the POST request and in the response of successful resource creation.

notificationDestination

Link

1

Contains the URL to receive the notification bearer level event(s) from the SCEF.

exterAppId

string

0..1

Identifies the external Application Identifier. (NOTE 2)

AppId

flowInfo

array(FlowInfo)

0..N

Describe the IP data flow which requires QoS.

(NOTE 2)

ethFlowInfo

array(EthFlowDescription)

0..N

Identifies Ethernet packet flows.

(NOTE 2) (NOTE 6)

EthAsSessionQoS_5G

enEthFlowInfo

array(EthFlowInfo)

0..N

Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows.

(NOTE 2) (NOTE 6)

EnEthAsSessionQoS_5G

qosReference

string

0..1

Identifies a pre-defined QoS information. (NOTE 5)

altQoSReferences

array(string)

0..N

Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 4)

AlternativeQoS_5G

altQosReqs

array(AlternativeServiceRequirementsData)

0..N

Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. (NOTE 4)

AltQosWithIndParams_5G

disUeNotif

boolean

0..1

Indicates whether to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. The fulfilled situation is either the QoS profile or an Alternative QoS Profile.

– true: the QoS flow parameters signalling to the UE is disabled;

– false (default): the QoS flow parameters signalling to the UE is not disabled.

DisableUENotification_5G

ueIpv4Addr

Ipv4Addr

0..1

The Ipv4 address of the UE.

(NOTE 2)

ipDomain

string

0..1

The IPv4 address domain identifier.

The attribute may only be provided if the ueIpv4Addr attribute is present.

ueIpv6Addr

Ipv6Addr

0..1

The Ipv6 address of the UE.

(NOTE 2)

macAddr

MacAddr48

0..1

Identifies the MAC address.

(NOTE 2)

EthAsSessionQoS_5G

usageThreshold

UsageThreshold

0..1

Time period and/or traffic volume in which the QoS is to be applied.

sponsorInfo

SponsorInformation

0..1

Indicates a sponsor information

qosMonInfo

QosMonitoringInformation

0..1

Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed.

QoSMonitoring_5G

directNotifInd

boolean

0..1

Indicates whether the direct event notification is requested.

– true: the direct event notification is requested;

– false (default): the direct event notification is not requested.

ExposureToEAS

tscQosReq

TscQosRequirement

0..1

Contains the QoS requirements for time sensitive communication. (NOTE 5)

TSC_5G

requestTestNotification

boolean

0..1

Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

0..1

Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4.

Notification_websocket

events

array(UserPlaneEvent)

0..N

Corresponds to the list of user plane event(s) to which the SCS/AS requests to subscribe to.

enNB

NOTE 1: Properties marked with a feature as defined in clause 5.14.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

NOTE 2: One of "ueIpv4Addr", "ueIpv6Addr" or "macAddr" shall be included. If ipv4 or ipv6 address is provided, IP flow information shall be provided. If MAC address is provided and the AppId feature is not supported, Ethernet flow information (either "ethFlowInfo", or if the feature EnEthAsSessionQoS_5G is supported, "enEthFlowInfo")shall be provided. If the AppId feature is supported, one of IP flow information, Ethernet flow information (if EthAsSessionQoS_5G and/or EnEthAsSessionQoS_5G is supported) or External Application Identifier shall be provided.

NOTE 3: The property is only applicable for the NEF.

NOTE 4: The attributes "altQoSReferences" and "altQosReqs" are mutually exclusive. The attributes "qosReference" and "altQosReqs" are also mutually exclusive.

NOTE 5: The attributes "reqGbrDl", "reqGbrUl", "reqMbrDl", "reqMbrUl", "maxTscBurstSize", "req5Gsdelay", and "priority" within the "tscQosReq" attribute may be provided only if the "qosReference" attribute is not provided.

NOTE 6: When the Ethernet flow information is provided and, the EthAsSessionQoS_5G and EnEthAsSessionQoS_5G features are supported, either the "ethFlowInfo" or the "enEthFlowInfo" shall be provided, but not both simultenously.

exterAppId

string

0..1

Identifies the external Application Identifier. (NOTE 2)

AppId

flowInfo

array(FlowInfo)

0..N

Describe the data flow which requires QoS. (NOTE 2)

ethFlowInfo

array(EthFlowDescription)

0..N

Describes Ethernet packet flows. (NOTE 2)

EthAsSessionQoS_5G

enEthFlowInfo

array(EthFlowInfo)

0..N

Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows.

(NOTE 2)

EnEthAsSessionQoS_5G

qosReference

string

0..1

Pre-defined QoS reference. (NOTE 3) (NOTE 4)

altQoSReferences

array(string)

0..N

Identifiers an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 3)

AlternativeQoS_5G

altQosReqs

array(AlternativeServiceRequirementsData)

1..N

Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. (NOTE 3)

AltQosWithIndParams_5G

disUeNotif

boolean

0..1

Indicates whether to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. The fulfilled situation is either the QoS profile or an Alternative QoS Profile.

– true: the QoS flow parameters signalling to the UE is disabled;

– false: the QoS flow parameters signalling to the UE is not disabled.

DisableUENotification_5G

usageThreshold

UsageThresholdRm

0..1

Time period and/or traffic volume in which the QoS is to be applied.

qosMonInfo

QosMonitoringInformationRm

0..1

Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed.

QoSMonitoring_5G

directNotifInd

boolean

0..1

Indicates whether the direct event notification is requested.

– true: the direct event notification is requested;

– false: the direct event notification is not requested.

ExposureToEAS

tscQosReq

TscQosRequirementRm

0..1

Contains the QoS requirements for time sensitive communication. (NOTE 4)

TSC_5G

notificationDestination

Link

0..1

Contains the URL to receive the notification event(s) from the SCEF.

events

array(UserPlaneEvent)

0..N

Corresponds to the list of user plane event(s) to which the SCS/AS requests to subscribe to.

enNB

NOTE 1: Properties marked with a feature as defined in clause 5.14.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

NOTE 2: One of "exterAppId", "flowInfo" or either "ethFlowInfo" or "enEthFlowInfo" may be provided.

NOTE 3 The attributes "altQoSReferences" and "altQosReqs" are mutually exclusive. The attributes "qosReference" and "altQosReqs" are also mutually exclusive.

NOTE 4: The attributes "reqGbrDl", "reqGbrUl", "reqMbrDl", "reqMbrUl", "maxTscBurstSize", "req5Gsdelay", and "priority" within the "tscQosReq" attribute may be provided only if the "qosReference" attribute is not provided.

transaction

Link

1

Link to the transaction resource to which this notification is related.

eventReports

array(UserPlaneEventReport)

1..N

Contains the reported event and applicable information

event

UserPlaneEvent

1

Indicates the event reported by the SCEF.

accumulatedUsage

AccumulatedUsage

0..1

Contains the applicable information corresponding to the event.

flowIds

array(integer)

0..N

Identifies the affected flows that were sent during event subscription. It may be omitted when the reported event applies to all the flows sent during the subscription.

appliedQosRef

string

0..1

The currently applied QoS reference (or applied individual QoS parameter set, if AltQosWithIndParams_5G is supported). Applicable for event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION.

When it is omitted and the "event" attribute is QOS_NOT_GUARANTEED, the event report indicates that the lowest priority alternative QoS profile could not be fulfilled either.

AlternativeQoS_5G, AltQosWithIndParams_5G

plmnId

PlmnIdNid

0..1

PLMN Identifier or the SNPN Identifier.

It may be present when the reported event is "PLMN_CHG" and which is allowed to be exposured to the AF based on the local policy or local configuration.

enNB_5G

qosMonReports

array(QosMonitoringReport)

0..N

Contains the QoS Monitoring Reporting information.

QoSMonitoring_5G

ratType

RatType

0..1

RAT type may be present if applicable, when the notified event is "ACCESS_TYPE_CHANGE" and which is allowed to be exposured to the AF based on the local policy or local configuration.

enNB_5G

NOTE: Properties marked with a feature as defined in clause 5.14.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

reqQosMonParams

array(RequestedQosMonitoringParameter)

1..N

Indicates the UL packet delay, DL packet delay and/or round trip packet delay between the UE and the UPF is to be monitored when the QoS Monitoring for URLLC is enabled for the service data flow.

repFreqs

array(ReportingFrequency)

1..N

Indicates the frequency for the reporting, such as event triggered, periodic, when the PDU Session is released, and/or any combination.

repThreshDl

Uinteger

0..1

Unsigned integer identifying a threshold in units of milliseconds for DL packet delay. It shall be present when the "reqQosMonParams" attribute includes "DOWNLINK".

repThreshUl

Uinteger

0..1

Unsigned integer identifying a threshold in units of milliseconds for UL packet delay. It shall be present when the "reqQosMonParams" attribute includes "UPLINK".

repThreshRp

Uinteger

0..1

Unsigned integer identifying a threshold in units of milliseconds for round trip packet delay. It shall be present when the "reqQosMonParams" attribute includes "ROUND_TRIP".

waitTime

DurationSec

0..1

Indicates the minimum waiting time between subsequent reports. It shall be present when the "repFreqs" attribute includes "EVENT_TRIGGERED".

repPeriod

DurationSec

0..1

Indicates the time interval between successive reporting. It shall be present when the "repFreqs" attribute includes "PERIODIC".

reqQosMonParams

array(RequestedQosMonitoringParameter)

0..N

Indicates the UL packet delay, DL packet delay and/or round trip packet delay between the UE and the UPF is to be monitored when the QoS Monitoring for URLLC is enabled for the service data flow.

repFreqs

array(ReportingFrequency)

0..N

Indicates the frequency for the reporting, such as event triggered, periodic, when the PDU Session is released, and/or any combination.

repThreshDl

UintegerRm

0..1

Unsigned integer identifying a threshold in units of milliseconds for DL packet delay. It shall be present when the "reqQosMonParams" attribute includes "DOWNLINK".

repThreshUl

UintegerRm

0..1

Unsigned integer identifying a threshold in units of milliseconds for UL packet delay. It shall be present when the "reqQosMonParams" attribute includes "UPLINK".

repThreshRp

UintegerRm

0..1

Unsigned integer identifying a threshold in units of milliseconds for round trip packet delay. It shall be present when the "reqQosMonParams" attribute includes "ROUND_TRIP".

waitTime

DurationSecRm

0..1

Indicates the minimum waiting time between subsequent reports. It shall be present when the "repFreqs" attribute includes "EVENT_TRIGGERED".

repPeriod

DurationSecRm

0..1

Indicates the time interval between successive reporting. It shall be present when the "repFreqs" attribute includes "PERIODIC".

ulDelays

array(Uinteger)

0..N

Uplink packet delay in units of milliseconds. (NOTE)

dlDelays

array(Uinteger)

0..N

Downlink packet delay in units of milliseconds. (NOTE)

rtDelays

array(Uinteger)

0..N

Round trip delay in units of milliseconds. (NOTE)

NOTE: In this release of the specification the maximum number of elements in the array is 2.

reqGbrDl

BitRate

0..1

Requested GBR in downlink.

reqGbrUl

BitRate

0..1

Requested GBR in uplink.

reqMbrDl

BitRate

0..1

Requested MBR in downlink.

reqMbrUl

BitRate

0..1

Requested MBR in uplink.

maxTscBurstSize

ExtMaxDataBurstVol

0..1

Maximum burst size of the TSC traffic in units of Bytes.
Minimum = 4096, Maximum = 2000000.

req5Gsdelay

PacketDelBudget

0..1

Requested Delay of the TSC traffic.

priority

TscPriorityLevel

0..1

Unsigned integer indicating the TSC traffic priority in relation to other TSC and non-TSC traffic.

tscaiTimeDom

Uinteger

0..1

Indicates the (g)PTP domain that the (TSN)AF is located in.

tscaiInputUl

TscaiInputContainer

0..1

Transports the input parameters for TSC traffic to construct the TSC Assistance Container in uplink direction.

tscaiInputDl

TscaiInputContainer

0..1

Transports the input parameters for TSC traffic to construct the TSC Assistance Container in downlink direction.

reqGbrDl

BitRateRm

0..1

Requested GBR in downlink.

reqGbrUl

BitRateRm

0..1

Requested GBR in uplink.

reqMbrDl

BitRateRm

0..1

Requested MBR in downlink.

reqMbrUl

BitRateRm

0..1

Requested MBR in uplink.

maxTscBurstSize

ExtMaxDataBurstVolRm

0..1

Maximum burst size of the TSC traffic in units of Bytes.
Minimum = 4096, Maximum = 2000000.

req5Gsdelay

PacketDelBudgetRm

0..1

Requested Delay of the TSC traffic.

priority

TscPriorityLevelRm

0..1

Unsigned integer indicating the TSC traffic priority in relation to other TSC and non-TSC traffic.

tscaiTimeDom

UintegerRm

0..1

Indicates the (g)PTP domain that the (TSN)AF is located in.

tscaiInputUl

TscaiInputContainer

0..1

Transports the input parameters for TSC traffic to construct the TSC Assistance Container in uplink direction.

tscaiInputDl

TscaiInputContainer

0..1

Transports the input parameters for TSC traffic to construct the TSC Assistance Container in downlink direction.

SESSION_TERMINATION

Indicates that Rx session is terminated.

LOSS_OF_BEARER

Indicates a loss of a bearer.

RECOVERY_OF_BEARER

Indicates a recovery of a bearer.

RELEASE_OF_BEARER

Indicates a release of a bearer.

USAGE_REPORT

Indicates the usage report event.

FAILED_RESOURCES_ALLOCATION

Indicates the resource allocation is failed.

SUCCESSFUL_RESOURCES_ALLOCATION

Indicates the resource allocation is successful.

QOS_GUARANTEED

The QoS targets of one or more SDFs are guaranteed again.

AlternativeQoS_5G

QOS_NOT_GUARANTEED

The QoS targets of one or more SDFs are not being guaranteed.

AlternativeQoS_5G

QOS_MONITORING

Indicates a QoS monitoring event.

QoSMonitoring_5G

ACCESS_TYPE_CHANGE

Indicates an Access type change. (NOTE 2)

enNB_5G

PLMN_CHG

Indicates a PLMN change. (NOTE 2)

enNB_5G

NOTE 1: Properties marked with a feature as defined in clause 5.14.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

NOTE 2: The exposure of such network information to the AF needs to be authorized based on the local policy or local configuration.

AS Session with Required QoS Subscriptions

/{scsAsId}/subscriptions

GET

Get all or queried subscription resources for a given SCS/AS.

POST

Create a new AS session.

Individual AS Session with Required QoS Subscription

/{scsAsId}/subscriptions/{subscriptionId}

GET

Read a subscription resource for a given SCS/AS and a subscription Id.

PUT

Modify a subscription resource for a given SCS/AS and a subscription Id.

PATCH

Modify a subscription resource for a given SCS/AS and a subscription Id.

DELETE

Delete a subscription resource for a given SCS/AS and a subscription Id.

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

ip-addrs

array(IpAddr)

0..N

The IP address(es) of the requested UE(s).

enNB

ip-domain

string

0..1

The IPv4 address domain identifier.

The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter.

enNB

mac-addrs

array(MacAddr48)

0..N

The MAC address(es) of the requested UE(s).

enNB

NOTE: Either the "ip-addrs" parameter or the "mac-addrs" parameter may be provided at the same time. If multiple elements are provided in the array structure, then each element shall be treated as a separate query parameter.

none

Response body

Data type

Cardinality

Response

codes

Remarks

array(AsSessionWithQoSSubscription)

0..N

200 OK

The subscription information related to the request URI is returned.

none

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

none

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

AsSessionWithQoSSubscription

1

Parameters to create a subscription for an AS session with required QoS for the service requirement.

Response body

Data type

Cardinality

Response

codes

Remarks

AsSessionWithQoSSubscription

1

201

Created

The subscription was created successfully.

The URI of the created resource shall be returned in the "Location" HTTP header.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-as-session-with-qos/v1/{scsAsId}/subscriptions/{subscriptionId}

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS of type ScsAsId.

subscriptionId

string

Identifier of the subscription resource of type string. The subscriptionId corresponds to the stage 2 TLTRI.

none

Response body

Data type

Cardinality

Response

codes

Remarks

AsSessionWithQoSSubscription

1

200 OK

The subscription information related to the resource URI is returned.

none

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

none

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

AsSessionWithQoSSubscription

1

Set up AS session with required QoS.

Response body

Data type

Cardinality

Response

codes

Remarks

AsSessionWithQoSSubscription

1

200 OK

The subscription was modified successfully.

The SCEF shall return an updated subscription in the response payload body.

none

204 No Content

The subscription was updated successfully.

none

307 Temporary Redirect

Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

none

308 Permanent Redirect

Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

AsSessionWithQoSSubscriptionPatch

1

Partial update of an AS session with required QoS.

Response body

Data type

Cardinality

Response

codes

Remarks

AsSessionWithQoSSubscription

1

200 OK

The subscription was modified successfully.

The SCEF shall return an updated subscription in the response payload body.

none

204 No Content

The subscription was modified successfully.

none

307 Temporary Redirect

Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

none

308 Permanent Redirect

Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

none

Response body

Data type

Cardinality

Response

codes

Remarks

none

204 No Content

The subscription was terminated successfully.

The response body shall be empty.

UserPlaneNotificationData

1

200 OK

The subscription was terminated successfully. The user plane notification data shall be included in the response.

none

307 Temporary Redirect

Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

none

308 Permanent Redirect

Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Location

string

M

1

An alternative URI of the resource located in an alternative SCEF.

Event Notification

{notificationUri}

POST

Notify the bearer level event(s) from the SCEF to the SCS/AS

notificationUri

Link

Reference provided by the SCS/AS when the SCS/AS requests to sponsor the traffic from the beginning or to become the chargeable party at a later point.

This URI shall be provided within the "notificationDestination" attribute in the AsSessionWithQoSSubscription type.

UserPlaneNotificationData

1

Representation of the bearer level notification.

none

204 No Content

This case represents a successful notification of bearer level event(s).

none

307 Temporary Redirect

Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.

Redirection handling is described in clause 5.2.10.

none

308 Permanent Redirect

Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.

Redirection handling is described in clause 5.2.10.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected.

1

Notification_websocket

The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event featute is also supported.

2

Notification_test_event

The testing of notifications connections is supported according to clause 5.2.5.3.

3

EthAsSessionQoS_5G

Setting up required QoS for Ethernet UE. This feature may only be supported in 5G.

4

MacAddressRange_5G

Indicates the support of a set of MAC addresses with a specific range in the traffic filter. This feature may only be supported in 5G.

5

AlternativeQoS_5G

Indicates the support of alternative QoS requirements and the QoS notification (i.e. whether the QoS targets for SDF(s) are not guaranteed or guaranteed again). This feature may only be supported in 5G.

6

QoSMonitoring_5G

Indicates the support of QoS Monitoring. This feature may only be supported in 5G.

7

DisableUENotification_5G

Indicates the support of disabling QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. This feature may only be supported in 5G. This feature requires that the AlternativeQoS_5G feature is also supported.

8

TSC_5G

Indicates the support of Time Sensitive Communication. This feature may only be supported in 5G.

9

AppId

Indicates the support of dynamically providing the Application Identifier via the API.

10

ExposureToEAS

This feature indicates the support of direct notification in 5GC. This feature requires that the QoSMonitoring_5G feature is also supported.

11

enNB

Indicates the support of enhancements to the northbound interfaces.

12

AltQosWithIndParams_5G

This feature indicates the support of provisioning Alternative Service Requirements with individual QoS parameters. This feature requires that the AlternativeQoS_5G feature is also supported.

13

EnEthAsSessionQoS_5G

Indicates the support of required QoS for Ethernet UE, allowing to indicate separately different UL and/or DL Ethernet flows. This feature may only be supported in 5G.

14

enNB_5G

Indicates the support of enhancements to the northbound interfaces and only applicable to 5G.

Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification".

Description: A clear textual description of the feature.