SubscriptionData

/subscription-data

none

For sub-level resource names, resource URIs and HTTP methods see 3GPP TS 29.505 [2]

PolicyData

/policy-data

none

For sub-level resource names, resource URIs and HTTP methods see 3GPP TS 29.519 [3]

StructuredDataForExposure

/exposure-data

none

For sub-level resource names, resource URIs and HTTP methods see 3GPP TS 29.519 [3]

ApplicationData

/application-data

none

For sub-level resource names, resource URIs and HTTP methods see 3GPP TS 29.519 [3]

DataRestorationEvents

/data-restoration-events

POST

This is a pseudo operation.

apiRoot

string

See clause 6.1.1

apiVersion

string

See clause 6.1.1

n/a

Any

n/a

n/a

DataRestorationNotification

M

1

Contains identifiers representing those UEs potentially affected by a data-loss event at the UDR.

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same NF or NF (service) set.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same NF or NF (service) set.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be used to indicate one of the following application errors:

– CONTEXT_NOT_FOUND

NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [7] are supported.

Location

string

M

1

Contains the Callback URI of the target NF Service Consumer (e.g. UDM) to which the request is redirected

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

DataRestorationNotification

6.2.5a.2.2

Contains identities representing those UEs potentially affected by a data-loss event at the UDR

Dnn

3GPP TS 29.571 [10]

Data Network Name with Network Identifier only.

Snssai

3GPP TS 29.571 [10]

Single NSSAI

NfGroupId

3GPP TS 29.571 [10]

NF Group ID

IdentityRange

3GPP TS 29.510 [14]

Identity Range

SupiRange

3GPP TS 29.510 [14]

SUPI Range

supiRanges

array(SupiRange)

O

1..N

If present, it contains the list of SUPIs potentially subject to a data-loss event at the UDR.

gpsiRanges

array(IdentityRange)

O

1..N

If present, it contains the list of GPSIs potentially subject to a data-loss event at the UDR.

resetIds

array(string)

O

1..N

If present, it contains the list of Reset-IDs of those UEs potentially subject to a data-loss event at the UDR.

sNssaiList

array(Snssai)

O

1..N

If present, it contains the list of slices (S-NSSAIs) potentially subject to a data-loss event at the UDR.

dnnList

array(Dnn)

O

1..N

If present, it contains the list of DNNs potentially subject to a data-loss event at the UDR.

lastReplicationTime

DateTime

O

0..1

If present, it contains the timestamp of the most recent instant when the data was assumed to be consistent at UDR (i.e. the potential data loss event at UDR did not occur before this instant).

recoveryTime

DateTime

O

0..1

If present, it contains the timestamp of the instant when the potential data loss event was recovered at UDR (i.e. all data records stored by UDR after this time are assumed to be consistent).

udrGroupId

NfGroupId

O

0..1

If present, it contains the ID of the UDR Group whose UEs have been potentially subject to a data loss event at the UDR.

ProblemDetails

O

0..1

4xx, 5xx responses

For error status codes, the UDR may provide detailed information.

NOTE: In addition common data structures as defined in 3GPP TS 29.500 [7] are supported.

NF_TYPE_NOT_ALLOWED

403 Forbidden

The target data set is not permitted to access for the NF type of the NF consumer.

UNSUPPORTED_MONITORED_URI

501 Not Implemented

The subscribe service operation is not able to be implemented due to invalid resource URI to be monitored).

USER_NOT_FOUND

404 Not Found

The user indicated in the HTTP/2 request does not exist in the UDR.

DATA_NOT_FOUND

404 Not Found

The data indicated in the HTTP/2 request is unavailable in the UDR.

INCORRECT_CONDITIONAL_GET_REQUEST

412 Precondition Failed

One or more conditions given in the request header fields evaluated to false when tested in the UDR.

UNPROCESSABLE_REQUEST

422 Unprocessable Entity

The request cannot be procesed due to semantic errors when trying to process a patch method.

DATABASE INCONSISTENCY

500 Internal Server Error

Requested data cannot be returned due to database inconsistency

RESOURCE_TEMP_MOVED

307 Temporary Redirect

The resource is unavailable in the current target URI but can be temporarily found in an alternative URI.

RESOURCE_MOVED

308 Permanent Redirect

The resource is unavailable in the current target URI but can be permanently found in an alternative URI.

GROUP_IDENTIFIER_NOT_FOUND

404 Not Found

The group identifier does not exist.

MODIFICATION_NOT_ALLOWED

403 Forbidden

Modification of the target resource representation is not permitted.

PLMN_NOT_FOUND

404 Not Found

