API docs by Redocly

Unified Data Repository Service API file for policy data (-)

Download OpenAPI specification:

The API version is defined in 3GPP TS 29.504
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.519 V18.7.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, Application Data and Structured Data for Exposure.

PolicyDataForIndividualUe (Document)

Retrieve the policy data for a subscriber

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Array of strings or strings (PolicyDataSubset) >= 2 items

List of policy data subset names

Responses

Response samples

Content type
application/json
{
  • "uePolicyDataSet": {
    },
  • "smPolicyDataSet": {
    },
  • "amPolicyDataSet": {
    },
  • "umData": {
    },
  • "operatorSpecificDataSet": {
    },
  • "suppFeat": "string"
}

AccessAndMobilityPolicyData (Document)

Retrieves the access and mobility policy data for a subscriber

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "praInfos": {
    },
  • "subscCats": [
    ],
  • "chfInfo": {
    },
  • "subscSpendingLimits": true,
  • "spendLimInfo": {
    },
  • "restriStatus": [
    ],
  • "suppFeat": "string"
}

Modify the access and mobility policy data for a subscriber.

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

Request Body schema: application/merge-patch+json
required
Array of objects (RestrictedStatus) non-empty

List of restricted status that contains the reason for the status and the time stamp of when the status was stored.

object non-empty

Contains the status of the requested policy counters for UE. The key of the map is the attribute policyCounterId.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "restriStatus": [
    ],
  • "spendLimInfo": {
    }
}

Response samples

Content type
application/json
{
  • "praInfos": {
    },
  • "subscCats": [
    ],
  • "chfInfo": {
    },
  • "subscSpendingLimits": true,
  • "spendLimInfo": {
    },
  • "restriStatus": [
    ],
  • "suppFeat": "string"
}

UEPolicySet (Document)

Retrieves the UE policy set data for a subscriber

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "praInfos": {
    },
  • "subscCats": [
    ],
  • "uePolicySections": {
    },
  • "upsis": [
    ],
  • "allowedRouteSelDescs": {
    },
  • "andspInd": true,
  • "epsUrspInd": true,
  • "vpsUrspInd": true,
  • "urspEnfInd": true,
  • "pei": "string",
  • "osIds": [
    ],
  • "chfInfo": {
    },
  • "subscSpendingLimits": true,
  • "spendLimInfo": {
    },
  • "tracingReq": {
    },
  • "resetIds": [
    ],
  • "restriStatus": [
    ],
  • "suppFeat": "string"
}

Create or modify the UE policy set data for a subscriber

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

Request Body schema: application/json
required
object non-empty

Contains Presence reporting area information. The praId attribute within the PresenceInfo data type is the key of the map.

subscCats
Array of strings non-empty
object non-empty

Contains the UE Policy Sections. The UE Policy Section Identifier is used as the key of the map.

upsis
Array of strings <byte> (Bytes) non-empty [ items <byte > ]
object non-empty

Contains allowed route selection descriptors per serving PLMN for a UE. The serving PLMN identifier is the key of the map.

andspInd
boolean
epsUrspInd
boolean

Indication of UE supporting URSP provisioning in EPS.

vpsUrspInd
boolean

Indication of UE supporting VPLMN-specific URSP.

urspEnfInd
boolean

Indication of UE supporting URSP enforcement report.

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.

osIds
Array of strings <uuid> (OsId) non-empty [ items <uuid > ]
object (ChargingInformation)

Contains the addresses of the charging functions.

subscSpendingLimits
boolean

Indicates whether the PCF must enforce UE policies based on subscriber spending limits.

object non-empty

Contains the status of the requested policy counters for UE. The key of the map is the attribute policyCounterId.

object or null (TraceData)

contains Trace control and configuration parameters.

resetIds
Array of strings non-empty
Array of objects (RestrictedStatus) non-empty
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.

Responses

Request samples

Content type
application/json
{
  • "praInfos": {
    },
  • "subscCats": [
    ],
  • "uePolicySections": {
    },
  • "upsis": [
    ],
  • "allowedRouteSelDescs": {
    },
  • "andspInd": true,
  • "epsUrspInd": true,
  • "vpsUrspInd": true,
  • "urspEnfInd": true,
  • "pei": "string",
  • "osIds": [
    ],
  • "chfInfo": {
    },
  • "subscSpendingLimits": true,
  • "spendLimInfo": {
    },
  • "tracingReq": {
    },
  • "resetIds": [
    ],
  • "restriStatus": [
    ],
  • "suppFeat": "string"
}

