BDT policies

/bdtpolicies

POST

Npcf_BDTPolicyControl_Create. Creates a new Individual BDT policy resource.

Individual BDT policy

/bdtpolicies/{bdtPolicyId}

GET

Reads an Individual BDT policy resource.

PATCH

Npcf_BDTPolicyControl_Update.

Modifies an existing Individual BDT policy resource by selecting or reselecting a transfer policy.

apiRoot

string

See clause 5.1.

n/a

BdtReqData

M

1

Contains information for the creation of a new Individual BDT policy resource.

BdtPolicy

M

1

201 Created

Successful case.

The creation of an Individual BDT policy resource is confirmed and a representation of that resource is returned.

n/a

303 See Other

The result of the HTTP POST request would be equivalent to the existing Individual BDT policy resource. The HTTP response shall contain a Location header field set to the URI of the existing individual BDT policy resource.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the POST method shall also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/npcf-bdtpolicycontrol/v1/bdtpolicies/{bdtPolicyId}.

Location

string

M

1

Contains the URI of the existing individual BDT policy resource.

apiRoot

string

See clause 5.1.

bdtPolicyId

string

Identifies the individual BDT policy resource in the PCF.

To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [7] and rules for a path segment defined in IETF RFC 3986 [16].

n/a

n/a

BdtPolicy

M

1

200 OK

A representation of an Individual BDT policy resource is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the GET method shall also apply.

NOTE 2: Failure cases are described in clause 5.7.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

n/a

PatchBdtPolicy

M

1

Contains modification instructions to be performed on the BdtPolicy data structure to select a transfer policy and in addition, may indicate whether the BDT warning notification is enabled or disabled.

BdtPolicy

M

1

200 OK

Successful case.

The Individual BDT Policy resource is modified and a representation of that resource is returned.

n/a

204 No Content

Successful case.

The Individual BDT Policy resource is modified.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative PCF (service) instance.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

(NOTE 2)

NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the PATCH method shall also apply.

NOTE 2: Failure cases are described in clause 5.7.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located in an alternative PCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected.

BDT Notification

{notifUri}

POST

Provides BDT notification.

notifUri

Uri

It contains the URI of the recipient of BDT notification as assigned by the NF service consumer during the Create service operation and described within the BdtReqData (see table 5.6.2.3-1).

n/a

Notification

M

1

Provides BDT notification.

n/a

204 No Content

Successful case.

The reception of the BDT notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [6] for the POST method shall also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected.

BdtPolicy

5.6.2.2

Represents an Individual BDT policy resource.

BdtPolicyData

5.6.2.4

Describes an Individual BDT policy resource.

BdtPolicyDataPatch

5.6.2.6

Contains modification instructions to be performed on the "bdtPolData" property of the BdtPolicy data structure to select a transfer policy.

BdtReqData

5.6.2.3

Contains information for creation a new Individual BDT policy resource.

BdtReqDataPatch

5.6.2.12

Describes the modifications to the BDT request data of an Individual BDT policy resource.

PatchCorrection

NetworkAreaInfo

5.6.2.8

Describes a network area information in which the NF service consumer requests the number of UEs.

Notification

5.6.2.10

Contains the BDT notification information.

BdtNotification_5G

PatchBdtPolicy

5.6.2.11

Describes the modifications to the BDT Policy Data and BDT Policy Request data of an Individual BDT policy resource.

PatchCorrection

TransferPolicy

5.6.2.5

Describes a transfer policy.

BdtReferenceId

3GPP TS 29.122 [14]

Identifies transfer policy of background data transfer for provided ASP.

BitRate

3GPP TS 29.571 [13]

Specifies bitrate in kbits per second.

Dnn

3GPP TS 29.571 [13]

Identifies a Data Network Name.

Ecgi

3GPP TS 29.571 [13]

Represents an EUTRA cell identifier.

GlobalRanNodeId

3GPP TS 29.571 [13]

Represents an identity of the NG-RAN node.

GroupId

3GPP TS 29.571 [13]

Identifies a group of UEs.

Ncgi

3GPP TS 29.571 [13]

Represents an NR cell identifier.

ProblemDetails

3GPP TS 29.571 [13]

Used in error responses to provide more detailed information about an error.

RedirectResponse

3GPP TS 29.571 [13]

Contains redirection related information.

ES3XX

Snssai

3GPP TS 29.571 [13]

Identifies a Single Network Slice Selection Assistance Information.

SupportedFeatures

3GPP TS 29.571 [13]

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

Tai

3GPP TS 29.571 [13]

Represents a tracking area identity.

TimeWindow

3GPP TS 29.122 [14]

Specifies a time interval.

TrafficDescriptor

3GPP TS 29.122 [14]

Represents a traffic descriptor.

Uri

3GPP TS 29.571 [13]

String providing an URI.

BdtNotification_5G

UsageThreshold

3GPP TS 29.122 [14]

Represents a data volume expected to be transferred per UE.

bdtPolData

BdtPolicyData

C

0..1

Describes the authorization data of an Individual BDT Policy created by the PCF.

It shall be present in the response to the POST request that requests a creation of an Individual BDT Policy resource and in the response to GET request.

bdtReqData

BdtReqData

C

0..1

Identifies the service requirements of an Individual BDT Policy.

It shall be present in the POST request that requests a creation of an Individual BDT Policy resource and in the response to GET request.

