AccessAndMobilityData

/exposure-data/{ueId}/
access-and-mobility-data

PUT

Create and update the access and mobility exposure data for a UE

PATCH

Update the access and mobility exposure data for a UE.

GET

Retrieve the access and mobility exposure data for a UE

DELETE

Delete the access and mobility exposure data for a UE

PduSessionManagementData

/exposure-data/{ueId}/
session-management-data/
{pduSessionId}

PUT

Create and update the session management data for a UE and for an individual PDU session

GET

Retrieve the session management data for a UE and for an individual PDU session

DELETE

Delete the session management data for a UE and for an individual PDU session

ExposureDataSubscriptions

/exposure-data/subs-to-notify

POST

Create a subscription to receive notifications on exposure data changes.

IndividuaExposureDataSubscription

/exposure-data/subs-to-notify/
{subId}

PUT

Modify a subscription to receive notifications on exposure data changes.

DELETE

Delete a subscription identified by {subId}.

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

ueId

VarUeId

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

n/a

AccessAndMobilityData

M

1

Access and mobility data for the UE is created or updated.

AccessAndMobilityData

M

1

201 Created

Successful case.

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

AccessAndMobilityData

M

1

200 OK

Successful case.

The resource has been successfully updated and a response body containing a representation of the access and mobility 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 HTTP status code 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>/exposure-data/{ueId}/access-and-mobility-data

supp-feat

SupportedFeatures

O

0..1

The features supported by the NF service consumer.

See 3GPP TS 29.500 [4] clause 6.6.2 and 3GPP TS 29.571 [7].

n/a

AccessAndMobilityData

M

1

200 OK

The response body contains the access and mobility data.

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

n/a

n/a

n/a

204 No Content

Upon success, an empty response body shall be returned.

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

n/a

AccessAndMobilityData

M

1

Access and mobility data for the UE.

n/a

204 No Content

Upon successful modification there is no body in the response message.

NOTE: The HTTP status code 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.

ueId

VarUeId

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

pduSessionId

PduSessionId

Identifies an individual PDU session. Data type PduSessionId is defined in 3GPP TS 29.571 [7].

n/a

PduSessionManagementData

M

1

Session management data for a UE and a PDU session is created or updated.

PduSessionManagementData

M

1

201 Created

Successful case.

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

PduSessionManagementData

M

1

200 OK

Successful case.

The resource has been successfully updated and a response body containing a representation of the session management 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 HTTP status code 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>/exposure-data/{ueId}/session-management-data/{pduSessionId}

ipv4-addr

Ipv4Addr

O

0..1

UE IPv4 address.

ipv6-prefix

Ipv6Prefix

O

0..1

UE IPv6 prefix.

dnn

Dnn

O

0..1

Identifies a DNN.

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

The features supported by the NF service consumer.

See 3GPP TS 29.500 [4] clause 6.6.2 and 3GPP TS 29.571 [7].

n/a

PduSessionManagementData

M

1

200 OK

The response body contains the session management data.

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

n/a

n/a

n/a

204 No Content

Upon success, an empty response body shall be returned.

NOTE: The HTTP status code 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.

n/a

ExposureDataSubscription

M

1

Identifies an individual subscription to notifications of exposure data modifications.

ExposureDataSubscription

M

1

201 Created

Upon success, a response body containing a representation of the 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>/exposure-data/subs-to-notify/{subId}

apiRoot

string

See 3GPP TS 29.504 [6] clause 6.1.1.

subId

string

Identifies an individual subscription to notifications. The value is allocated by the UDR during creation of the IndividualExposureDataSubscription resource.

n/a

ExposureDataSubscription

M

1

Identifies an individual subscription to notifications of exposure data modifications.

ExposureDataSubscription

M

1

200 OK

The individual subscription resource was updated successfully and a body with the modified subscription to notifications about exposure data is returned.

n/a

204 No Content

The individual subscription resource was successfully modified.

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.

AccessAndMobilityData

7.3.2.2

ExposureDataChangeNotification

7.3.2.5

Contains changed exposure data for one UE for which Notification was requested.

ExposureDataSubscription

7.3.2.4

Subscription to Notifications about Exposure Data.

PduSessionManagementData

7.3.2.3

PduSessionStatus

7.3.3.3

Represents the state of the PDU session, i.e. active or released.

AccessType

3GPP TS 29.571 [7]

Identifies the access type, i.e. 3GPP access or Non-3GPP access.

CmInfo

3GPP TS 29.518 [10]

Describes the connectivity management state of a UE.

DateTime

3GPP TS 29.571 [7]

Dnai

3GPP TS 29.571 [7]

Identifies a Data network access identifier.

Dnn

3GPP TS 29.571 [7]

Identifies a Data Network Name. (NOTE)

Ipv4Addr

3GPP TS 29.571 [7]

The IPv4 Address.

Ipv6Addr

3GPP TS 29.571 [7]

The Ipv6 Address.

Ipv6Prefix

3GPP TS 29.571 [7]

The Ipv6 Address Prefix.

PduSessionId

3GPP TS 29.571 [7]

PDU Session Identifier

PduSessionType

3GPP TS 29.571 [7]

PDU Session type.

PlmnId

3GPP TS 29.571 [7]

Identifies a PLMN.

RatType

3GPP TS 29.571 [7]

Identifies a RAT type.

RmInfo

3GPP TS 29.518 [10]

Describes the registration management state of a UE.

RouteToLocation

3GPP TS 29.571 [7]