Response samples

Content type
application/json
{
  • "praInfos": {
    },
  • "subscCats": [
    ],
  • "uePolicySections": {
    },
  • "upsis": [
    ],
  • "allowedRouteSelDescs": {
    },
  • "andspInd": true,
  • "epsUrspInd": true,
  • "vpsUrspInd": true,
  • "urspEnfInd": true,
  • "pei": "string",
  • "osIds": [
    ],
  • "chfInfo": {
    },
  • "subscSpendingLimits": true,
  • "spendLimInfo": {
    },
  • "tracingReq": {
    },
  • "resetIds": [
    ],
  • "restriStatus": [
    ],
  • "suppFeat": "string"
}

Modify the UE policy set data for a subscriber

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

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

Contains the UE Policy Sections. The UE Policy Section Identifier is used as the key of the map.

upsis
Array of strings <byte> (Bytes) non-empty [ items <byte > ]
andspInd
boolean
epsUrspInd
boolean

Indication of UE supporting URSP provisioning in EPS.

vpsUrspInd
boolean

Indication of UE supporting VPLMN-specific URSP.

urspEnfInd
boolean

Indication of UE supporting URSP enforcement report.

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.

osIds
Array of strings <uuid> (OsId) non-empty [ items <uuid > ]
Array of objects (RestrictedStatus) non-empty
object or null non-empty

Contains the updated status of the requested policy counters for UE. The key of the map is the attribute policyCounterId.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "uePolicySections": {
    },
  • "upsis": [
    ],
  • "andspInd": true,
  • "epsUrspInd": true,
  • "vpsUrspInd": true,
  • "urspEnfInd": true,
  • "pei": "string",
  • "osIds": [
    ],
  • "restriStatus": [
    ],
  • "spendLimInfo": {
    }
}

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

SessionManagementPolicyData (Document)

Retrieves the session management policy data for a subscriber

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

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

Array of objects (PduSessionInfo) >= 2 items
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").

fields
Array of strings non-empty

attributes to be retrieved

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

Supported Features

Responses

Response samples

Content type
application/json
{
  • "smPolicySnssaiData": {
    },
  • "umDataLimits": {
    },
  • "umData": {
    },
  • "suppFeat": "string"
}

Modify the session management policy data for a subscriber

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

Request Body schema: application/merge-patch+json
required
object or null non-empty

Contains the remaining allowed usage data associated with the subscriber. The value of the limit identifier is used as the key of the map.

object non-empty

Modifiable Session Management Policy data per S-NSSAI for all the SNSSAIs of the subscriber. The key of the map is the S-NSSAI.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "umData": {
    },
  • "smPolicySnssaiData": {
    }
}

Response samples

Content type
application/json
{
  • "smPolicySnssaiData": {
    },
  • "umDataLimits": {
    },
  • "umData": {
    },
  • "suppFeat": "string"
}

UsageMonitoringInformation (Document)

Retrieve a usage monitoring resource

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

usageMonId
required
string
query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "limitId": "string",
  • "scopes": {
    },
  • "umLevel": "SESSION_LEVEL",
  • "allowedUsage": {
    },
  • "resetTime": "2019-08-24T14:15:22Z",
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Create a usage monitoring resource

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

usageMonId
required
string
Request Body schema: application/json
required
limitId
required
string
object non-empty

Identifies the SNSSAI and DNN combinations for remain allowed usage data for a subscriber. The S-NSSAI is the key of the map.

string or string (UsageMonLevel)

Represents the usage monitoring level.

object (UsageThreshold)

Represents a usage threshold.

resetTime
string <date-time> (DateTime)

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

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.

resetIds
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "limitId": "string",
  • "scopes": {
    },
  • "umLevel": "SESSION_LEVEL",
  • "allowedUsage": {
    },
  • "resetTime": "2019-08-24T14:15:22Z",
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Response samples

Content type
application/json
{
  • "limitId": "string",
  • "scopes": {
    },
  • "umLevel": "SESSION_LEVEL",
  • "allowedUsage": {
    },
  • "resetTime": "2019-08-24T14:15:22Z",
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Delete a usage monitoring resource

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

usageMonId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

SponsorConnectivityData (Document)

Retrieves the sponsored connectivity information for a given sponsorId

Authorizations:
NoneNoneNoneNone
path Parameters
sponsorId
required
string
query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "aspIds": [
    ],
  • "suppFeat": "string"
}