aspId

AspId

M

1

This IE contains an identity of an application service provider.

desTimeInt

TimeWindow

M

1

This IE indicates a desired time window for BDT.

dnn

Dnn

O

0..1

This IE identifies a DNN. A full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.

(NOTE)

interGroupId

GroupId

O

0..1

Represents an internal group identifier and identifies a group of UEs.

notifUri

Uri

O

0..1

This IE indicates that the NF service consumer requests a BDT notification from the PCF. It contains an URI of the recipient of BDT notification.

BdtNotification_5G

nwAreaInfo

NetworkAreaInfo

O

0..1

This IE represents a network area information in which the NF service consumer requests a number of UEs.

It may be present in the POST request that requests a creation of an Individual BDT Policy and in the response to GET request.

numOfUes

integer

M

1

This IE indicates a number of UEs.

snssai

Snssai

O

0..1

This IE identifies a slice.

suppFeat

SupportedFeatures

C

0..1

This IE represents a list of Supported features used as described in clause 5.8.

It shall be supplied by the NF service consumer in the POST request that request a creation of an Individual BDT Policy resource.

trafficDes

TrafficDescriptor

O

0..1

Contains the traffic descriptor of the background data.

volPerUe

UsageThreshold

M

1

This IE indicates a data volume expected to be transferred per UE.

warnNotifReq

boolean

O

0..1

This IE indicates whether the BDT warning notification is enabled or disabled.

It may be present:

– in the POST request that requests a creation of an Individual BDT Policy and in the corresponding response; and

– in responses to GET and PATCH requests.

true: enabled;

false: disabled (default).

BdtNotification_5G

NOTE: The PCF uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration.

bdtRefId

BdtReferenceId

M

1

This IE indicates transfer policies of background data transfer for provided ASP.

selTransPolicyId

integer

C

0..1

This IE contains the identity of the selected transfer policy.

It shall be present in the response to the PATCH request that modifies an Individual BDT Policy resource to indicate a selected transfer policy.

suppFeat

SupportedFeatures

C

0..1

This IE represents a list of Supported features used as described in clause 5.8.

It shall be supplied by the PCF in the response to the POST request that requests a creation of an Individual BDT Policy resource.

transfPolicies

array(TransferPolicy)

M

1..N

This IE contains transfer policies.

It shall be supplied by the PCF in the response to the POST request that requests a creation of an Individual BDT Policy resource.

maxBitRateDl

BitRate

O

0..1

This IE indicates a maximum aggregated bitrate in the downlink direction authorized by the PCF.

maxBitRateUl

BitRate

O

0..1

This IE indicates a maximum aggregated bitrate in the uplink direction authorized by the PCF.

ratingGroup

integer

M

1

This IE indicates a rating group for the recommended time window.

recTimeInt

TimeWindow

M

1

This IE indicates a recommended time window of a transfer policy.

transPolicyId

integer

M

1

This IE contains an identity of a transfer policy.

selTransPolicyId

integer

M

1

This IE contains an identity (i.e. the transPolicyId value) of a selected transfer policy.

If the BdtNotification_5G feature is supported value "0" indicates that no transfer policy is selected.

ecgis

array(Ecgi)

O

1..N

This IE contains a list of E‑UTRA cell identities.

ncgis

array(Ncgi)

O

1..N

This IE contains a list of NR cell identities.

gRanNodeIds

array(GlobalRanNodeId)

O

1..N

This IE contains a list of the NG‑RAN nodes.

The "n3IwfId" attribute within the "GlobalRanNodeId" data type shall not be supplied.

tais

array(Tai)

O

1..N

This IE contains a list of tracking area identities.

NOTE: The NetworkAreaInfo data type allows any combination of defined properties.

bdtRefId

BdtReferenceId

M

1

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

candPolicies

array(TransferPolicy)

O

1..N

This IE contains a list of the candidate transfer policies from which the AF may select a new transfer policy due to a network performance is below the criteria set by the operator.

nwAreaInfo

NetworkAreaInfo

O

0..1

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

timeWindow

TimeWindow

O

0..1

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

bdtPolData

BdtPolicyDataPatch

O

0..1

Describes the updates in BDT policy data of an Individual BDT Policy resource, e.g., describes the selected BDT policy.

bdtReqData

BdtReqDataPatch

O

0..1

Describes the updates in BDT policy request data of an Individual BDT Policy resource, e.g., describes the updates in warning notification requirements.

warnNotifReq

boolean

O

0..1

This IE indicates whether the BDT warning notification is enabled or disabled.

BdtNotification_5G

AspId

string

This IE contains an identity of an application service provider.

BDT_POLICY_NOT_FOUND

404 Not Found

The HTTP request is rejected because the specified Individual BDT policy resource does not exist. (NOTE 1)

NOTE 1: This application error is included in the responses to the GET and PATCH requests.

NOTE 2: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses.

1

BdtNotification_5G

This feature indicates the support of sending the BDT notification to the NF service consumer.

This feature includes sending of the BDT warning notification to the NF service consumer.

2

ES3XX

Extended Support for 3xx redirections.

This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [6] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [6].

3

PatchCorrection

Indicates support of the correction to the PATCH method.

When this feature is not supported, the interoperability between a NF service consumer and the PCF can only be ensured when it is not required the update of the Individual BDT policy resource.