PolicyDataForIndividualUe

/policy-data/ues/{ueId}

GET

Retrieve multiple policy data sets (access and mobility policy data, UE policy set data, session management policy data, usage monitoring data, operator specific policy data) for a subscriber.

AccessAndMobilityPolicyData

/policy-data/ues/{ueId}/
am-data

GET

Retrieve the access and mobility policy data for a subscriber.

UEPolicySet

/policy-data/ues/{ueId}/
ue-policy-set

GET

Retrieve the UE policy set data for a subscriber.

PUT

Create or modify the UE policy set data for a subscriber.

PATCH

Modify the UE policy set data for a subscriber.

SessionManagementPolicyData

/policy-data/ues/{ueId}/
sm-data

GET

Retrieve the session management policy data for a subscriber.

PATCH

When the feature "SessionManagementPolicyDataPatch" is supported, modify the session management policy data for a subscriber.

UsageMonitoringInformation

/policy-data/ues/{ueId}/
sm-data/{usageMonId}

GET

Retrieve a usage monitoring resource.

PUT

Create a usage monitoring resource.

DELETE

Delete a usage monitoring resource.

OperatorSpecificData

/policy-data/ues/{ueId}/
operator-specific-data

GET

Retrieve the operator specific policy data of a UE

PATCH

Modify the operator specific policy data of a UE.

PUT

Create or modify the operator specific policy data of a UE.

DELETE

Delete the operator specific policy data for a UE.

SponsorConnectivityData

/policy-data/sponsor-connectivity-data/{sponsorId}

GET

Retrieve the sponsored connectivity information for a given sponsorId.

BdtData

/policy-data/bdt-data

GET

Retrieve the BDT data collection.

IndividualBdtData

/policy-data/bdt-data/
{bdtReferenceId}

GET

Retrieve the BDT data information associated with a BDT reference Id.

PUT

Create a BDT data resource associated with a BDT reference Id.

PATCH

Modifies an BDT data resource associated with an BDT reference Id.

DELETE

Delete a BDT data resource associated with a BDT reference Id.

PolicyDataSubscriptions

/policy-data/subs-to-notify

POST

Create a subscription to receive notifications of policy data changes.

IndividualPolicyDataSubscription

/policy-data/subs-to-notify/
{subsId}

PUT

Modify a subscription to receive notifications of policy data changes.

DELETE

Delete a subscription identified by {subsId}.

PlmnUePolicySet

/policy-data/plmns/{plmnId}/
ue-policy-set

GET

Retrieve the UE policy set data for an H-PLMN.

SlicePolicyControlData

/policy-data/slice-control-data/{snssai}

GET

Retrieve network slice specific policy control data for a given S-NSSAI.

PATCH

Modify network slice specific policy control data for a given S-NSSAI.

MBSSessionPolicyControlData

/policy-data/mbs-session-pol-data/{polSessionId}

GET

Retrieve MBS Session Policy Control Data for an MBS Session based on the MBS Session Identifier or an AF Application Identifier.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7].

n/a

n/a

AmPolicyData

M

1

200 OK

Upon success, a response body containing access and mobility policies shall be returned.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7].

n/a

UePolicySet

M

1

Create or modify the UE policy set resource for a given subscriber.

UePolicySet

M

1

201 Created

Successful case.

The resource has been successfully created and a response body containing a representation of the created UEPolicySet resource shall be returned.

UePolicySet

M

1

200 OK

Successful case.

The resource has been successfully updated and a response body containing UE policies shall be returned.

n/a

204 No Content

Successful case.

The resource has been successfully updated and no additional content is to be sent in the response message.

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/policy-data/ues/{ueId}/ue-policy-set

n/a

UePolicySetPatch

M

1

Modify the UE policy set resource for a given subscriber.

n/a

204 No Content

Successful case.

The resource has been successfully updated and no additional content is to be sent in the response message.

NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

n/a

UePolicySet

M

1

200 OK

Upon success, a response body containing the UE policies shall be returned.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7].

snssai

Snssai

O

0..1

Identifies a Single Network Slice Selection Assistance Information.

dnn

Dnn

O

0..1

Identifies a Data Network Name.

fields

array(string)

C

1..N

When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved.

supp-feat

SupportedFeatures

O

0..1

Identifies the features supported by the NF service consumer.

n/a

SmPolicyData

M

1

200 OK

Upon success, a response body containing SmPolicyData shall be returned.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

SmPolicyDataPatch

M

1

When the "SessionManagementPolicyDataPatch" feature is supported, it requests the modification of the session management policy data for a subscriber.

n/a

204 No Content

Successful case.

The resource has been successfully updated and no additional content is to be sent in the response message. (NOTE 2)(NOTE 3)

SmPolicyData

M

1

200 OK

Upon success, the execution report is returned. (NOTE 2)(NOTE 3)

NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer supported the "PatchReport" feature, the UDR shall respond with SmPolicyData.

NOTE 3: When the resource is successfully updated, if the SmPolicyDataPatch in the request requires the creation, removal, or update of an entry of the "umData" attribute, the UDR shall create, remove or update the corresponding UsageMonitoringInformation resource for the indicated limit identifier.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7].

usageMonId

string

Unique identifier of the individual SM Policy usage monitoring resource. It contains the identity of the corresponding limit as defined in the "limitId" attribute of the UsageMonDataLimit data type (see clause 5.4.2.6).

n/a

UsageMonData

M

1

Create the usage monitoring resource.

UsageMonData

M

1

201 Created

Successful case.