BdtData (Store)

Retrieves the BDT data collection

Authorizations:
NoneNoneNoneNone
query Parameters
bdt-ref-ids
Array of strings (BdtReferenceId) non-empty

List of the BDT reference identifiers.

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

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

IndividualBdtData (Document)

Retrieves the BDT data information associated with a BDT reference Id

Authorizations:
NoneNoneNoneNone
path Parameters
bdtReferenceId
required
string
query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "aspId": "string",
  • "transPolicy": {
    },
  • "bdtRefId": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "volPerUe": {
    },
  • "dnn": "string",
  • "snssai": {
    },
  • "trafficDes": "string",
  • "bdtpStatus": "INVALID",
  • "warnNotifEnabled": true,
  • "notifUri": "string",
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Creates an BDT data resource associated with an BDT reference Id

Authorizations:
NoneNoneNoneNone
path Parameters
bdtReferenceId
required
string
Request Body schema: application/json
required
aspId
required
string
required
object (TransferPolicy)

Describes a transfer policy.

bdtRefId
string (BdtReferenceId)

string identifying a BDT Reference ID as defined in clause 5.3.3 of 3GPP TS 29.154.

object (NetworkAreaInfo)

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

numOfUes
integer (Uinteger) >= 0

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

object (UsageThreshold)

Represents a usage threshold.

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

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

trafficDes
string (TrafficDescriptor)

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

string or string (BdtPolicyStatus)

Indicates the validation status of a negotiated BDT policy.

warnNotifEnabled
boolean

Indicates whether the BDT warning notification is enabled (true) or not (false). Default value is false.

notifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

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.

resetIds
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "aspId": "string",
  • "transPolicy": {
    },
  • "bdtRefId": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "volPerUe": {
    },
  • "dnn": "string",
  • "snssai": {
    },
  • "trafficDes": "string",
  • "bdtpStatus": "INVALID",
  • "warnNotifEnabled": true,
  • "notifUri": "string",
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Response samples

