GeographicArea

3GPP TS 29.572 [42]

Identifies the geographical information of the user(s).

CivicAddress

3GPP TS 29.572 [42]

Identifies the civic address information of the user(s).

NetworkAreaInfo

3GPP TS 29.554 [50]

Identifies a network area information.

SupportedFeatures

3GPP TS 29.571 [45]

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

Bdt

5.4.2.1.2

Represents a Background Data Transfer subscription.

BdtPatch

5.4.2.1.3

Represents a Background Data Transfer subscription modification request.

ExNotification

5.4.2.1.4

Represents a Background Data Transfer notification.

TrafficDescriptor

5.4.2.3.2

Identify a traffic descriptor as defined in Figure 5.2.2 of 3GPP TS 24.526 [64].

TransferPolicy

5.4.2.2.2

Represents an offered transfer policy sent from the SCEF to the SCS/AS, or a selected transfer policy sent from the SCS/AS to the SCEF.

self

Link

0..1

Link to the resource "Individual BDT Subscription". This parameter shall be supplied by the SCEF in HTTP responses.

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.

volumePerUE

UsageThreshold

1

Identifies the data volume expected to be transferred per UE.

numberOfUEs

integer

1

Identifies the number of UEs.

desiredTimeWindow

TimeWindow

1

Identifies the time interval.

locationArea

LocationArea

0..1

Identifies the area within which the SCS/AS requests the number of UE.

Bdt

locationArea5G

LocationArea5G

0..1

Identifies the area within which the AF requests the number of UE.

LocBdt_5G

referenceId

BdtReferenceId

0..1

Identifies a selected policy of background data transfer.

transferPolicies

array(TransferPolicy)

0..N

Identifies an offered transfer policy.

selectedPolicy

integer

0..1

Identity of the selected background data transfer policy. Shall not be present in initial message exchange, can be provided by NF service consumer in a subsequent message exchange.

externalGroupId

ExternalGroupId

0..1

Identifies a group of users. (NOTE 2)

Group_Id

notificationDestination

Link

0..1

Contains the URI to receive the BDT notification from the NEF.

BdtNotification_5G

warnNotifEnabled

boolean

0..1

Indicates whether the BDT warning notification is enabled or not.

If it is set to true, the BDT warning notification is enabled; if it is set to false or absent, the BDT warning notification is disabled.

BdtNotification_5G

trafficDes

TrafficDescriptor

0..1

Contains the traffic descriptor of the background data. (NOTE 2)

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

NOTE 2: The attribute is only applicable to the NEF.

selectedPolicy

integer

1

Identity of the selected background data transfer policy.

warnNotifEnabled

boolean

0..1

Indicates whether the BDT warning notification is enabled.

– true: the BDT warning notification is enabled;

– false: the BDT warning notification is not enabled.

BdtNotification_5G

notificationDestination

Link

0..1

Contains the URI to receive the BDT notification from the NEF.

enNB

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

bdtRefId

BdtReferenceId

1

This IE indicates transfer policies of background data transfer which the notification corresponds to.

locationArea5G

LocationArea5G

0..1

This IE represents a network area where a network performance will go below the criteria set by the operator.

timeWindow

TimeWindow

0..1

This IE indicates a time window when a network performance will go below the criteria set by the operator.

candPolicies

array(TransferPolicy)

0..N

This IE indicates a list of the candidate transfer policies from which the AF may select a new transfer policy due to network performance degradation.

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

bdtPolicyId

integer

1

Identifier for the transfer policy

maxUplinkBandwidth

Bandwidth

0..1

Indicates the maximum aggregated bitrate in the uplink authorized by the PCRF.

maxDownlinkBandwidth

Bandwidth

0..1

Indicates the maximum aggregated bitrate in the downlink authorized by the PCRF.

ratingGroup

integer

1

Indicates the rating group during the time window.

timeWindow

TimeWindow

1

Indicates the recommended time window of the transfer policy

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

TrafficDescriptor

String identifying a traffic descriptor as defined in table 5.2.1 of 3GPP TS 24.526 [64].

BDT Subscription

/{scsAsId}/subscriptions

GET

Read all active background data transfer subscription resources for a given SCS/AS

POST

Create a new background data transfer subscription resource

Individual BDT Subscription

/{scsAsId}/subscriptions/{subscriptionId}

PATCH

Modify a background data transfer subscription resource to select one of the transfer policies offered by the SCEF

PUT

Update a background data transfer subscription resource for negotiation of background data transfer policy

GET

Read a background data transfer subscription resource

DELETE

Delete a background data transfer resources

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

none specified

none

Response body

Data type

Cardinality

Response

codes

Remarks

array(Bdt)

0..N

200 OK

The resource information for the SCS/AS in the request URI are 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.

none specified

Bdt

1

Parameters to register a subscription to request background data transfer related information with the SCEF.

Response body

Data type

Cardinality

Response

codes

Remarks

Bdt

1

201 Created

The resource 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-bdt/v1/{scsAsId}/subscriptions/{subscriptionId}

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

subscriptionId

string

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

none specified

none

Response body

Data type

Cardinality

Response

codes

Remarks

Bdt

1

200 OK

The resource 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.

Bdt

1

The SCS/AS requests to update the BDT policy subscription.

Response body

Data type

Cardinality

Response

codes

Remarks

Bdt

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 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.

BdtPatch

1

Background data transfer policy selected by the SCS/AS.

Response body

Data type

Cardinality

Response

codes

Remarks

Bdt

1

200 OK

The resource was modified successfully.

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

none

204 No Content

The resource 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 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.

none specified

none

Response body

Data type

Cardinality

Response

codes

Remarks

none

204 No Content

The resource was terminated successfully.

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 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.

BDT Warning Notification

{notificationDestination}

POST

Notify the BDT warning from the NEF to the AF identified by the notification destination URI (NOTE)

NOTE: This notification may only be supported in 5G.

notificationDestination

Link

Reference provided by the AF when the AF requests to send a BDT warning notification when the network performance in the area of interest goes below the criteria set by the operator.

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

ExNotification

1

Representation of the BDT warning notification.

none

204 No Content

This case represents a successful notification of BDT warning notification.

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

Bdt

The feature supports the pre-5G (e.g. 4G) requirement.

2

LocBdt_5G

The feature supports the 5G requirement. This feature may only be supported in 5G.

3

Group_Id

The feature supports forwarding an external group identifier of the user. This feature shall not be supported in pre-5G.

4

BdtNotification_5G

The feature supports the sending of BDT notification. This feature includes sending of the BDT warning notification to the AF. This feature may only be supported in 5G.

5

enNB

The feature supports enhancement of northbound interfaces, e.g. enable the SCS/AS to update notification destination during modification procedure.

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.