A traffic route to/from a DNAI.

TimeZone

3GPP TS 29.571 [7]

Identifies a time zone.

SmsSupport

3GPP TS 29.518 [10]

Indicates the supported SMS delivery of a UE.

SupportedFeatures

3GPP TS 29.571 [7]

Used to negotiate the applicability of the optional features.

UeReachability

3GPP TS 29.518 [10]

Describes the reachability of the UE.

Uri

3GPP TS 29.571 [7]

UserLocation

3GPP TS 29.571 [7]

Identifies the user location.

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

location

UserLocation

O

0..1

Current location for the UE, which can be a combination of E-UTRA, NR and non-3GPP access location.

locationTs

DateTime

O

0..1

Indicates when the location was last updated.

timeZone

TimeZone

O

0..1

Current time zone for the UE.

timeZoneTs

DateTime

O

0..1

Indicates when the timeZone was last updated.

accessType

AccessType

O

0..1

Current access type for the UE (3GPP access or non-3GPP access).

accessTypeTs

DateTime

O

0..1

Indicates when the accessType was last updated.

regStates

array(RmInfo)

O

1..N

Describes the registration management state of the UE.

regStatesTs

DateTime

O

0..1

Indicates when the regStates were last updated.

connStates

array(CmInfo)

O

1..N

Describes the connectivity management state of the UE.

connStatesTs

DateTime

O

0..1

Indicates when the connStates were last updated.

reachabilityStatus

UeReachability

O

0..1

Describes the reachability of the UE.

reachabilityStatusTs

DateTime

O

0..1

Indicates when the reachabilityStatus was last updated.

smsOverNasStatus

SmsSupport

O

0..1

Indicates the supported SMS delivery of the UE.

smsOverNasStatusTs

DateTime

O

0..1

Indicates when thesmsOverNasStatus was last updated.

roamingStatus

boolean

O

0..1

True: The serving PLMN of the UE is different from the HPLMN of the UE;
False: The serving PLMN of the UE is the HPLMN of the UE.

roamingStatusTs

DateTime

O

0..1

Indicates when the roamingStatus was last updated.

currentPlmn

PlmnId

O

0..1

The identity of the PLMN serving the UE.

currentPlmnTs

DateTime

O

0..1

Indicates when the currentPlmn was last updated.

ratTypes

array(RatType)

O

1..N

RAT type(s)

ratTypesTs

DateTime

O

0..1

Indicates when the ratTypes was last updated.

suppFeat

SupportedFeatures

C

0..1

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

Shall be present in the HTTP PUT request/response; or 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.

pduSessionStatus

PduSessionStatus

O

0..1

Status of the PDU session.

pduSessionStatusTs

DateTime

O

0..1

Indicates when the pduSessionStatus was last updated.

dnai

Dnai

O

0..1

DNAI

dnaiTs

DateTime

O

0..1

Indicates when the dnai was last updated.

n6TrafficRoutingInfo

array(RouteToLocation)

O

1..N

N6 traffic routing information.

n6TrafficRoutingInfoTs

DateTime

O

0..1

Indicates when the n6TrafficRoutingInfo was last updated.

ipv4Addr

Ipv4Addr

O

0..1

UE IPv4 address.

ipv6Prefix

array(Ipv6Prefix)

O

1..N

UE IPv6 prefix.

ipv6Addrs

array(Ipv6Addr)

O

1..N

IPv6 addresses.

pduSessType

PduSessionType

O

0..1

PDU session type.

ipAddrTs

DateTime

O

0..1

Indicates when the ipv4Addr and Ipv6Prefix were last updated.

dnn

Dnn

O

0..1

DNN

pduSessionId

PduSessionId

O

0..1

The identifier of a PduSessionManagement resource.

(NOTE 1).

ResourceNotificationExposureDataFix

suppFeat

SupportedFeatures

C

0..1

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

Shall be present in the HTTP PUT request/response; or 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: The "pduSessionId" attribute shall be present when the ResourceNotificationExposureDataFix is supported.

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.

notificationUri

Uri

M

1

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

monitoredResourceUris

array(Uri)

M

1..N

A set of URIs that identify the resources for which a modification triggers a notification.

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.

ueId

VarUeId

O

0..1

User identity of modified data.

accessAndMobilityData

AccessAndMobilityData

O

0..1

Access and Mobility Data for the UE.

pduSessionManagementData

array(PduSessionManagementData)

O

1..N

PDU Session Management Data for one or several PDU sessions of the UE.

delResources

array(Uri)

O

1..N

The resources, as defined in table 7.2.2-1, if removed from UDR and notification on resource data change was requested. It may be present when the ResourceNotificationExposureDataFix is supported (NOTE).

NOTE: When the "delResources" attribute is present, the attributes that correspond with the values included in the "delResources" attribute shall be omitted. I.e., when the "delResources" attribute includes the value "../{ueId}/access-and-mobility-data" the attribute "accessAndMobilityData" shall be omitted, and when the "delResources" attribute includes all the existing "../{ueId}/session-management-data/{pduSessionId}" resource URIs, the attribute "pduSessionManagementData" shall be omitted.

"ACTIVE"

The PDU session is active.

"RELEASED"

The PDU session is released.

Exposure Data Change Notification

{notificationUri}

POST

Exposure Data Change Notification

n/a

array(ExposureDataChangeNotification)

M

1..N

Each element in the array provides the changed exposure data for one user.

n/a

204 No Content

Upon success, an empty response body shall be returned.

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.