The ‘servingPlmnId’ indicated in the HTTP/2 query is unavailable in the UDR. This status code is also used when ‘servingPlmnId’ path variable contains SNPN ID, see Table 5.2.3.2-1 in 3GPP TS 29.505 [2].

NOTE: The error codes shall apply to both 3GPP TS 29.505 [2] and 3GPP TS 29.519 [3]. In addition error codes shall comply with the definition in clause 5.2.7.2 of 3GPP TS 29.500 [7].

"nudr-dr"

Access to the Nudr DataRepository API

"nudr-dr:subscription-data"

Access to the SubscriptionData data set.

"nudr-dr:subscription-data:authentication-subscription:read"

Access to read the AuthenticationSubscription resource of the SubscriptionData data set.

"nudr-dr:subscription-data:authentication-subscription:modify"

Access to update the AuthenticationSubscription resource of the SubscriptionData data set.

"nudr-dr:subscription-data:registrations:write"

Write access to NF registration resources of the SubscriptionData data set.

"nudr-dr:policy-data"

Access to the PolicyData data set.

"nudr-dr:policy-data:ues:read"

Access to read the UEs resource.

"nudr-dr:policy-data:ues:am-data:read"

Access to read the UEs Access and Mobility Policy data.

"nudr-dr:policy-data:ues:ue-policy-set:read"

Access to read the UEs Policy Set data.

"nudr-dr:policy-data:ues:ue-policy-set:create"

Access to create the UEs Policy Set data.

"nudr-dr:policy-data:ues:ue-policy-set:modify"

Access to update the UEs Policy Set data.

"nudr-dr:policy-data:ues:sm-data:read"

Access to read the UEs Session Management policy data.

"nudr-dr:policy-data:ues:sm-data:modify"

Access to update the UEs Session Management policy data.

"nudr-dr:policy-data:ues:sm-data:create"

Access to create the UEs Session Management policy data.

"nudr-dr:policy-data:sponsor-connectivity-data:read"

Access to read the sponsored connectivity data.

"nudr-dr:policy-data:bdt-data:read"

Access to read the BDT data resource.

"nudr-dr:policy-data:bdt-data:create"

Access to create the BDT data resource.

"nudr-dr:policy-data:bdt-data:modify"

Access to update the BDT data resource.

"nudr-dr:policy-data:subs-to-notify:create"

Access to create Subscriptions resources.

"nudr-dr:policy-data:subs-to-notify:modify"

Access to update Subscriptions resources.

"nudr-dr:policy-data:ues:operator-specific-data:read"

Access to read the UEs operator specific policy data.

"nudr-dr:policy-data:ues:operator-specific-data:modify"

Access to update the UEs operator specific policy data.

"nudr-dr:policy-data:ues:operator-specific-data:create"

Access to create the UEs operator specific policy data.

"nudr-dr:policy-data:slice-control-data:read"

Access to read Slice specific Policy Control Data.

"nudr-dr:policy-data:slice-control-data:modify"

Access to update Slice specific Policy Control Data.

"nudr-dr:exposure-data"

Access to the ExposureData data set.

"nudr-dr:exposure-data:access-and-mobility-data:create"

Access to create Access and Mobility data.

"nudr-dr:exposure-data:access-and-mobility-data:read"

Access to read Access and Mobility data.

"nudr-dr:exposure-data:access-and-mobility-data:modify"

Access to update Access and Mobility data.

"nudr-dr:exposure-data:session-management-data:create"

Access to create Session Management data.

"nudr-dr:exposure-data:session-management-data:read"

Access to read Session Management data.

"nudr-dr:exposure-data:session-management-data:modify"

Access to update Session Management data.

"nudr-dr:exposure-data:subs-to-notify:create"

Access to create Subscriptions resources.

"nudr-dr:exposure-data:subs-to-notify:modify"

Access to update Subscriptions resources.

"nudr-dr:application-data"

Access to the ApplicationData data set.

"nudr-dr:application-data:pfds:read"

Access to read PFDData.

"nudr-dr:application-data:pfds:modify"

Access to update PFDData.

"nudr-dr:application-data:pfds:create"

Access to create PFDData.

"nudr-dr:application-data:influence-data:read"

Access to read Traffic Influence Data.

"nudr-dr:application-data:influence-data:create"

Access to create Traffic Influence Data.

"nudr-dr:application-data:influence-data:modify"

Access to update Traffic Influence Data.

"nudr-dr:application-data:influence-data:subscriptions:create"

Access to create Traffic Influence Data Subscriptions.

"nudr-dr:application-data:influence-data:subscriptions:read"

Access to read Traffic Influence Data Subscriptions.

"nudr-dr:application-data:influence-data:subscriptions:modify"

Access to update Traffic Influence Data Subscriptions.

"nudr-dr:application-data:bdt-policy-data:read"