The resource has been successfully created and a response body is returned containing a representation of the resource. (NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: When the resource is successfully created, the UDR shall create a new entry within the "umData" attribute of the SessionManagementPolicyData resource for the corresponding "limitId" accordingly.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/policy-data/ues/{ueId}/sm-data/{usageMonId}

n/a

n/a

n/a

204 No Content

Successful case.

The resource has been successfully deleted.

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: When the resource is successfully deleted, the UDR shall delete within the "umData" attribute of the SessionManagementPolicyData resource the corresponding "limitId" entry accordingly.

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

n/a

UsageMonData

M

1

200 OK

Successful case.

The usage monitoring data is returned.

n/a

204 No Content

The resource was found but no usage monitoring data is available.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

sponsorId

string

Represents the sponsor identity.

n/a

n/a

SponsorConnectivityData

M

1

200 OK

Upon success, a response body containing Sponsor Connectivity Data shall be returned.

n/a

204 No Content

The resource was found but no Sponsor Connectivity Data is available.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

bdt-ref-ids

array(BdtReferenceId)

O

1..N

If included, this IE shall contain a list of the BDT reference identifiers.

Each member of the array is an individual BDT reference identifier.

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

n/a

array(BdtData)

M

0..N

200 OK

Upon success, a response body containing the BDT data shall be returned.

Each member of the array is an individual BDT data.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

bdtReferenceId

BdtReferenceId

Represents the transfer policy of background data transfer for provided ASP. Data type BdtReferenceId is defined in 3GPP TS 29.122 [9].

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

n/a

BdtData

M

1

200 OK

Upon success, a response body containing the BDT data shall be returned.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

n/a

BdtData

M

1

Create the BDT data for a given bdtReferenceId.

BdtData

M

1

201 Created

Successful case.

The resource has been successfully created.

ProblemDetails

O

0..1

403 Forbidden

The resource is not allowed to be updated.

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION_NOT_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4].

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/policy-data/bdt-data/{bdtReferenceId}

n/a

n/a

n/a

204 No Content

Successful case.

The resource has been successfully deleted.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

n/a

BdtDataPatch

M

1

Modify the BDT data for a given bdtReferenceId.

BdtData

M

1

200 OK

The resource has been successfully updated and a response body containing BDT data shall be returned.

n/a

204 No Content

Successful case.

The resource has been successfully updated and no additional content is to be sent in the response message.

NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

n/a

PolicyDataSubscription

M

1

Identifies the subscription to notification of policy data modification.

PolicyDataSubscription

M

1

201 Created

Upon success, a response body containing a representation of each Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/policy-data/subs-to-notify/{subsId}

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

subsId

string

The subsId identifies an individual policy data subscription to notifications. The value is allocated by the UDR during creation of the PolicyDataSubscriptions resource.

n/a

PolicyDataSubscription

M

1

Updates the subscription to notification of policy data modification.

PolicyDataSubscription

M

1

200 OK

The individual subscription resource was updated successfully.

n/a

204 No Content

The individual subscription resource was updated successfully and no additional content is to be sent in the response message. This response code may not be provided if the "ImmediateReportPcc" feature is supported and the UDR needs to include an immediate report in the response.

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

n/a

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7].

fields

array(string)

C

1..N

When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved.

supp-feat

SupportedFeatures

O

0..1

Identifies the features supported by the NF service consumer.

n/a

map(OperatorSpecificDataContainer)

M

0..N

200 OK

Upon success, a response body containing a map shall be returned. The key of the map is an operator specific data element name and the value is the operator specific data of such data element, for the current UE (identified by the {ueId} variable in the resource path).

If the resource does not contain any keys, the response consists of an empty JSON object (empty map).

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

n/a

array(PatchItem)

M

1..N

Contains the delta data to the operator specific data

n/a

204 No Content

Upon successful modification there is no body in the response message.(NOTE 2)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

The resource is not allowed to be updated.

(NOTE 3)

NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer supported the "PatchReport" feature, the UDR shall respond with PatchResult.

NOTE 3: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION_NOT_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4].

n/a

map(OperatorSpecificDataContainer)

M

1..N

A map containing the new representation of the operator specific data. The key of the map is operator specific data element name and the value is the operator specific data of the UE.

map(OperatorSpecificDataContainer)

M

1

200 OK

Upon successful modification a response body containing a map shall be returned. The key of the map is operator specific data element name and the value is the operator specific data of the UE.

map(OperatorSpecificDataContainer)

M

1

201 Created

If the "OSDResource_Create_Delete" feature is supported and the resource has been successfully created, a response body is returned. The key of the map is operator specific data element name and the value is the operator specific data of the UE.

n/a

204 No Content

The resource has been successfully updated.

ProblemDetails

O

0..1

403 Forbidden

The resource is not allowed to be updated.

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION_NOT_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4].

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudr-dr/<apiVersion>/policy-data/ ues/{ueId}/operator-specific-data.

n/a

n/a

n/a

204 No Content

Successful case, applicable when the "OSDResource_Create_Delete" feature is supported.

The resource has been successfully deleted.

NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

plmnId

string

Concatenating a Mcc and Mnc as defined in 3GPP TS 29.505 [15].

n/a

n/a

UePolicySet

M

1

200 OK

Upon success, a response body containing the UE policies shall be returned.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1

ueId

VarUeId

Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7].

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer, as per clause 6.6 of 3GPP TS 29.500 [4].

data-subset-names

array(PolicyDataSubset)

O

2..N

The policy data subsets (e.g. AM policies, SM policies, etc.) requested by the NF service consumer.

If this query parameter is not provided by the NF service consumer, this means that all the available policy data subsets shall be returned.

NOTE: When two or more policy data subsets sets shall be retrieved, it is recommended to use a single GET request with query parameters.

n/a

PolicyDataForIndividualUE

M

1

200 OK

Upon success, a response body containing the policy data subsets requested by the NF service consumer or all the policy data subsets shall be returned.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

snssai

Snssai

The S-NSSAI value used in the last segment of the resource URI is encoded as a string as defined in 3GPP TS 29.571 [7], clause 5.4.4.2.

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

n/a

SlicePolicyData

M

1

200 OK

Upon success, a response body containing network slice specific policy control data shall be returned.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

SlicePolicyDataPatch

M

1

Modify a network slice specific policy control data resource for a given S-NSSAI.

SlicePolicyData

M

1

200 OK

The resource has been successfully updated and a response body containing network slice specific policy control data shall be returned.

n/a

204 No Content

The resource has been successfully updated and no additional content is to be sent in the response message.

NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

polSessionId

MbsSessPolDataId