Content type
application/json
{
  • "aspId": "string",
  • "transPolicy": {
    },
  • "bdtRefId": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "volPerUe": {
    },
  • "dnn": "string",
  • "snssai": {
    },
  • "trafficDes": "string",
  • "bdtpStatus": "INVALID",
  • "warnNotifEnabled": true,
  • "notifUri": "string",
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Modifies an BDT data resource associated with an BDT reference Id

Authorizations:
NoneNoneNoneNone
path Parameters
bdtReferenceId
required
string
Request Body schema: application/merge-patch+json
required
object (TransferPolicy)

Describes a transfer policy.

string or string (BdtPolicyStatus)

Indicates the validation status of a negotiated BDT policy.

warnNotifEnabled
boolean

Indicates whether the BDT warning notification is enabled (true) or not (false).

Responses

Request samples

Content type
application/merge-patch+json
{
  • "transPolicy": {
    },
  • "bdtpStatus": "INVALID",
  • "warnNotifEnabled": true
}

Response samples

Content type
application/json
{
  • "aspId": "string",
  • "transPolicy": {
    },
  • "bdtRefId": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "volPerUe": {
    },
  • "dnn": "string",
  • "snssai": {
    },
  • "trafficDes": "string",
  • "bdtpStatus": "INVALID",
  • "warnNotifEnabled": true,
  • "notifUri": "string",
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Deletes an BDT data resource associated with an BDT reference Id

Authorizations:
NoneNoneNoneNone
path Parameters
bdtReferenceId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

PolicyDataSubscriptions (Collection)

Retrieves the list of Individual Policy Data Subscription resources

Authorizations:
NoneNoneNoneNone
query Parameters
mon-resources
Array of strings non-empty

List of monitored resources whose subscriptions are requested.

ue-id
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

Represents the Subscription Identifier SUPI or GPSI.

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

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a subscription to receive notification of policy data changes

Authorizations:
NoneNoneNoneNone
Request Body schema: application/json
required
notificationUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

notifId
string
monitoredResourceUris
required
Array of strings (Uri)
Array of objects (ResourceItem) non-empty
Array of objects (ResourceItem) non-empty
immRep
boolean

If provided and set to true, it indicates that existing entries that match this subscription shall be immediately reported in the response.

Array of objects (PolicyDataChangeNotification) non-empty

Immediate report with existing UDR entries.

expiry
string <date-time> (DateTime)

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

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

resetIds
Array of strings non-empty
subsId
string

Responses

Callbacks

Request samples

Content type
application/json
{
  • "notificationUri": "string",
  • "notifId": "string",
  • "monitoredResourceUris": [
    ],
  • "monResItems": [
    ],
  • "excludedResItems": [
    ],
  • "immRep": true,
  • "immReports": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "subsId": "string"
}

Response samples

Content type
application/json
{
  • "notificationUri": "string",
  • "notifId": "string",
  • "monitoredResourceUris": [
    ],
  • "monResItems": [
    ],
  • "excludedResItems": [
    ],
  • "immRep": true,
  • "immReports": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "subsId": "string"
}

Callback payload samples

Callback
POST: {$request.body#/notificationUri}
Content type
application/json
[
  • {
    }
]

IndividualPolicySubscriptionData (Document)

Retrieves Individual Policy Subscription data

Authorizations:
NoneNoneNoneNone
path Parameters
subsId
required
string

Responses

Response samples

Content type
application/json
{
  • "notificationUri": "string",
  • "notifId": "string",
  • "monitoredResourceUris": [
    ],
  • "monResItems": [
    ],
  • "excludedResItems": [
    ],
  • "immRep": true,
  • "immReports": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "subsId": "string"
}

IndividualPolicyDataSubscription (Document)

Modify a subscription to receive notification of policy data changes

Authorizations:
NoneNoneNoneNone
path Parameters
subsId
required
string
Request Body schema: application/json
required
notificationUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

notifId
string
monitoredResourceUris
required
Array of strings (Uri)
Array of objects (ResourceItem) non-empty
Array of objects (ResourceItem) non-empty
immRep
boolean

If provided and set to true, it indicates that existing entries that match this subscription shall be immediately reported in the response.

Array of objects (PolicyDataChangeNotification) non-empty

Immediate report with existing UDR entries.

expiry
string <date-time> (DateTime)

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

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

resetIds
Array of strings non-empty
subsId
string

Responses

Request samples

Content type
application/json
{
  • "notificationUri": "string",
  • "notifId": "string",
  • "monitoredResourceUris": [
    ],
  • "monResItems": [
    ],
  • "excludedResItems": [
    ],
  • "immRep": true,
  • "immReports": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "subsId": "string"
}

Response samples

Content type
application/json
{
  • "notificationUri": "string",
  • "notifId": "string",
  • "monitoredResourceUris": [
    ],
  • "monResItems": [
    ],
  • "excludedResItems": [
    ],
  • "immRep": true,
  • "immReports": [
    ],
  • "expiry": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "resetIds": [
    ],
  • "subsId": "string"
}

Delete the individual Policy Data subscription

path Parameters
subsId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

OperatorSpecificData (Document)

Retrieve the operator specific policy data of an UE

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE Id

query Parameters
fields
Array of strings non-empty

attributes to be retrieved

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

Supported Features

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Modify the operator specific policy data of a UE

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE Id

Request Body schema: application/json-patch+json
required
Array
required
string or string (PatchOperation)

Operations as defined in IETF RFC 6902.

path
required
string

contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource on which the patch operation shall be performed.

from
string

indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.

value
any

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "report": [
    ]
}

Create or modify the operator specific policy data of a UE

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

UE Id

Request Body schema: application/json
required
additional property
object (OperatorSpecificDataContainer)

Container for operator specific data.

Responses

Request samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

When the feature OSDResource_Create_Delete is supported, delete OperatorSpecificData resource

Authorizations:
NoneNoneNoneNone
path Parameters
ueId
required
string (VarUeId) ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|...

String represents the SUPI or GPSI

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

PlmnUePolicySet (Document)

Retrieve the UE policy set data for an H-PLMN

Authorizations:
NoneNoneNoneNone
path Parameters
plmnId
required
string (VarPlmnId) ^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$

PLMN Id (MCC, MNC) or SNPN Id (MCC, MNC, NID).

query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "praInfos": {
    },
  • "subscCats": [
    ],
  • "uePolicySections": {
    },
  • "upsis": [
    ],
  • "allowedRouteSelDescs": {
    },
  • "andspInd": true,
  • "epsUrspInd": true,
  • "vpsUrspInd": true,
  • "urspEnfInd": true,
  • "pei": "string",
  • "osIds": [
    ],
  • "chfInfo": {
    },
  • "subscSpendingLimits": true,
  • "spendLimInfo": {
    },
  • "tracingReq": {
    },
  • "resetIds": [
    ],
  • "restriStatus": [
    ],
  • "suppFeat": "string"
}

SlicePolicyControlData (Document)

Retrieves a network Slice specific policy control data resource

Authorizations:
NoneNoneNoneNone
path 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".

query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "mbrUl": "string",
  • "mbrDl": "string",
  • "remainMbrUl": "string",
  • "remainMbrDl": "string",
  • "suppFeat": "string"
}