Access to read BDT Policy Data.

"nudr-dr:application-data:bdt-policy-data:create"

Access to create BDT Policy Data.

"nudr-dr:application-data:bdt-policy-data:modify"

Access to update BDT Policy Data.

"nudr-dr:application-data:iptv-config-data:read"

Access to read IPTV Configuration Data.

"nudr-dr:application-data:iptv-config-data:create"

Access to create IPTV Configuration Data.

"nudr-dr:application-data:iptv-config-data:modify"

Access to update IPTV Configuration Data.

"nudr-dr:application-data:service-param-data:read"

Access to read Service Parameter Data.

"nudr-dr:application-data:service-param-data:create"

Access to create Service Parameter Data.

"nudr-dr:application-data:service-param-data:modify"

Access to update Service Parameter Data.

"nudr-dr:application-data:am-influence-data:read"

Access to read AM Influence Data.

"nudr-dr:application-data:am-influence-data:create"

Access to create AM Influence Data.

"nudr-dr:application-data:am-influence-data:modify"

Access to update AM Influence Data.

"nudr-dr:application-data:subs-to-notify:create"

Access to create Subscriptions resources.

"nudr-dr:application-data:subs-to-notify:read"

Access to read Subscriptions resources.

"nudr-dr:application-data:subs-to-notify:modify"

Access to update Subscriptions resources.

"nudr-dr:application-data:eas-deploy-data:read"

Access to read EAS Deployment Information Data.

"nudr-dr:application-data:eas-deploy-data:create"

Access to create EAS Deployment Information Data.

"nudr-dr:application-data:eas-deploy-data:modify"

Access to update EAS Deployment Information Data.

1

ResourceRemovalNotificationPolicyData

This feature indicates the support of the complete removal of a Policy Data resource.

2

ResourceNotificationExposureDataFix

This feature indicates the support of corrections to Notifications of data changes in the Exposure Data resource.

3

DomainNameProtocol

This feature supports the additional protocol matching condition for the domain name in PFD data.

4

EnhancedBackgroundDataTransfer

This feature indicates the support of applying the Background Data Transfer Policy to a future PDU session requested by the AF for Policy Data resource and Application Data resource as defined in 3GPP TS 29.519 [3]. This feature requires the support of SessionManagementPolicyDataPatch feature to update Background Data Transfer data within the Session Management Policy Data.

5

MacAddressRange

This feature indicates the support of a set of MAC addresses with a specific range for the traffic filter in the application data resource as specified in 3GPP TS 29.519 [3].

6

MultiTemporalCondition

This feature indicates the support of multiple temporal validity conditions in the Traffic Influence Data resource as specified in 3GPP TS 29.519 [3].

7

PatchReport

If some of the modifications included in the PATCH request are not successfully implemented, the UDM reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [7].

8

URLLC

This feature indicates support of Ultra Reliable Low Latency Communication (URLLC) requirements, i.e. AF application relocation and UE address(es) preservation in the Application Data resource as specified in 3GPP TS 29.519 [3].

9

SessionManagementPolicyDataPatch

This feature indicates the support of the HTTP PATCH method to update the session management policy data defined in a Policy Data resource as specified in 3GPP TS 29.519 [3].

10

ConditionalSubscriptionwithPartialNotification

This feature indicates the support of subscription to notification of resource data changes conditioned to the change occurs in a fragment of the resource. It applies for Policy Data resources as specified in 3GPP TS 29.519 [3].

11

EnhancedInfluDataNotification

This feature indicates the support of enhancement of data change Notifications in the Influence Data resource as specified in 3GPP TS 29.519 [3].

12

PerUePerSnAuthStatus

This feature indicates the support of the Individual authentication status per UE per serving network as specified in 3GPP TS 29.505 [2].

13

OpSpecDataMapNotification

This feature indicates the support of the notification of data changes in the OperatorSpecificData resource by including the complete map of Operator Specific Data Containers. It applies to Policy Data resources as specified in 3GPP TS 29.519 [3].

14

PlmnSmPolicyData

This feature indicates the support of a resource in the policy data which represents Session Management Policy Data per PLMN. It applies for Policy Data resources as specified in 3GPP TS 29.519 [3].

15

OSDResource_Create_Delete

This feature indicates the support of the creation and the removal of the OperatorSpecificData resource by a Policy Data NF service consumer. It applies to Policy Data resources as specified in 3GPP TS 29.519 [3].

16

AF_latency

This feature indicates the support for Edge relocation considering user plane latency. It applies for Influence Data resource as specified in 3GPP TS 29.519 [3].

17

CHFsetSupport