Represents the identifier of the MBS Session Policy Control Data.

n/a

n/a

MbsSessPolCtrlData

M

1

200 OK

Successful case. The requested MBS Session Policy Control Data is successfully returned.

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Policy Data Change Notification

{notificationUri}

POST

Used for policy data change notification

n/a

array(PolicyDataChangeNotification)

M

1..N

Notification of policy data changes.

n/a

204 No Content

The reception of the notification is acknowledged.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

AmPolicyData

5.4.2.2

Contains the AM policy data for a given subscriber.

BdtData

5.4.2.9

Contains the background data transfer data.

BdtDataPatch

5.4.2.27

Contains the modifiable background data transfer data

BdtPolicyStatus

5.4.3.5

Contains the validation status for a negotiated BDT policy.

DnnRouteSelectionDescriptor

5.4.2.20

Contains the route selector parameters per DNN.

UpdatedItem

5.4.2.26

An updated resource fragment, represented by its location in a resource and its data type.

ConditionalSubscriptionwithPartialNotification

LimitIdToMonitoringKey

5.4.2.16

Contains the limit identifier and the corresponding monitoring key for a given S-NSSAI and DNN.

MbsSessPolCtrlData

5.4.2.31

Contains MBS Session Policy Control Data.

MbsSessPolDataId

5.4.2.32

Represents the identifier used to access the MBS Session Policy Control Data.

NotificationItem

5.4.2.25

Contains the list of resource fragments included in the notification triggered by the modification of a given resource fragment.

ConditionalSubscriptionwithPartialNotification

OsId

5.4.3.2

Operating System supported by the UE.

Periodicity

5.4.3.4

Indicates a type of time period.

PlmnRouteSelectionDescriptor

5.4.2.18

Contains the route selectors for a serving PLMN.

PolicyDataChangeNotification

5.4.2.11

Contains changed policy data for which notification was requested.

PolicyDataForIndividualUe

5.4.2.28

Contains policy data sets for a given subscriber.

PolicyDataSubscription

5.4.2.10

Identifies a subscription to policy data change notification.

PolicyDataSubset

5.4.3.6

Indicates a policy data subset (e.g. AM policy data, SM policy data).

SlicePolicyData

5.4.2.29

Contains network slice specific policy control information for an S-NSSAI.

SlicePolicyDataPatch

5.4.2.30

Contains modifiable network slice specific policy control information for an S-NSSAI.

SmPolicyData

5.4.2.5

Contains SM policy data for a subscriber.

SmPolicyDataPatch

5.4.2.21

Contains modifiable SM policy data for a subscriber.

SessionManagementPolicyDataPatch

SmPolicyDnnData

5.4.2.15

Contains SM policy data for a DNN and S-NSSAI.

SmPolicyDnnDataPatch

5.4.2.23

Contains modifiable SM policy data for a DNN and S-NSSAI.

SessionManagementPolicyDataPatch

SmPolicySnssaiData

5.4.2.14

Contains SM policy data for an S-NSSAI.

SmPolicySnssaiDataPatch

5.4.2.22

Contains modifiable SM policy data for an S-NSSAI.

SessionManagementPolicyDataPatch

SnssaiRouteSelectionDescriptor

5.4.2.19

Contains the route selector parameters per SNSSAI.

SponsorConnectivityData

5.4.2.8

Contains the sponsored data connectivity related information for a sponsor identifier.

ResourceItem

5.4.2.24

Represents list of fragments of a resource, i.e. a list of subsets of resource data monitored for notification of data changes.

ConditionalSubscriptionwithPartialNotification

ItemPath

5.4.3.2

Represents a fragment of a resource, i.e. a subset of resource data.

ConditionalSubscriptionwithPartialNotification

TimePeriod

5.4.2.12

Contains the periodicity for the defined usage monitoring data limits.

UePolicySetPatch

5.4.2.17

Contains the UE policy data that can be modified by the PCF.

UePolicySection

5.4.2.3

Contains the UE policy section.

UePolicySet

5.4.2.4

Contains the UE policy set for a given subscriber.

UsageMonLevel

5.4.3.3

Indicates the level of the usage monitoring instance (PDU Session level or per Service)

UsageMonData

5.4.2.7

Contains remain allowed usage data for a subscriber.

UsageMonDataLimit

5.4.2.6

Contains usage monitoring control data for a subscriber.

UsageMonDataScope

5.4.2.13

Contains SNSSAI and DNN combinations to which the UsageMonData instance belongs to.

5Qi

3GPP TS 29.571 [7]

Indicates the 5G QoS Identifier.

ArpPriorityLevel

3GPP TS 29.571 [7]

Indicates the allocation and retention priority level.

BdtReferenceId

3GPP TS 29.122 [9]

Indicates the background data transfer reference ID for the transfer policy.

BdtReferenceIdRm

3GPP TS 29.122 [9]

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

EnhancedBackgroundDataTransfer

BitRate

3GPP TS 29.571 [7]

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

Bytes

3GPP TS 29.571 [7]

String with format "byte" as defined in OpenAPI Specification [3], i.e., base64-encoded characters.

ChargingInformation

3GPP TS 29.512 [12]

The address(es), and if available, the instance ID and the set ID of the Charging Function.

DateTime

3GPP TS 29.571 [7]

String with format "date-time" as defined in OpenAPI Specification [3].

Dnn

3GPP TS 29.571 [7]

Data Network Name. (NOTE)

MbsSessionId

3GPP TS 29.571 [7]

Contains the MBS Session Identifier.

NetworkAreaInfo

3GPP TS 29.554 [13]

Represents a network area information.

OperatorSpecificDataContainer

3GPP TS 29.505 [15]

Container for operator specific data

PatchResult

3GPP TS 29.571 [7]

PatchItem

3GPP TS 29.571 [7]

Data structure used for JSON patch.

PduSessionType

3GPP TS 29.571 [7]

PDU Session Type.

Pei

3GPP TS 29.571 [7]

Personal Equipment Identifier.

PlmnId

3GPP TS 29.571 [7]

PLMN Identity.

PresenceInfo

3GPP TS 29.571 [7]