Modify a network Slice specific policy control data resource

Authorizations:
NoneNoneNoneNone
path 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".

Request Body schema: application/merge-patch+json
required
One of
remainMbrUl
required
string (BitRate) ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

String representing a bit rate; the prefixes follow the standard symbols from The International System of Units, and represent x1000 multipliers, with the exception that prefix "K" is used to represent the standard symbol "k".

remainMbrDl
string (BitRate) ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

String representing a bit rate; the prefixes follow the standard symbols from The International System of Units, and represent x1000 multipliers, with the exception that prefix "K" is used to represent the standard symbol "k".

Responses

Request samples

Content type
application/merge-patch+json
{
  • "remainMbrUl": "string",
  • "remainMbrDl": "string"
}

Response samples

Content type
application/json
{
  • "mbrUl": "string",
  • "mbrDl": "string",
  • "remainMbrUl": "string",
  • "remainMbrDl": "string",
  • "suppFeat": "string"
}

MBSSessionPolicyControlData (Document)

Retrieve MBS Session Policy Control Data for an MBS Session.

Authorizations:
NoneNoneNoneNone
path Parameters
required
object or object (MbsSessPolDataId)

Represents the identifier of the MBS Session Policy Control Data.

Responses

Response samples

Content type
application/json
{
  • "5qis": [
    ],
  • "maxMbsArpLevel": 1,
  • "maxMbsSessionAmbr": "string",
  • "maxGbr": "string",
  • "suppFeat": "string"
}

PdtqData (Store)

Retrieves the PDTQ data collection

Authorizations:
NoneNoneNoneNone
query Parameters
pdtq-ref-ids
Array of strings (PdtqReferenceId) non-empty

List of the PDTQ reference identifiers.

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

Supported Features

Responses

Response samples

Content type
application/json
[
  • {
    }
]

IndividualPdtqData (Document)

Retrieves the PDTQ data information associated with a PDTQ reference Id

Authorizations:
NoneNoneNoneNone
path Parameters
pdtqReferenceId
required
string
query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Supported Features

Responses

Response samples