This feature indicates the support of CHF redundancy and failover mechanisms based on CHF instance availability within a CHF Set, (i.e. secondary CHF address may be omitted). It applies to Policy Data resources as specified in 3GPP TS 29.519 [3].

18

ConditionalSubscriptionWithExcludeNotification

This feature indicates the support in the subscription to notification of data changes of the indication of the properties whose changes do not trigger a notification. It applies to Policy Data resources as specified in 3GPP TS 29.519 [3]. It requires the support of OpSpecDataMapNotification feature

19

ProSe

This feature indicates the support of UE 5G ProSe policies and subscription information. It applies for Policy Data resources as specified in 3GPP TS 29.519 [3].

20

NSAC

This feature indicates the support of NSAC (Network Slice Admission Control) related policy subscription information. It applies to Policy Data resources as specified in 3GPP TS 29.519 [3].

21

UESubDataSetRetrieve

This feature indicates the support of the UE Subscription Data Sets Retrieve as specified in clause 5.2.47 of 3GPP TS 29.505 [2].

22

SharedSmSubsData

This feature indicates the support of shared Session Management Subscription Data. If the NF consumer (UDM) does not support this feature, the UDR shall not take the alternative to include extendedSmSubsData in SmSubsData.
It applies to Subscription Data resources as specified in 3GPP TS 29.505 [2]

23

DeliveryOutcome

This feature indicates the support of functionality to allow PCF notifications about the outcome of the UE Policy delivery related to the invocation of AF provisioned service parameters as specified in 3GPP TS 29.519 [3].

24

AfGuideURSP

This feature indicates the support of Application guidance for URSP determination related application data as specified in 3GPP TS 29.519 [3].

25

EasDeployment

This feature indicates the support of EAS Deployment Information Data and Subscription related application data as specified in 3GPP TS 29.519 [3].

26

DCAMP

This feature indicates the support of DCAMP related application data. It applies to Application Data resources as specified in 3GPP TS 29.519 [3].

27

FilterAnyUE

This feature indicates the support of queries and subscriptions to service parameter data resource filtered by the any UE indication as specified in 3GPP TS 29.519 [3].

28

SimultConnectivity

This feature indicates the support of temporary simultaneously connectivity at edge relocation. It applies for Influence Data resource as specified in 3GPP TS 29.519 [3].

29

EeSubscriptionExt

This feature indicates the support of handling EE subscription data along with associated subscription resources as specified in 3GPP TS 29.505 [2].

30

PeiResource

This feature indicates the support of storing PEI in the PeiInfo resource as specified in 3GPP TS 29.505 [2].

31

ImmediateReportPcc

This feature indicates support of ImmediateReport within a PolicyDataSubscription in 3GPP TS 29.519 [3]. When a UDR consumer detects that the UDR supports the ImmediateReportPcc feature, it can indicate an immediateReport flag when invoking the Subscribe service operation. If the UDR receives the ImmediateReport flag in the received Subscribe service operation request, it shall return the resource’s representation(s) of the monitored resource(s) in the service operation response body.

32

ImmediateReport

This feature indicates support of ImmediateReport within an SubscriptionDataSubscription in 3GPP TS 29.505 [2]. When a UDR consumer detects that the UDR supports the ImmediateReport feature, it can indicate an immediateReport flag when invoking the Subscribe service operation. If the UDR receives the ImmediateReport flag in the received Subscribe service operation request, it shall return the resource’s representation(s) of the monitored resource(s) in the service operation response body.

NfGroupIds

/nf-group-ids

GET

apiRoot

See clause 6.2.1

nf-type

array(NFType)

M

1..N

see 3GPP TS 29.510 [14]

subscriberId

SubscriberId

M

1

Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU (see 3GPP TS 23.501 [4] clause 5.9.2 and clause 5.9.8)
pattern: ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|impi-.+|impu-.+|.+)$

n/a

NfGroupIdMapResult

M

1

200 OK

Upon success, a response body containing the NF-Group IDs for the requested NF types shall be returned.

ProblemDetails

O

0..1

404 Not Found

The "cause" attribute may be set to one of the following application errors:

– USER_NOT_FOUND

NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 are supported.

NfGroupIdMapResult

6.2.6.2.2

NF-Group IDs for the requested NF types

SubscriberId

6.2.6.3.2

Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU

ProblemDetails

3GPP TS 29.571 [10]

Common data type used in response bodies

NFType

3GPP TS 29.510 [14]

NfGroupId

3GPP TS 29.571 [10]

nfGroupIDs

map(NfGroupId)

M

1..N

A map (list of key-value pairs where NFType serves as key) of NFGroupIds

SubscriberId

string

Pattern: ^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|impi-.+|impu-.+|.+)$

USER_NOT_FOUND

404 Not Found

The user does not exist in the HPLMN