Presence Reporting Area Information.

ProblemDetails

3GPP TS 29.571 [7]

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

SliceMbr

3GPP TS 29.571 [7]

Contains the slice Maximum Bit Rate including UL and DL.

NSAC

Snssai

3GPP TS 29.571 [7]

Identifies the S-NSSAI.

SscMode

3GPP TS 29.571 [7]

SSC mode.

SupportedFeatures

3GPP TS 29.571 [7]

Used to negotiate the applicability of the optional features

TrafficDescriptor

3GPP TS 29.122 [9]

Identifies the traffic descriptor of the background data.

TransferPolicy

3GPP TS 29.554 [13]

Represents a transfer policy.

Uinteger

3GPP TS 29.571 [7]

Unsigned Integer, i.e. only value 0 and integers greater than 0 are allowed.

Uri

3GPP TS 29.571 [7]

String providing an URI.

UsageThreshold

3GPP TS 29.122 [9]

Usage Thresholds (a data volume expected to be transferred per UE and/or time duration in seconds).

VarUeId

3GPP TS 29.571 [7]

String represents the SUPI or GPSI.

NOTE: The UDR 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.

praInfos

map(PresenceInfo)

O

1..N

Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "praId" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.

A "praId" may indicate a Presence Reporting Area Set.

The "praId" attribute within the PresenceInfo data type shall also be the key of the map.

The attribute "presenceState" shall not be present.

subscCats

array(string)

O

1..N

List of categories associated with the subscriber

uePolicySectionInfo

Bytes

M

1

Contains the UE Policy Section Information for the given UPSI as specified in clause D.6.2 of 3GPP TS 24.501 [11].

upsi

string

M

1

Identifier for UE Policy Section. The format is represented in 3GPP TS 24.501 [11] clause D.6.2.

praInfos

map(PresenceInfo)

O

1..N

Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "praId" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.

A "praId" may indicate a Presence Reporting Area Set.

The "praId" attribute within the PresenceInfo data type shall also be the key of the map.

The attribute "presenceState" shall not be present.

subscCats

array(string)

O

1..N

List of categories associated with the subscriber

uePolicySections

map(UePolicySection)

O

1..N

Contains the UE Policy Sections.

The UPSI (UE Policy Section Identifier) is used as the key in the map.

upsis

array(string)

O

1..N

List of identifiers for the "uePolicySections". The format of the UPSI is represented in 3GPP TS 24.501 [11] clause D.6.2

allowedRouteSelDescs

map(PlmnRouteSelectionDescriptor)

O

1..N

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

andspInd

boolean

O

0..1

Indication of UE supporting ANDSP.

True: The UE supports ANDSP;

False: The UE does not support ANDSP.

pei

Pei

O

0..1

Personal Equipment Identifier.

osIds

array(OsId)

O

1..N

Identification of the UE Operating System(s).

suppFeat

SupportedFeatures

C

0..1

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

This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE).

resetIds

array(string)

O

1..N

This IE uniquely identifies a part of temporary data in UDR that contains the created resource.

This attribute may be provided in the response of successful resource creation.

NOTE: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR.

smPolicySnssaiData

map(SmPolicySnssaiData)

M

1..N

Session Management Policy data per S-NSSAI for all the SNSSAIs of the subscriber.

The key of the map is the S-NSSAI. (NOTE 2)

umDataLimits

map(UsageMonDataLimit)

O

1..N

Contains a list of usage monitoring profiles associated with the subscriber. The limit identifier is used as the key of the map.

umData

map(UsageMonData)

O

1..N

Contains the remaining allowed usage data associated with the subscriber.

The limit identifier is used as the key in the map.

suppFeat

SupportedFeatures

C

0..1

Indicates the list of negotiated supported features.

This parameter shall be supplied by the UDR in the response to the GET request when the GET request includes the "supp-feat" query parameter and the UDR supports feature negotiation for Session Management Policy Data.

resetIds

array(string)

O

1..N

This IE uniquely identifies a part of temporary data in UDR that contains the created resource.

This attribute may be provided in the response of successful resource creation.

NOTE 1: In this Release of the specification the "limitId" corresponds to the Monitoring Key.

NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2.

limitId

string

M

1

Identifies the limit, i.e. the usage monitoring control instance

scopes

map(UsageMonDataScope)

O

1..N

Identifies the SNSSAI and DNN combinations to which the usage monitoring data limit applies.

The S-NSSAI is the key of the map. (NOTE 2)

If the "scopes" attribute is omitted, the limit applies to every S-NSSAI and DNN.

umLevel

UsageMonLevel

O

0..1

Indicates the level of the usage monitoring instance (PDU Session level or per Service).

startDate

DateTime

C

0..1

Start date and time when the usage monitoring instance applies. It shall be provided when the resetPeriod attribute is provided.

endDate

DateTime

O

0..1

End date and time when the usage monitoring instance applies.

usageLimit

UsageThreshold

O

0..1

Maximum allowed traffic volume/time usage for a usage monitoring instance. If a resetPeriod is specified, this limit applies to every period separately and not for the entire time between the start and end dates. So for example, if the resetPeriod is daily, the usageLimit is applicable for each day until the end date is specified.

resetPeriod

TimePeriod

O

0..1

Time period to reset the remaining allowed usage for a periodic usage monitoring instance (postpaid subscriptions). This attribute along with the startDate determine the actual absolute time at which usage needs to be reset.

NOTE 1: In this Release of the specification the "limitId" attribute is the Monitoring Key, and the "scopes" attribute shall always be present including one distinct SNSSAI and DNN pair.

NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2.

limitId

string

M

1

Identifies the limit as defined in the "limitId" attribute of the UsageMonDataLimit data type (see clause 5.4.2.6).

scopes

map(UsageMonDataScope)

O

1..N

Identifies the SNSSAI and DNN combinations to which the remaining usage monitoring data applies.

The S-NSSAI is the key of the map.

(NOTE 3)

umLevel

UsageMonLevel

O

0..1

Indicates the level of the usage monitoring instance (PDU Session level or per Service).

allowedUsage