Content type
application/json
{
  • "aspId": "string",
  • "pdtqPolicy": {
    },
  • "appId": "string",
  • "pdtqRefId": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "desTimeInts": [
    ],
  • "dnn": "string",
  • "snssai": {
    },
  • "altQosParamSets": [
    ],
  • "altQosRefs": [
    ],
  • "qosParamSet": {
    },
  • "qosReference": "string",
  • "notifUri": "string",
  • "warnNotifEnabled": true,
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Creates a PDTQ data resource associated with a PDTQ reference Id

Authorizations:
NoneNoneNoneNone
path Parameters
pdtqReferenceId
required
string
Request Body schema: application/json
required
One of
aspId
required
string
required
object (PdtqPolicy)

Describes a PDTQ policy.

appId
string (ApplicationId)

String providing an application identifier.

pdtqRefId
string (PdtqReferenceId)

Represents a PDTQ Reference ID.

object (NetworkAreaInfo)

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

numOfUes
integer (Uinteger) >= 0

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

Array of objects (TimeWindow) non-empty

Identifies the time interval(s).

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

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

Array of objects (AltQosParamSet) non-empty

Contains the alternative QoS requirements as a list of individual QoS parameter sets in a prioritized order.

altQosRefs
Array of strings non-empty

Contains the alternative QoS requirements as the list of QoS references in a prioritized order.

required
object (QosParameterSet)

Contains the QoS requirements expressed as one or more individual QoS parameters.

qosReference
string

Requested QoS requirements expressed as the QoS Reference which represents a pre-defined QoS information.

notifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

warnNotifEnabled
boolean

Indicates whether the PDTQ warning notification is enabled (true) or not (false). Default value is false.

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.

resetIds
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "aspId": "string",
  • "pdtqPolicy": {
    },
  • "appId": "string",
  • "pdtqRefId": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "desTimeInts": [
    ],
  • "dnn": "string",
  • "snssai": {
    },
  • "altQosParamSets": [
    ],
  • "altQosRefs": [
    ],
  • "qosParamSet": {
    },
  • "qosReference": "string",
  • "notifUri": "string",
  • "warnNotifEnabled": true,
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Response samples

Content type
application/json
{
  • "aspId": "string",
  • "pdtqPolicy": {
    },
  • "appId": "string",
  • "pdtqRefId": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "desTimeInts": [
    ],
  • "dnn": "string",
  • "snssai": {
    },
  • "altQosParamSets": [
    ],
  • "altQosRefs": [
    ],
  • "qosParamSet": {
    },
  • "qosReference": "string",
  • "notifUri": "string",
  • "warnNotifEnabled": true,
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Modifies a PDTQ data resource associated with a PDTQ reference Id

Authorizations:
NoneNoneNoneNone
path Parameters
pdtqReferenceId
required
string
Request Body schema: application/merge-patch+json
required
object (PdtqPolicy)

Describes a PDTQ policy.

warnNotifEnabled
boolean

Indicates whether the PDTQ warning notification is enabled (true) or not (false).

notifUri
string (Uri)

String providing an URI formatted according to RFC 3986.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "pdtqPolicy": {
    },
  • "warnNotifEnabled": true,
  • "notifUri": "string"
}

Response samples

Content type
application/json
{
  • "aspId": "string",
  • "pdtqPolicy": {
    },
  • "appId": "string",
  • "pdtqRefId": "string",
  • "nwAreaInfo": {
    },
  • "numOfUes": 0,
  • "desTimeInts": [
    ],
  • "dnn": "string",
  • "snssai": {
    },
  • "altQosParamSets": [
    ],
  • "altQosRefs": [
    ],
  • "qosParamSet": {
    },
  • "qosReference": "string",
  • "notifUri": "string",
  • "warnNotifEnabled": true,
  • "suppFeat": "string",
  • "resetIds": [
    ]
}

Deletes a PDTQ data resource associated with a PDTQ reference Id

Authorizations:
NoneNoneNoneNone
path Parameters
pdtqReferenceId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string",
  • "accessTokenError": {
    },
  • "accessTokenRequest": {
    },
  • "nrfId": "string",
  • "supportedApiVersions": [
    ],
  • "noProfileMatchInfo": {
    }
}

GroupPolicyControlData (Document)

Retrieves group specific policy control data.

Authorizations:
NoneNoneNoneNone
path Parameters
intGroupId
required
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

Represents the identifier of the internal group of subscriber(s).

query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Represents the supported features.

Responses

Response samples

Content type
application/json
{
  • "maxGroupMbrUl": "string",
  • "maxGroupMbrDl": "string",
  • "remainGroupMbrUl": "string",
  • "remainGroupMbrDl": "string",
  • "suppFeat": "string"
}

Modify existing group specific policy control data.

Authorizations:
NoneNoneNoneNone
path Parameters
intGroupId
required
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

Represents the identifier of the internal group of subscriber(s).

Request Body schema: application/merge-patch+json
required
Any of
maxGroupMbrUl
required
string (BitRate) ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

String representing a bit rate; the prefixes follow the standard symbols from The International System of Units, and represent x1000 multipliers, with the exception that prefix "K" is used to represent the standard symbol "k".

maxGroupMbrDl
string (BitRate) ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

String representing a bit rate; the prefixes follow the standard symbols from The International System of Units, and represent x1000 multipliers, with the exception that prefix "K" is used to represent the standard symbol "k".

remainGroupMbrUl
string (BitRate) ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

String representing a bit rate; the prefixes follow the standard symbols from The International System of Units, and represent x1000 multipliers, with the exception that prefix "K" is used to represent the standard symbol "k".

remainGroupMbrDl
string (BitRate) ^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$

String representing a bit rate; the prefixes follow the standard symbols from The International System of Units, and represent x1000 multipliers, with the exception that prefix "K" is used to represent the standard symbol "k".

Responses

Request samples

Content type
application/merge-patch+json
{
  • "maxGroupMbrUl": "string",
  • "maxGroupMbrDl": "string",
  • "remainGroupMbrUl": "string",
  • "remainGroupMbrDl": "string"
}

Response samples

Content type
application/json
{
  • "maxGroupMbrUl": "string",
  • "maxGroupMbrDl": "string",
  • "remainGroupMbrUl": "string",
  • "remainGroupMbrDl": "string",
  • "suppFeat": "string"
}