6.4 Data Model
29.5193GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository Service for Policy Data, Application Data and Structured Data for Exposure
6.4.1 General
This clause specifies the application data model supported by the API.
Table 6.4.1-1 specifies the data types defined for the Nudr_DataRepository Service API for Application Data service based interface protocol.
Table 6.4.1-1: Nudr_DataRepository specific Data Types for Application Data
Data type |
Section defined |
Description |
Applicability |
AmInfluData |
6.4.2.16 |
Contains AM influence data. |
DCAMP |
AmInfluDataPatch |
6.4.2.17 |
Contains AM influence data that can be updated. |
DCAMP |
ApplicationDataSubs |
6.4.2.10 |
Contains application data subscription data. |
|
ApplicationDataChangeNotif |
6.4.2.11 |
Contains the new or updated application data or removed indication. |
|
BdtPolicyData |
6.4.2.7 |
Contains applied BDT policy data. |
EnhancedBackgroundDataTransfer |
BdtPolicyDataPatch |
6.4.2.8 |
Contains modification instructions to be performed on the applied BDT policy data. |
EnhancedBackgroundDataTransfer |
DataInd |
6.4.3.3 |
Indicates the type of data. |
|
DataFilter |
6.4.2.12 |
Indicates an application data filter. |
|
IptvConfigData |
6.4.2.9 |
Represents IPTV configuration data information. |
|
PfdDataForAppExt |
6.4.2.6 |
The PFDs and related data for the application |
|
ServiceParameterData |
6.4.2.15 |
Contains the service parameter data. |
|
ServiceParameterDataPatch |
6.4.2.15A |
Contains the service parameter data that can be updated. |
|
TrafficInfluData |
6.4.2.2 |
Contains traffic influence data. |
|
TrafficInfluDataPatch |
6.4.2.3 |
Contains modification instructions to be performed on the traffic influence data. |
|
TrafficInfluDataNotif |
6.4.2.14 |
Contains traffic influence data for notification. |
EnhancedInfluDataNotification |
TrafficInfluSub |
6.4.2.4 |
Contains traffic influence subscription data. |
Table 6.4.1-2 specifies data types re-used by the Nudr_DataRepository Service API for Application Data service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudr_DataRepository Service API for Application Data service based interface.
Table 6.4.1-2: Nudr_DataRepository re-used Data Types for Application Data
Data type |
Reference |
Comments |
Applicability |
AmInfluEvent |
3GPP TS 29.522 [19] |
Identifies the type of AM related events of which the AF requests to be notified. |
|
ApplicationId |
3GPP TS 29.571 [7] |
Indicates an application identifier. |
|
BdtReferenceId |
3GPP TS 29.122 [9] |
Identifies a selected policy of background data transfer. |
EnhancedBackgroundDataTransfer |
DateTime |
3GPP TS 29.571 [7] |
Indicates a date and time. |
|
DateTimeRm |
3GPP TS 29.571 [7] |
Indicates a date and time that can be updated. |
|
DnaiChangeType |
3GPP TS 29.571 [7] |
Describes the types of DNAI change. |
|
Dnn |
3GPP TS 29.571 [7] |
Identifies a Data Network Name. (NOTE 2) |
|
DnnSnssaiInformation |
3GPP TS 29.522 [19] |
Represents a DNN, S-NSSAI combination. |
DCAMP |
DurationSec |
3GPP TS 29.571 [7] |
Represents a duration in seconds. |
DCAMP |
DurationSecRm |
3GPP TS 29.571 [7] |
Represents a removable duration in seconds. |
DCAMP |
EasDeployInfoData |
3GPP TS 29.591 [23] |
Represnts the EAS Deployment Information. |
EasDeployment |
EthFlowDescription |
3GPP TS 29.514 [16] |
Contains the Ethernet data flow information.(NOTE) |
|
Event |
3GPP TS 29.522 [19] |
Contains the outcome of the UE Policy Delivery related to the invocation of AF provisioned service parameters. |
DeliveryOutcome |
FlowInfo |
3GPP TS 29.122 [9] |
Contains the flow information. |
|
GroupId |
3GPP TS 29.571 [7] |
Identifies a group of users. |
EasDeployment |
IptvConfigDataPatch |
3GPP TS 29.522 [19] |
Contains the IPTV configuration data used for PATCH. |
|
Ipv4Addr |
3GPP TS 29.571 [7] |
Identifies an IPv4 address. |
|
Ipv6Addr |
3GPP TS 29.571 [7] |
Identifies an IPv6 address. |
|
MacAddr48 |
3GPP TS 29.571 [7] |
MAC Address. |
|
MulticastAccessControl |
3GPP TS 29.522 [19] |
Represents the multicast access control information. |
|
NetworkAreaInfo |
3GPP TS 29.554 [13] |
Describes a network area information. |
|
ParameterOverPc5 |
3GPP TS 29.522 [19] |
Contains the V2X service parameters data provisioned over PC5. |
|
ParameterOverUu |
3GPP TS 29.522 [19] |
Contains the V2X service parameters data provisioned over Uu. |
|
ParamForProSeDd |
3GPP TS 29.522 [19] |
Contains the service parameters for 5G ProSe direct discovery. |
ProSe |
ParamForProSeDc |
3GPP TS 29.522 [19] |
Contains the service parameters for 5G ProSe direct communications. |
ProSe |
ParamForProSeU2NRelUe |
3GPP TS 29.522 [19] |
Contains the service parameters for 5G ProSe UE-to-network relay UE. |
ProSe |
ParamForProSeRemUe |
3GPP TS 29.522 [19] |
Contains the service parameters for 5G ProSe remote UE. |
ProSe |
PfdChangeNotification |
3GPP TS 29.551 [8] |
Describes the PFD change. |
|
PfdContent |
3GPP TS 29.551 [8] |
Represents the content of a PFD for an application identifier. |
|
RouteToLocation |
3GPP TS 29.571 [7] |
Identifies the N6 traffic routing requirement. |
|
ServiceAreaCoverageInfo |
3GPP TS 29.534 [22] |
Contains service area coverage information. |
DCAMP |
Snssai |
3GPP TS 29.571 [7] |
Identifies a Single Network Slice Selection Assistance Information. |
|
SubscribedEvent |
3GPP TS 29.522 [19] |
Identified the type of UP path management events of which the AF requests to be notified. |
|
Supi |
3GPP TS 29.571 [7] |
Identifies a SUPI that shall contain either an IMSI or an NAI. |
|
SupportedFeatures |
3GPP TS 29.571 [7] |
Used to negotiate the applicability of the optional features. |
|
TemporalValidity |
3GPP TS 29.514 [16] |
Indicates the time interval during which the AF request is to be applied. |
MultiTemporalCondition |
Uinteger |
3GPP TS 29.571 [7] |
Unsigned Integer, i.e. only value 0 and integers greater than 0 are allowed. |
|
UintegerRm |
3GPP TS 29.571 [7] |
This data type is defined in the same way as the "Uinteger" data type, but with the OpenAPI "nullable: true" property. |
|
Uri |
3GPP TS 29.571 [7] |
Identifies a URI. |
|
UriRm |
3GPP TS 29.571 [7] |
Identifies a removable URI. |
DCAMP |
UrspRuleRequest |
3GPP TS 29.522 [19] |
Contains service parameter data used to guide the URSP. |
AfGuideURSP |
NOTE 1: In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange as specified in clause 6.1.8 of TS 29.504 [6] shall be supported. NOTE 2: 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. |
6.4.2 Structured data types
6.4.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.4.2.2 Type TrafficInfluData
Table 6.4.2.2-1: Definition of type TrafficInfluData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
upPathChgNotifCorreId |
string |
C |
0..1 |
Contains the Notification Correlation Id allocated by the NEF for the UP path change notification. It shall be included when the NEF requests the UP path change notification. |
|
appReloInd |
boolean |
O |
0..1 |
Identifies whether an application can be relocated once a location of the application has been selected. True: the application cannot be relocated; False (default): the application can be relocated. |
|
afAppId |
string |
O |
0..1 |
Identifies an application. (NOTE 1) (NOTE 3) |
|
dnn |
Dnn |
O |
0..1 |
Identifies a DNN |
|
ethTrafficFilters |
array(EthFlowDescription) |
O |
1..N |
Identifies Ethernet packet filters. (NOTE 1) (NOTE 3) |
|
snssai |
Snssai |
O |
0..1 |
The identification of slice. |
|
interGroupId |
GroupId |
O |
0..1 |
Identifies a group of users. (NOTE 2) (NOTE 3)(NOTE 5) |
|
supi |
Supi |
O |
0..1 |
Identifies a user. (NOTE 2) (NOTE 3) |
|
trafficFilters |
array(FlowInfo) |
O |
1..N |
Identifies IP packet filters. (NOTE 1) (NOTE 3) |
|
trafficRoutes |
array(RouteToLocation) |
O |
1..N |
Identifies the N6 traffic routing requirement. |
|
traffCorreInd |
boolean |
O |
0..1 |
Indication of traffic correlation. May only be included when "interGroupId" attribute is included and not set to "AnyUE". It is used to indicate that for the group of UEs, the targeted PDU sessions should be correlated by a common DNAI. Set to "true" if it should be correlated; otherwise set to "false". Default value is "false" if omitted. (NOTE 7) |
|
validStartTime |
DateTime |
O |
0..1 |
Identifies when the traffic routings start to be applicable. (NOTE 4) |
|
validEndTime |
DateTime |
O |
0..1 |
Identifies when the traffic routings are not applicable. (NOTE 4) |
|
tempValidities |
array(TemporalValidity) |
O |
1..N |
Indicates the time interval(s) during which the AF request is to be applied. (NOTE 4) |
MultiTemporalCondition |
nwAreaInfo |
NetworkAreaInfo |
O |
0..1 |
Identifies a network area information that the request applies only to the traffic of UE(s) located in this specific zone. |
|
upPathChgNotifUri |
Uri |
C |
0..1 |
Contains the URI where the NEF receives the UP path change notification. It shall be included when the NEF requests the UP path change notification. |
|
headers |
array(string) |
O |
1..N |
Headers provisioned by the NEF to be used by other NFs to interact with the NEF. E.g. 3gpp-Sbi-Binding header with the binding indication for the URI where the NEF receives UP path change notification and whose information is used by the SMF. The encoding of the header shall comply with clause 3.2 of IETF RFC 7230 [21]. (NOTE 6) |
|
subscribedEvents |
array(SubscribedEvent) |
O |
1..N |
Identifies the requirement to be notified of the event(s). |
|
dnaiChgType |
DnaiChangeType |
O |
0..1 |
Identifies a type of notification regarding UP path management event. |
|
afAckInd |
boolean |
O |
0..1 |
Identifies whether the AF acknowledgement of UP path event notification is expected. Set to "true" if the AF acknowledgement is expected; otherwise set to "false". Default value is "false" if omitted. |
URLLC |
addrPreserInd |
boolean |
O |
0..1 |
Indicates whether UE IP address should be preserved. This attribute shall set to "true" if preserved, otherwise, set to "false". Default value is false if omitted. |
URLLC |
maxAllowedUpLat |
Uinteger |
O |
0..1 |
Indicates the target user plane latency in units of milliseconds. The SMF may use this value to decide whether edge relocation is needed to ensure that the user plane latency does not exceed the value. |
AF_latency |
simConnInd |
boolean |
O |
0..1 |
Indication of simultaneous connectivity temporarily maintained for the source and target PSA. It is used to indicate whether the simultaneous connectivity should be temporarily mantained for the source and target PSA. It is set to "true" if the temporary simultaneous connectivity should be temporarily maintained; otherwise, it is set to "false". Default value is "false" if omitted. |
SimultConnectivity |
simConnTerm |
DurationSec |
C |
0..1 |
Indication of the minimum time interval to be considered for inactivity of the traffic routed via the source PSA during the edge re-location procedure before removing the source PSA. It may be included when the "simConnInd" attribute is set to true. |
SimultConnectivity |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
Indicates the list of negotiated supported features. This attribute shall be supplied by the UDR in the response to the PUT request when it was present in the PUT request and the UDR supports feature negotiation for Influence Data. This attribute 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 Influence Data. |
|
resUri |
Uri |
C |
0..1 |
Represents the URI of Individual Influence Data. |
EnhancedInfluDataNotification |
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: One of "afAppId", "trafficFilters" or "ethTrafficFilters" shall be included. NOTE 2: Either "supi" or "interGroupId" shall be included. NOTE 3: If the EnhancedInfluDataNotification feature is not supported, to indicate the deletion of a Traffic Individual Influence Data resource, only the appropriate combination of "supi" or "interGroupId", and "afAppId", "trafficFilters" or "ethTrafficFilters" that identify the resource shall be included. The rest of attributes shall be omitted. NOTE 4: Properties "validStartTime" and "validEndTime" shall only be included for single temporal validity condition. Property "tempValidities" shall only be included for multiple temporal validity conditions when the feature MultiTemporalCondition is supported. NOTE 5: If the Traffic Influence Data applies to any UE, then the "interGroupId" sets to "AnyUE". NOTE 6: In this release of the specification, the property "headers" only includes the 3gpp-Sbi-Binding header with the binding indication for the URI included in the property "upPathChgNotifUri". NOTE 7: The indication of traffic correlation shall be provided only when the AF indicated that all the PDU sessions related to the 5G VN group member UEs should be correlated by a common DNAI in the user plane for the traffic as described in 3GPP TS 29.522 [19]. |
6.4.2.3 Type TrafficInfluDataPatch
Table 6.4.2.3-1: Definition of type TrafficInfluDataPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
upPathChgNotifCorreId |
string |
O |
0..1 |
Contains the Notification Correlation Id allocated by the NEF for the UP path change notification. |
|
appReloInd |
boolean |
O |
0..1 |
Identifies whether an application can be relocated once a location of the application has been selected. |
|
ethTrafficFilters |
array(EthFlowDescription) |
O |
1..N |
Identifies Ethernet packet filters. |
|
trafficFilters |
array(FlowInfo) |
O |
1..N |
Identifies IP packet filters |
|
trafficRoutes |
array(RouteToLocation) |
O |
1..N |
Identifies the N6 traffic routing requirement. |
|
traffCorreInd |
boolean |
O |
0..1 |
Indication of traffic correlation. May only be included when "interGroupId" attribute was previously included in the "TrafficInfluData" data type and not set to "AnyUE". It is used to indicate that for the group of UEs, the targeted PDU sessions should be correlated by a common DNAI. |
|
validStartTime |
DateTime |
O |
0..1 |
Identifies when the traffic routings start to be applicable. |
|
validEndTime |
DateTime |
O |
0..1 |
Identifies when the traffic routings are not applicable. |
|
tempValidities |
array(TemporalValidity) |
O |
1..N |
Indicates the time interval(s) during which the AF request is to be applied. |
MultiTemporalCondition |
nwAreaInfo |
NetworkAreaInfo |
O |
0..1 |
Identifies a network area information that the request applies only to the traffic of UE(s) located in this specific zone. |
|
upPathChgNotifUri |
Uri |
O |
0..1 |
Contains the URI where the NEF receives the UP path change notification. |
|
headers |
array(string) |
O |
1..N |
Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header with the binding indication for the URI where the NEF receives UP path change notification. The encoding of the header shall comply with clause 3.2 of IETF RFC 7230 [21] |
|
afAckInd |
boolean |
O |
0..1 |
Identifies whether the AF acknowledgement of UP path event notification is expected. |
URLLC |
addrPreserInd |
boolean |
O |
0..1 |
Indicates UE IP address should be preserved. |
URLLC |
maxAllowedUpLat |
Uinteger |
O |
0..1 |
Indicates the target user plane latency in units of milliseconds. The SMF may use this value to decide whether edge relocation is needed to ensure that the user plane latency does not exceed the value. |
AF_latency |
simConnInd |
boolean |
O |
0..1 |
Indication of simultaneous connectivity temporarily maintained for the source and target PSA. It is set to "true" if the temporary connectivity should be temporarily maintained; otherwise, it is set to "false". |
SimultConnectivity |
simConnTerm |
DurationSecRm |
C |
0..1 |
Indication of the minimum time interval to be considered for inactivity of the traffic routed via the source PSA during the edge re-location procedure before removing the source PSA. |
SimultConnectivity |
6.4.2.4 Type TrafficInfluSub
Table 6.4.2.4-1: Definition of type TrafficInfluSub
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
dnns |
array(Dnn) |
O |
1..N |
Each element identifies a DNN. |
|
snssais |
array(Snssai) |
O |
1..N |
Each element identifies a slice. |
|
internalGroupIds |
array(GroupId) |
O |
1..N |
Each element identifies a group of users.(NOTE 2) |
|
supis |
array(Supi) |
O |
1..N |
Each element identifies the user. |
|
notificationUri |
Uri |
M |
1 |
URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR. |
|
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. |
|
allowedDelay |
DurationSec |
O |
0..1 |
Indicates that the list of PFDs in this request should be deployed within the time interval indicated by the Allowed Delay. |
|
NOTE 1: At least one of "dnns", "snssais", "internalGroupIds" or "supis" shall be provided. NOTE 2: For the Traffic Influence Data applies to any UE, the "internalGroupIds" needs to have an entry set to "AnyUE". |
6.4.2.5 Void
6.4.2.6 Type: PfdDataForAppExt
Table 6.4.2.6-1: Definition of type PfdDataForAppExt
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
suppFeat |
SupportedFeatures |
O |
0..1 |
Used to negotiate the applicability of the optional features. This attribute shall be provided in the PUT request and in the response of successful resource creation. This attribute shall be provided in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. |
|
applicationId |
ApplicationId |
M |
1 |
Identifier of an application. |
|
pfds |
array(PfdContent) |
M |
1..N |
PFDs for the application identifier. |
|
cachingTime |
DateTime |
O |
0..1 |
Caching time for an application identifier. |
|
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. |
6.4.2.7 Type BdtPolicyData
Table 6.4.2.7-1: Definition of type BdtPolicyData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
interGroupId |
GroupId |
O |
0..1 |
Identifies a group of users. (NOTE) |
|
supi |
Supi |
O |
0..1 |
Identifies a user. (NOTE) |
|
bdtRefId |
BdtReferenceId |
M |
1 |
Identifies a selected policy of background data transfer. |
|
dnn |
Dnn |
O |
0..1 |
Identifies a DNN |
|
snssai |
Snssai |
O |
0..1 |
The identification of slice. |
|
resUri |
Uri |
C |
0..1 |
Represents the URI of Individual Applied BDT 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: Either "supi" or "interGroupId" shall be included. |
6.4.2.8 Type BdtPolicyDataPatch
Table 6.4.2.8-1: Definition of type BdtPolicyDataPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
bdtRefId |
BdtReferenceId |
M |
1 |
Identifies a selected policy of background data transfer. |
6.4.2.9 Type IptvConfigData
Table 6.4.2.9-1: Definition of type IptvConfigData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
supi |
Supi |
C |
0..1 |
Identifies a user. (NOTE) |
|
interGroupId |
GroupId |
C |
0..1 |
Identifies a group of users. (NOTE) |
|
dnn |
Dnn |
O |
0..1 |
Identifies a DNN |
|
snssai |
Snssai |
O |
0..1 |
The identification of slice. |
|
afAppId |
string |
M |
1 |
Identifies an application. |
|
multiAccCtrls |
map(MulticastAccessControl) |
M |
1..N |
Identifies a list of multicast address access control information. Any string value can be used as a key of the map. |
|
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the negotiated supported features. This attribute shall be provided in the PUT request and in the response of successful resource creation. |
|
resUri |
Uri |
C |
0..1 |
Represents the URI of Individual IPTV Configuration. |
|
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: Either "supi" or "interGroupId" shall be included. |
6.4.2.10 Type ApplicationDataSubs
Table 6.4.2.10-1: Definition of type ApplicationDataSubs
Attribute name |
Data type |
P |
Cardinality |
Description |
|
notificationUri |
Uri |
M |
1 |
URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR. |
Applicability |
dataFilters |
array(DataFilter) |
O |
1..N |
Each element identifies a data filter for subscription to data change.notification. If absent, the subscription applies to all data change notification except traffic influence data. |
|
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. |
|
immRep |
boolean |
O |
0..1 |
This attribute is applicable only if the "dataFilters" attribute of the request includes an element with the "dataInd" attribute set to "AM". If provided and set to "true", it indicates that existing matching entries shall be immediately reported within the "amInfluEntries" attribute in the response. |
DCAMP |
amInfluEntries |
array(AmInfluData) |
O |
1..N |
The AM Influence Data 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 and a "dataFilters" attribute that contained an element with the "dataInd" attribute set to "AM". |
DCAMP |
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. |
When multiple attributes defined as an array are included within an entry of the "dataFilters" attribute, the UDR shall determine that the subscription is for all application data of type "dataInd" that contain a matching combination of the values of the elements of the array of the provided attributes.
EXAMPLE: For a subscription to notification on changes of Service Parameter Data resources ("dataInd" is set to "SVC_PARAM"), if "snssais" attribute is included with two S-NSSAI entries (S-NSSAI_1 and S-NSSAI_2) and "dnns" is included with two DNN entries (e.g. DNN_A and DNN_B), and the other optional attributes are not included, the UDR shall notify about changes of Service Parameter Data resources that contain a matching S-NSSAI and DNN combination, i.e. the resource(s) matching SNSSAI_1 and DNN_A, the resource(s) matching SNSSAI_1 and DNN_B, the resource(s) matching SNSSAI_2 and DNN_A, and the resources matching SNSSAI_2 and DNN_B.
6.4.2.11 Type ApplicationDataChangeNotif
Table 6.4.2.11-1: Definition of type ApplicationDataChangeNotif
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
iptvConfigData |
IptvConfigData |
O |
0..1 |
IPTV Configuration Data. (NOTE) |
|
pfdData |
PfdChangeNotification |
O |
0..1 |
PFD Data. (NOTE) |
|
bdtPolicyData |
BdtPolicyData |
O |
0..1 |
BDT Policy Data. (NOTE) |
|
serParamData |
ServiceParameterData |
O |
0..1 |
Service Parameter Data, if changed and notification was requested. (NOTE) |
|
amInfluData |
AmInfluData |
O |
0..1 |
AM Influence Data (NOTE) |
|
resUri |
Uri |
M |
1 |
Identifies the resource in the corresponding data change. For notifying deletion, only resUri shall be provided in the ApplicationDataChangeNotif data type. |
|
NOTE: Only one among those attributes shall be provided in notifying data creation or update. |
6.4.2.12 Type DataFilter
Table 6.4.2.12-1: Definition of type DataFilter
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
dataInd |
DataInd |
M |
1 |
Indicate the type of application data. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd", and match also the filters indicated in the rest of the attributes of DataFilter (if any). |
|
dnns |
array(Dnn) |
O |
1..N |
Each element identifies a DNN. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the DNNs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). (NOTE 3) |
|
snssais |
array(Snssai) |
O |
1..N |
Each element identifies a slice. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the S-NSSAIs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). (NOTE 3) |
|
internalGroupIds |
array(GroupId) |
O |
1..N |
Each element identifies a group of users. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the Group IDs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). |
|
supis |
array(Supi) |
O |
1..N |
Each element identifies the user. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the SUPIs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). |
|
appIds |
array(ApplicationId) |
O |
1..N |
Each element identifies an application. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the ApplicationIds included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). |
|
ueIpv4s |
array(Ipv4Addr) |
O |
1..N |
Each element identifies the user. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the IPv4 address(es) included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). |
|
ueIpv6s |
array(Ipv6Addr) |
O |
1..N |
Each element identifies the user. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the IPv6 addresses included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). |
|
ueMacs |
array(MacAddr48) |
O |
1..N |
Each element identifies the user. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the UE MAC address(es) included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). |
|
anyUeInd |
boolean |
O |
Indicates whether the request is for any UE. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain an any UE indication, and match also the filters indicated in the rest of the attributes of DataFilter (if any). |
FilterAnyUE |
|
dnnSnssaiInfos |
array(DnnSnssaiInformation) |
O |
1..N |
Each element identifies a combination of (DNN, S-NSSAI). When used in subscription procedures, the UDR shall only notify about changes in resource(s) with "dataInd" value AM that contain at least one DNN and S-NSSAI combination indicated in the array, and match also the rest of the filters (if any). (NOTE 3) |
DCAMP |
NOTE 1: The "dnns", "snssais", "internalGroupIds" and "supis" attributes are applicable to the BDT Policy Data, IPTV Configuration Data, Service Parameter Data, and AM Influence Data, the "ueIpv4s" "ueIpv6s" and "ueMacs" attributes are applicable to the Service Parameter Data, the "appIds" attribute is applicable to the PFD Data, Service Parameter Data and IPTV Configuration Data, the "anyUeInd" attribute is applicable to Service Parameter Data and AM Influence Data, and the "dnnSnssaiInfos" is applicable to AM Influence Data. NOTE 2: At application datat changes, subscriptions to changes based on attributes of this table are considered to be matched, and the corresponding notifications are sent, no matter if the matching application data matches the provided values before the change, after the change, or both before and after the change. NOTE 3: For AM Influence Data, only one of the "dnns", "snssais", or "dnn-snssai-infos" attributes may be simultaneously provided. |
NOTE: When the "anyUeInd" attribute is related to the subscription to notification of changes of the service parameter data resource(s), and it refers to any UE using the service identified by a combination of DNN and S-NSSAI, the "anyUeInd" attribute is present together with the "dnns" and "snssais" properties. Note also that, if the "anyUeInd" attribute is present together with the "internalGroupIds", "supis", "ueIpv4s", "ueIpv6s" and/or "ueMacs" attributes the subscription will not match any resource, since according to clause 6.4.2.15 only one of the the "supi", "anyUeInd", "interGroupId", "ueIpv4", "ueIpv6" or "ueMac" properties are simultaneously present in the resource.
When the "anyUeInd" attribute is related to the subscription to notification of changes of the AM Influence data resource(s), and it refers to any UE using the service(s) identified by the corresponding DNN and S-NSSAI, the "anyUeInd" attribute is present together with the "dnnSnssaiInfos" property. Note also that, if the "anyUeInd" attribute is present together with the "internalGroupIds" and/or "supis" attributes the subscription will not match any resource, since according to clause 6.4.2.16 only one of the the "supi", "anyUeInd", or "interGroupId" properties are simultaneously present in the resource.
6.4.2.13 Void
6.4.2.14 Type TrafficInfluDataNotif
Table 6.4.2.14-1: Definition of type TrafficInfluDataNotif
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
resUri |
Uri |
M |
1 |
Represents the URI of Individual Influence Data. For notifying deletion, only resUri shall be provided in the TrafficInfluDataNotif data type. |
|
trafficInfluData |
TrafficInfluData |
C |
0..1 |
Traffic Influence Data. It shall be present for notifying Individual Influence Data creation or update. |
6.4.2.15 Type ServiceParameterData
Table 6.4.2.15-1: Definition of type ServiceParameterData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
dnn |
Dnn |
O |
0..1 |
Identifies a DNN. (NOTE 2) |
|
snssai |
Snssai |
O |
0..1 |
Identifies an S-NSSAI. (NOTE 2) |
|
appId |
string |
O |
0..1 |
Identifies an application identifier. (NOTE 2) |
|
supi |
Supi |
O |
0..1 |
Identifies a user. (NOTE1) |
|
ueIpv4 |
Ipv4Addr |
O |
0..1 |
The IPv4 address of the served UE. (NOTE1) |
|
ueIpv6 |
Ipv6Addr |
O |
0..1 |
The IPv6 address of the served UE. (NOTE1) |
|
ueMac |
MacAddr48 |
O |
0..1 |
The MAC address of the served UE. (NOTE1) |
|
interGroupId |
GroupId |
O |
0..1 |
Identifies a group of users. (NOTE1) |
|
anyUeInd |
boolean |
O |
0..1 |
Identifies whether the service parameters applies to any UE. This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". (NOTE1) |
|
paramOverPc5 |
ParameterOverPc5 |
O |
0..1 |
Contains the V2X service parameters used over PC5 |
|
paramOverUu |
ParameterOverUu |
O |
0..1 |
Contains the V2X service parameters used over Uu |
|
urspGuidance |
array(UrspRuleRequest) |
O |
1..N |
Contains the service parameter used to guide the URSP. |
AfGuideURSP |
paramForProSeDd |
ParamForProSeDd |
O |
0..1 |
Contains the service parameters for 5G ProSe direct discovery. |
ProSe |
paramForProSeDc |
ParamForProSeDc |
O |
0..1 |
Contains the service parameters for 5G ProSe direct communications. |
ProSe |
paramForProSeU2NRelUe |
ParamForProSeU2NRelUe |
O |
0..1 |
Contains the service parameters for 5G ProSe UE-to-network relay UE. |
ProSe |
paramForProSeRemUe |
ParamForProSeRemUe |
O |
0..1 |
Contains the service parameters for 5G ProSe remote UE. |
ProSe |
deliveryEvents |
array(Event) |
O |
1..N |
Contains the events related to the outcome of UE policy delivery. |
DeliveryOutcome |
policDelivNotifCorreId |
string |
C |
0..1 |
Contains the Notification Correlation Id allocated by the NEF for the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE Policy delivery outcome. |
DeliveryOutcome |
policDelivNotifUri |
Uri |
C |
0..1 |
Contains the URI where the NEF receives the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE policy delivery outcome. |
DeliveryOutcome |
headers |
array(string) |
O |
1..N |
Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the policDelivNotifUri attribute. The encoding of the header shall comply with clause 3.2 of IETF RFC 7230 [21] |
DeliveryOutcome |
suppFeat |
SupportedFeatures |
C |
0..1 |
Indicates the list of Supported features used as described in clause 5.8. This parameter shall be supplied in the PUT request that requested the creation of an individual Service parameter resource, and in the PUT response. |
|
resUri |
Uri |
C |
0..1 |
Represents the URI of Individual Service Parameter 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: Only one of the "supi", "anyUeInd", "interGroupId", "ueIpv4", "ueIpv6" or "ueMac" attribute shall be provided. NOTE 2: Only the combination of "dnn" and "snssai" or "appId" attribute shall be provided. |
6.4.2.16 Type AmInfluData
Table 6.4.2.16-1: Definition of type AmInfluData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
appIds |
array(string) |
O |
1..N |
Identifies one or more applications. |
|
dnnSnssaiInfos |
array(DnnSnssaiInformation) |
O |
1..N |
Each element identifies a combination of (DNN, S-NSSAI). |
|
interGroupId |
GroupId |
O |
0..1 |
Identifies a group of users. (NOTE 1) |
|
supi |
Supi |
O |
0..1 |
Identifies a user. (NOTE 1) |
|
anyUeInd |
boolean |
O |
0..1 |
Indicates whether the data applies to any UE. If present and set to "true" the data is applicable for any UE. (NOTE 1) |
|
policyDuration |
DurationSec |
O |
0..1 |
Indicates the time duration that the policy shall last. |
|
evSubs |
array(AmInfluEvent) |
O |
1..N |
List of AM related events for which a subscription is required. |
|
headers |
array(string) |
O |
1..N |
Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the notifUri IE. The encoding of the header shall comply with clause 3.2 of IETF RFC 7230 [21] |
|
notifUri |
Uri |
C |
0..1 |
Contains the Callback URI to receive notifications. It shall be present if the "evSubs" attribute is present. |
|
notifCorrId |
string |
O |
0..1 |
Notification correlation identifier. |
|
thruReq |
boolean |
O |
0..1 |
If present and set to "true", it indicates that high throughput is desired for the indicated UE traffic. (NOTE 2) |
|
covReq |
array(ServiceAreaCoverageInfo) |
O |
1..N |
Identifies service area coverage requirements. (NOTE 2) |
|
supportedFeatures |
SupportedFeatures |
C |
0..1 |
Indicates the list of negotiated supported features. This attribute shall be supplied by the UDR in the response to the PUT request when it was present in the PUT request and the UDR supports feature negotiation for AM Influence Data. This attribute 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 AM Influence Data. |
|
resUri |
Uri |
C |
0..1 |
Represents the URI of Individual AM Influence 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: One of "supi", "interGroupId", and "anyUeInd" shall be included. NOTE 2: At least one of these attributes shall be included. |
6.4.2.17 Type AmInfluDataPatch
Table 6.4.2.17-1: Definition of type AmInfluDataPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
appIds |
array(string) |
O |
1..N |
Identifies one or more applications. |
|
dnnSnssaiInfos |
array(DnnSnssaiInformation) |
O |
1..N |
Each element identifies a combination of (DNN, S-NSSAI). |
|
policyDuration |
DurationSecRm |
O |
0..1 |
Indicates the time duration that the policy shall last. |
|
evSubs |
array(AmInfluEvent) |
O |
1..N |
List of AM related events for which a subscription is required. |
|
headers |
array(string) |
O |
1..N |
Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the notifUri IE. The encoding of the header shall comply with clause 3.2 of IETF RFC 7230 [21] |
|
notifUri |
UriRm |
C |
0..1 |
Contains the Callback URL to receive notifications. |
|
notifCorrId |
string |
O |
0..1 |
Notification correlation identifier. |
|
thruReq |
boolean |
O |
0..1 |
If present and set to "true", it indicates that high throughput is desired for the indicated UE traffic. |
|
covReq |
string |
O |
0..1 |
Identifies service area coverage requirements. |
6.4.2.15A Type ServiceParameterDataPatch
Table 6.4.2.15A-1: Definition of type ServiceParameterDataPatch
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
paramOverPc5 |
ParameterOverPc5 |
O |
0..1 |
Contains the V2X service parameters used over PC5 |
|
paramOverUu |
ParameterOverUu |
O |
0..1 |
Contains the V2X service parameters used over Uu |
|
urspInfluence |
array(UrspRuleRequest) |
O |
1..N |
Contains the service parameter used to influence the URSP. |
AfGuideURSP |
paramForProSeDd |
ParamForProSeDd |
O |
0..1 |
Contains the service parameters for 5G ProSe direct discovery. |
ProSe |
paramForProSeDc |
ParamForProSeDc |
O |
0..1 |
Contains the service parameters for 5G ProSe direct communications. |
ProSe |
paramForProSeU2NRelUe |
ParamForProSeU2NRelUe |
O |
0..1 |
Contains the service parameters for 5G ProSe UE-to-network relay UE. |
ProSe |
paramForProSeRemUe |
ParamForProSeRemUe |
O |
0..1 |
Contains the service parameters for 5G ProSe remote UE. |
ProSe |
deliveryEvents |
array(Event) |
O |
1..N |
Contains the events related to the outcome of UE policy delivery. |
DeliveryOutcome |
policDelivNotifUri |
Uri |
C |
0..1 |
Contains the URI where the NEF receives the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE policy delivery outcome. |
DeliveryOutcome |
headers |
array(string) |
O |
1..N |
Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the policDelivNotifUri IE. The encoding of the header shall comply with clause 3.2 of IETF RFC 7230 [21] |
DeliveryOutcome |
6.4.3 Simple data types and enumerations
6.4.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.4.3.2 Simple data types
The simple data types defined in table 6.4.3.2-1 shall be supported.
Table 6.4.3.2-1: Simple data types
Type Name |
Type Definition |
Description |
Applicability |
6.4.3.3 Enumeration: DataInd
Table 6.4.3.3-1: Enumeration DataInd
Enumeration value |
Description |
Applicability |
PFD |
PFD data |
|
IPTV |
IPTV configuration data |
|
BDT |
BDT data |
|
SVC_PARAM |
Service parameter data |
|
AM |
AM influence data |
DCAMP |