UsageThreshold

O

0..1

Remaining allowed traffic volume usage and/or resource time usage.

resetTime

DateTime

O

0..1

Time to reset the allowed usage back to the usageLimit of the corresponding UsageMonDataLimit. This is computed based on the corresponding startDate, resetPeriod and endDate of the corresponding UsageMonDataLimit. The allowedUsage is only applicable if the resetTime is in the future relative to the current time.

suppFeat

SupportedFeatures

C

0..1

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

This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE 2).

resetIds

array(string)

O

1..N

This IE uniquely identifies a part of temporary data in UDR that contains the created resource.

This attribute may be provided in the response of successful resource creation.

NOTE 1: In this Release of the specification the "limitId" attribute is the Monitoring Key, and the "scopes" attribute shall always be present including one distinct SNSSAI and DNN pair.

NOTE 2: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR.

NOTE 3: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571 [7], clause 5.4.4.2.

aspIds

array(string)

M

1..N

Identifies a list of Application Service Provider Identifiers associated with the sponsor identity.

aspId

string

M

1

This IE contains an identity of an application service provider.

transPolicy

TransferPolicy

M

1

This IE contains the transfer policy.

bdtRefId

BdtReferenceId

O

0..1

This IE indicates the background data transfer reference ID for the transfer policy.

nwAreaInfo

NetworkAreaInfo

O

0..1

This IE represents a network area information.

numOfUes

Uinteger

O

0..1

This IE contains the number of UEs using the indicated transfer policy. It shall be present when available.

volPerUe

UsageThreshold

O

0..1

This IE contains a data volume expected to be transferred per UE for the indicated transfer policy. It shall be present when available.

dnn

Dnn

O

0..1

This IE identifies a DNN.

snssai

Snssai

O

0..1

This IE identifies a slice.

trafficDes

TrafficDescriptor

O

0..1

Contains the traffic descriptor of the background data.

bdtpStatus

BdtPolicyStatus

O

0..1

Contains the validation status for a negotiated BDT policy. It shall be included when available. Default value is "VALID" if omitted.

suppFeat

SupportedFeatures

C

0..1

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

This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE).

resetIds

array(string)

O

1..N

This IE uniquely identifies a part of temporary data in UDR that contains the created resource.

This attribute may be provided in the response of successful resource creation.

NOTE: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the UDR.

notificationUri

Uri

M

1

URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR.

notifId

string

C

0..1

Notification Correlation ID assigned by the NF service consumer.
It shall be included when the "ConditionalSubscriptionwithPartialNotification" or the "ConditionalSubscriptionWithExcludeNotification" feature is supported.

ConditionalSubscriptionwithPartialNotification

ConditionalSubscriptionWithExcludeNotification

monitoredResourceUris

array(Uri)

M

1..N

A set of URIs that identify the resources as defined in table 5.2.2-1 for which a modification triggers a notification.

(NOTE 1)

monResItems

array(ResourceItem)

O

1..N

When present, this IE indicates the trigger of the notification is conditioned to the data change occurs in one or more of the attributes contained in a resource fragment as defined by the ResourceItem data type, and that the triggered notification shall only include the resource fragment as defined by the ResourceItem data type.

(NOTE 2)

ConditionalSubscriptionwithPartialNotification

excludedResItems

array(ResourceItem)

O

1..N

When present, this IE indicates the trigger of the notification is conditioned to the data change occurs in any attribute contained in the resource(s) identified by "monitoredResourceUris", except when the changed data is in one or more of the attributes contained in a resource fragment as defined by the ResourceItem data type.

(NOTE 2) (NOTE 3) (NOTE 4)

ConditionalSubscriptionWithExcludeNotification

immRep

boolean

O

0..1

If provided and set to "true", it indicates that existing entries that match this subscription shall be immediately reported within the "immReports" attribute in the response. The default value is false. The entries provided in the immediate report consider the "monitoredResourceUris" attribute and ignore any conditions potentially provided in the "monResItems" and "excludedResItems" attributes.

ImmediateReportPcc

immReports

array(PolicyDataChangeNotification)

O

1..N

Contains entries stored in the UDR that match this subscription.

It may be included only in the POST response body of a subscription creation or modification, and only if the request included the "immRep" attribute set to true.

ImmediateReportPcc

expiry

DateTime

C

0..1

This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.

This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.

The absence of this attribute in the subscription response means the subscription to be valid without an expiry time.

supportedFeatures

SupportedFeatures

C

0..1

Used to negotiate the applicability of the optional features.

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

resetIds

array(string)

O

1..N

This IE uniquely identifies a part of temporary data in UDR that contains the created resource.

This attribute may be provided in the response of successful resource creation.

NOTE 1: Neither the resource URI of the IndividualPolicyDataSubscription resource nor the resource URI of the PolicyDataSubscriptions resource shall be included in the "monitoredResourceUris" attribute.

NOTE 2: If both ConditionalSubscriptionwithPartialNotification and ConditionalSubscriptionWithExcludeNotification are supported, the fragments defined in "monResItems" attribute and in "excludedResItems" attribute shall refer to different resources defined in "monitoredResourceUris".

NOTE 3: When "excludedResItems" attribute is included, and a change is detected in the monitored part of a resource (i.e., in those properties not included in the "excludedResItems" attribute), the triggered notification shall include the complete resource representation.

NOTE 4: The "excludedResItems" attribute may only be used with the OperatorSpecificData resource. E.g. if the OperatorSpecificData resource contains a map with two elements, one with key "operatorSpecificData1" and the other one with key "operatorSpecificData2", to excude the notification of changes in the "operatorSpecificData1" element the "excludedResItems" attribute will contain the value "/operatorSpecificData1" within the "items" array.

amPolicyData

AmPolicyData

O

0..1

Access and Mobility Policy Data, if changed and notification was requested, or if it existed and immediate reporting was requested.

uePolicySet

UePolicySet

O

0..1

UE Policy Set, if changed and notification was requested, or if it existed and immediate reporting was requested.

plmnUePolicySet

UePolicySet

O

0..1

