API docs by Redocly

Npcf_BDTPolicyControl Service API (1.3.0)

Download OpenAPI specification:

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

3GPP TS 29.554 V18.3.0; 5G System; Background Data Transfer Policy Control Service.

BDT policies (Collection)

Create a new Individual BDT policy

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required

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

aspId
required
string (AspId)

Contains an identity of an application service provider.

required
object (TimeWindow)

Represents a time window identified by a start time and a stop time.

dnn
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").

interGroupId
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003.

notifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

object (NetworkAreaInfo)

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

numOfUes
required
integer

Indicates a number of UEs.

required
object (UsageThreshold)

Represents a usage threshold.

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

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.

trafficDes
string (TrafficDescriptor)

Identify a traffic descriptor as defined in Figure 5.2.2 of 3GPP TS 24.526, octets v+5 to w.

warnNotifReq
boolean
Default: false

Indicates whether the BDT warning notification is enabled or disabled.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "aspId": "string",
  • "desTimeInt": {
    },
  • "dnn": "string",
  • "interGroupId": "string",
  • "notifUri": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "volPerUe": {
    },
  • "snssai": {
    },
  • "suppFeat": "string",
  • "trafficDes": "string",
  • "warnNotifReq": false
}

Response samples

Content type
application/json
{
  • "bdtPolData": {
    },
  • "bdtReqData": {
    }
}

Callback payload samples

Callback
POST: {$request.body#/notifUri}
Content type
application/json
{
  • "bdtRefId": "string",
  • "candPolicies": [
    ],
  • "nwAreaInfo": {
    },
  • "timeWindow": {
    }
}

Individual BDT policy (Document)

Read an Individual BDT policy

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
bdtPolicyId
required
string

String identifying the individual BDT policy resource in the PCF.

Responses

Response samples

Content type
application/json
{
  • "bdtPolData": {
    },
  • "bdtReqData": {
    }
}

Update an Individual BDT policy

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
bdtPolicyId
required
string

String identifying the individual BDT policy resource in the PCF.

Request Body schema: application/merge-patch+json
required

Contains modification instruction 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.

object (BdtPolicyDataPatch)

A JSON Merge Patch body schema containing modification instruction to be performed on the bdtPolData attribute of the BdtPolicy data structure to select a transfer policy. Adds selTransPolicyId to BdtPolicyData data structure.

object (BdtReqDataPatch)

A JSON Merge Patch body schema containing modification instruction to be performed on the bdtReqData attribute of the BdtPolicy data structure to indicate whether the BDT warning notification is enabled or disabled. Modifies warnNotifReq from BdtReqData data structure.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "bdtPolData": {
    },
  • "bdtReqData": {
    }
}

Response samples

Content type
application/json
{
  • "bdtPolData": {
    },
  • "bdtReqData": {
    }
}