PLMN UE Policy Set, if changed and notification was requested, or if it existed and immediate reporting was requested.

smPolicyData

SmPolicyData

O

0..1

Session Management Policy Data, if changed and notification was requested, or if it existed and immediate reporting was requested.

usageMonData

UsageMonData

O

0..1

Usage Monitoring Data, if changed and notification was requested, or if it existed and immediate reporting was requested.

sponsorConnectivityData

SponsorConnectivityData

O

0..1

Sponsor data connectivity profile information, if changed and notification was requested, or if it existed and immediate reporting was requested.

bdtData

BdtData

O

0..1

Background Data Transfer Data, if changed and notification was requested, or if it existed and immediate reporting was requested.

opSpecData

OperatorSpecificDataContainer

O

0..1

Operator Specific Data, if changed and notification was requested, or if it existed and immediate reporting was requested. It may only be used when the receiver of the notification is able to univocally identify the changed operator specific data.

(NOTE 3)

opSpecDataMap

map(OperatorSpecificDataContainer)

O

1..N

Operator Specific Data resource data, if changed and notification was requested, or if it existed and immediate reporting was requested.

The key of the map is operator specific data element name and the value is the operator specific data of the UE.

OpSpecDataMapNotification

ueId

VarUeId

C

0..1

Represents the UE subscription identifier SUPI or GPSI. It shall only be present when the "amPolicyData", "uePolicySet", "smPolicyData", "opSpecData" and/or "usageMonData" attribute is present.

sponsorId

string

C

0..1

Represents the sponsor identity. It shall only be present when the "sponsorConnectivityData" attribute is present.

bdtRefId

BdtReferenceId

C

0..1

Represents the BDT reference identifier. It shall only be present when the "bdtData" attribute is present.

usageMonId

string

C

0..1

Represents the unique identifier of the individual SM Policy usage monitoring resource. It shall only be present when the "usageMonData" attribute is present.

plmnId

PlmnId

C

0..1

Represents the PLMN identifier. It shall only be present when the "plmnUePolicySet" attribute is present.

delResources

array(Uri)

O

1..N

The resources, as defined in table 5.2.2-1, if removed from UDR and notification on resource data change was requested. Not applicable for immediate reports. (NOTE 2)

ResourceRemovalNotificationPolicyData

notifId

string

C

0..1

Notification Correlation ID assigned by the NF service consumer.
It shall be included in notifications when the "ConditionalSubscriptionwithPartialNotification" feature is supported. Not applicable for immediate reports.

ConditionalSubscriptionwithPartialNotification

reportedFragments

array(NotificationItem)

O

1..N

This attribute contains the resource fragments indicated in the "monResItems" attribute of the PolicyDataSubscription data type. Not applicable for immediate reports.

ConditionalSubscriptionwithPartialNotification

slicePolicyData

SlicePolicyData

O

0..1

Network slice specific policy control data for an S-NSSAI, if changed and notification was requested, or if it existed and immediate reporting was requested.

snssai

Snssai

C

0..1

Represents the S-NSSAI identifier, the unique identifier of the SlicePolicyControlData resource. It shall only be present when the "slicePolicyData" attribute is present.

NOTE 1: When the "ResourceRemovalNotificationPolicyData" feature and/or "ConditionalSubscriptionwithPartialNotification" feature is not supported or supported but the applicable attribute(s) are not provided, at least one of the "amPolicyData", "uePolicySet", "smPolicyData", "usageMonData", "sponsorConnectivityData", "bdtData", "opSpecData", "plmnUePolicySet" or "slicePolicyData" shall be present.

NOTE 2: When the "ResourceRemovalNotificationPolicyData" feature is supported, and the "delResources" attribute is present, the attributes that correspond with the values included in the "delResources" attribute shall be omitted. E.g., when the "delResources" attribute includes the value "../policy-data/ues/{ueId}/am-data" the attribute "amPolicyData" shall be omitted.

NOTE 3: This attribute should not be used if the receiver of the notification is not able to univocally identify the changed operator specific data, and "opSpecDataMap" should be used instead.

period

Periodicity

M

1

Indicates whether the periodicity is "YEARLY", "MONTHLY", "WEEKLY", "DAILY" or "HOURLY".

maxNumPeriod

Uinteger

O

0..1

Indicates the maximum number of periods after which the usage monitoring instance does not apply. If omitted, there is no limit in the number of periods.

snssai

Snssai

M

1

Represents the SNSSAI.

dnn

array(Dnn)

O

1..N

Represents the Dnn. If omitted, the usage monitoring scope applies to all the DNNs.

NOTE: In this Release of the specification the "dnn" attribute shall always be present with one and only one entry.

snssai

Snssai

M

1

S-NSSAI associated with the data.

smPolicyDnnData

map(SmPolicyDnnData)

O

1..N

Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. The key of the map is the DNN.

ueSliceMbr

SliceMbr

O

0..1

Subscribed UE-Slice-MBR for the indicated S-NSSAI.

NSAC

dnn

Dnn

M

1

DNN associated with the data

allowedServices

array(string)

O

1..N

List of subscriber’s allowed service identifiers

subscCats

array(string)

O

1..N

List of categories associated with the subscriber

gbrUI

BitRate

O

0..1

Maximum aggregate UL bitrate that can be provided across all GBR QoS Flows in the DNN

gbrDl

BitRate

O

0..1

Maximum aggregate DL bitrate that can be provided across all GBR QoS Flows in the DNN

adcSupport

boolean

O

0..1

Indicates whether application detection and control is enabled for the PDU session.

True: Application detection and control is enabled for the PDU session;
False: Application detection and control is not enabled for the PDU session.

The absence of this attribute means that ADC support is not provisioned for the UE and PDU session.

subscSpendingLimits

boolean

O

0..1

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

True: Spending limit control is enabled;
False: Spending limit control is not enabled.

The absence of this attribute means that spending limit control is not provisioned for the UE and PDU session.

ipv4Index

IpIndex

O

0..1

Information that identifies which IP pool or external server is used to allocate the IPv4 address.

ipv6Index

IpIndex

O

0..1

Information that identifies which IP pool or external server is used to allocate the IPv6 address.

offline

boolean

O

0..1

Indicates whether the offline charging is applicable to the PDU session.

True: Offline charging is applicable to the PDU session;
False: Offline charging is not applicable to the PDU session.

The absence of this attribute means that the charging method is not provisioned for the UE and PDU session.

online

boolean

O

0..1

Indicates whether the online charging is applicable to the PDU session.

True: Online charging is applicable to the PDU session;

False: Online charging is not applicable to the PDU session.

The absence of this attribute means that the charging method is not provisioned for the UE and PDU session.

chfInfo

ChargingInformation

O

0..1

The address(es) and, if available, the CHF instance ID and the CHF set ID of the Charging Function. (NOTE)

refUmdLimitIds

map(LimitIdToMonitoringKey)

O

1..N

A reference to the "UsageMonitoringDataLimit" or "UsageMonitoringData" instances for this DNN and SNSSAI that may also include the related monitoring key(s). The key of the map is the limit identifier.

mpsPriority

boolean

O

0..1

True: Indicates subscription to the MPS priority service; priority applies to all traffic on the PDU Session.

False: MPS priority service is not subscribed.

The absence of this attribute means that MPS priority is not provisioned for the UE and PDU session.

mcsPriority

boolean

O

0..1

True: Indicates subscription to the MCS priority service; priority applies to all traffic on the PDU Session.

False: IMS signalling priority service is not subscribed.

The absence of this attribute means that IMS signalling priority is not provisioned for the UE and PDU session.

imsSignallingPrio

boolean

O

0..1

True: Indicates subscription to the IMS signalling priority service; priority only applies to IMS signalling traffic.

False: IMS signalling priority service is not subscribed.

The absence of this attribute means that IMS signalling priority is not provisioned for the UE and PDU session.

mpsPriorityLevel

integer

O

0..1

Relative priority level for the multimedia priority services

mcsPriorityLevel

integer

O

0..1

Relative priority level for the mission critical services

praInfos

map(PresenceInfo)

O

1..N

Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "praId" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.

A "praId" may indicate a Presence Reporting Area Set.

The "praId" attribute within the PresenceInfo data type shall also be the key of the map.

The attribute "presenceState" shall not be present.

bdtRefIds

map(BdtReferenceIdRm)

O

1..N

Identifies transfer policies of background data transfer.

Any string value can be used as a key of the map.

EnhancedBackgroundDataTransfer

locRoutNotAllowed

boolean

O

0..1

Identifies whether AF influence on traffic routing is allowed or not.

True: if no local routing is allowed;

False: local routing is allowed.

The absence of this attribute means that AF influence on traffic routing is not provisioned for the UE and PDU session.

NOTE: When the feature "CHFsetSupport" is supported, the "secondaryChfAddress" may be omitted (see 3GPP TS 29.512 [12], clause 4.2.2.3.1).

limitId

string

M

1

Limit Identifier.

monKeys

array(string)

O

1..N

Monitoring Keys.

NOTE: In this Release of the specification there is only one Monitoring Key per Limit Identifier

uePolicySections

map(UePolicySection)

O

1..N

Contains the UE Policy Sections.

The UPSI (UE Policy Section Identifier) is used as the key in the map.

upsis

array(string)

O

1..N

List of identifiers for the "uePolicySections". The format of the UPSI is represented in 3GPP TS 24.501 [11] clause D.6.2.

andspInd

boolean

O

0..1

Indication of UE supporting ANDSP.

pei

Pei

O

0..1

Personal Equipment Identifier.

osIds

array(OsId)

O

1..N

Identification of the UE Operating System(s).

servingPlmn

PlmnId

M

1

Identity of the serving PLMN.

snssaiRouteSelDescs

array(SnssaiRouteSelectionDescriptor)

O

1..N

Contains the route selection descriptor parameters (DNNs, PDU session types, SSC modes and the ATSSS information) per SNSSAI.

snssai

Snssai

M

1

SNSSAI.

dnnRouteSelDescs

array(DnnRouteSelectionDescriptor)

O

1..N

Contains the route selection descriptor parameters (PDU session types, SSC modes and the ATSSS information) per DNN.

dnn

Dnn

M

1

DNN.

sscModes

array(SscMode)

O

1..N

Contains the allowed SSC modes for the traffic to this DNN.

pduSessTypes

array(PduSessionType)

O

1..N

Contains the allowed PDU Session types for the traffic to this DNN.

atsssInfo

boolean

O

0..1

Indicates whether MA PDU session establishment is allowed for this DNN.

True: MA PDU session establishment is allowed for this DNN.

False: MA PDU session establishment is not allowed for this DNN.

The absence of this attribute means that the ATSSS information is not provisioned for the UE and PDU session.

umData

map(UsageMonData)

O

1..N

Contains the remaining allowed usage data associated with the subscriber.

The value of the limit identifier is used as the key in the map.

smPolicySnssaiData

map(SmPolicySnssaiDataPatch)

O

1..N

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

The key of the map is the S-NSSAI. (NOTE 2)

NOTE 1: In this Release of the specification the "limitId" corresponds to the Monitoring Key.

NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2.

snssai

Snssai

M

1

S-NSSAI associated with the data.

smPolicyDnnData

map(SmPolicyDnnDataPatch)

O

1..N

Modifiable Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. The key of the map is the DNN.

dnn

Dnn

M

1

DNN associated with the data

bdtRefIds

map(BdtReferenceIdRm)

O

1..N

Updated transfer policies of background data transfer.

Any string value can be used as a key of the map.

EnhancedBackgroundDataTransfer

monResourceUri

Uri

M

1

Represents the URI that identifies the monitored resource as defined in table 5.2.2-1.

(NOTE)

items

array(ItemPath)

M

1..N

Represents fragments of the resource identified by the "monResource" attribute, i.e. a subset of resource data, for which a modification triggers a notification.

NOTE: The resource URI included in the "monResourceUri" attribute shall be one of the resource URIs included in the "monitoredResourceUris" attribute of the PolicyDataSubscription data type.

resourceId

Uri

M

1

This IE contains the URI of the resource which has been changed.

notifItems

array(UpdatedItem)

M

1..N

This IE contains the fragments of the resource identified by the "resourceId" attribute which have been updated or requested to be notified.

item

ItemPath

M

1

This IE contains a JSON pointer value (as defined in IETF RFC 6901 [20]) that references a target location within the resource that identifies the resource fragment.

value

Any type

M

1

This IE indicates the value of the resource fragment located at the target location within the resource specified in the "fragmentPath" attribute.

The data type of this attribute shall be the same as the type of the attribute or element located in the path.

The null value shall be allowed.

bdtpStatus

BdtPolicyStatus

O

0..1

Contains the validation status for a negotiated BDT policy. It shall be included when the BDT policy is re-negotiated.

transPolicy

TransferPolicy

O

0..1

This IE contains the transfer policy.

uePolicyDataSet

UePolicySet

O

0..1

The IE contains UE policies.

smPolicyDataSet

SmPolicyData

O

0..1

The IE contains SM policies.

amPolicyDataSet

AmPolicyData

O

0..1

The IE contains AM policies.

umData

map(UsageMonData)

C

1..N

The IE contains UM policies.

The value of the limit identifier is used as the key of the map.

(NOTE)

operatorSpecificDataSet

map(OperatorSpecificDataContainer)

O

1..N

The IE contains operator specific data.

The key of the map is operator specific data element name and the value is the operator specific data of the UE.

NOTE: The "umData" attribute shall be absent when the smPolicyDataSet attribute is present and includes the "umData" attribute.

mbrUl

BitRate

O

0..1

Maximum aggregate ULdata rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI.

(NOTE 1)

mbrDl

BitRate

O

0..1

Maximum aggregate DL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI.

(NOTE 1)

remainMbrUl

BitRate

O

0..1

The remaining maximum aggregate UL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 2)

It is set to the maximum allowed aggregate UL data rate across all GBR and Non-GBR QoS Flows in the S-NSSAI when the system is initially configured based on operator policies.

remainMbrDl

BitRate

O

0..1

The remaining maximum aggregate DL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 2)

It is set to the maximum allowed aggregate DL data rate across all GBR and Non-GBR QoS Flows in the S-NSSAI when the system is initially configured based on operator policies.

suppFeat

SupportedFeatures

C

0..1

Indicates the list of negotiated supported features.

It shall be provided in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request.

resetIds

array(string)

O

1..N

This IE uniquely identifies a part of temporary data in UDR that contains the created resource.

This attribute may be provided in the response of successful resource creation.

NOTE 1: The "mbrUl" and "mbrDl" attributes are only used for limiting data rate per network slice with assistance of the NWDAF.

NOTE 2: The "remainMbrUl" and "remainMbrDl" attributes are only used for limiting data rate per network slice with PCF based monitoring.

remainMbrUl

BitRate

O

0..1

The remaining maximum aggregate UL bitrate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI.

remainMbrDl

BitRate

O

0..1

The remaining maximum aggregate DL bitrate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI.

NOTE: At least one of the attributes shall be included.

5qis

array(5Qi)

O

1..N

Contains the list of allowed 5QI(s) for an MBS PCC rule of the MBS Session.

maxMbsArpLevel

ArpPriorityLevel

O

0..1

Contains the highest ARP level value allowed for any MBS PCC rule of the MBS Session.

maxMbsSessionAmbr

BitRate

O

0..1

Contains the maximum MBS Session-AMBR for all non-GBR QoS flows of an MBS session in the downlink.

maxGbr

BitRate

O

0..1

Contains the maximum aggregated bitrate that can be provided across all the GBR QoS Flows for an MBS session in the downlink.

suppFeat

SupportedFeatures

C

0..1

Indicates the list of negotiated supported features.

This parameter shall be provided if feature negotiation needs to take place.

mbsSessionId

MbsSessionId

C

0..1

Contains the source specific multicast address used as MBS session identifier.

(NOTE)

afAppId

string

C

0..1

Contains the AF application identifier.

(NOTE)

NOTE: Either the "mbsSessionId" attribute or the "afAppId" attribute shall be provided.

IpIndex

integer

Information that identifies which IP pool or external server is used to allocate the IP address.

ItemPath

string

It contains one JSON pointer value (as defined in IETF RFC 6901 [20]) that references a target location within the resource represented in the "monResource" attribute and "notifiedItems" attribute.

E.g. "/smPolicySnssaiData/<snssai>" represents the subscription to data changes in the SmPolicyData data document, in particular to the element of the "smPolicySnssaiData" map whose key is identified by the <snssai> value.

E.g. 2 "/smPolicySnssaiData/<snssai>/smPolicyDnnData/<dnn>" represents the subscription to data changes in the SmPolicyData data document, in particular to the element of the "smPolicySnssaiData" map whose key is identified by the <snssai> value and, within this one, to the element of the "smPolicyDnnData" map whose key is identified by the <dnn> value.

(NOTE)

ConditionalSubscriptionwithPartialNotification

OsId

string

Operating System of the served UE. It contains a Universally Unique IDentifier (UUID) as specified in IETF RFC 4122 [17]. The format of the OS Id is represented in 3GPP TS 24.501 [11].

NOTE: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2.

SESSION_LEVEL

The usage monitoring is applicable for PDU session level.

SERVICE_LEVEL

The usage monitoring is applicable for service level.

YEARLY

Time period is yearly

MONTHLY

Time period is monthly

WEEKLY

Time period is weekly

DAILY

Time period is daily

HOURLY

Time period is hourly

INVALID

This value is used to indicate that the BDT policy is invalid while the BDT policy re-negotiation is ongoing because the network performance has degraded.

VALID

This value is used to indicate that the BDT policy is valid.

AM_POLICY_DATA

AM policy data.

SM_POLICY_DATA

SM policy data.

UE_POLICY_DATA

UE policy data.

UM_DATA

Usage Monitoring data.

OPERATOR_SPECIFIC_DATA

Operator specific data.

NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated by other clauses in this document.