6.1.3 Resources

29.5033GPP5G SystemRelease 18Stage 3TSUnified Data Management Services

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

6.1.3.1 Overview

This clause describes the structure for the Resource URIs and the resources and methods used for the service.

Figure 6.1.3.1-1 depicts the resource URIs structure for the Nudm-SDM API.

Figure 6.1.3.1-1: Resource URI structure of the Nudm-SDM API

Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.

Table 6.1.3.1-1: Resources and methods overview

Resource name (Archetype)	Resource URI	HTTP method or custom operation	Description
Supi (Document)	/{supi}	GET	Retrieve multiple data sets from UE’s subscription data
Nssai (Document)	/{supi}/nssai	GET	Retrieve the UE’s subscribed Network Slice Selection Assistance Information
UeContextInAmfData (Document)	/{supi}/ue-context-in-amf-data	GET	Retrieve the UE’s Context in AMF Data
AccessAndMobilitySubscriptionData (Document)	/{supi}/am-data	GET	Retrieve the UE’s subscribed Access and Mobility Data
AccessAndMobilitySubscriptionData (Document)	/{supi}/am-data/update-sor	update-sor (POST)	Trigger the update of Steering of Roaming Information at the UE
SorAck (Document)	/{supi}/am-data/sor-ack	PUT	Providing acknowledgement of Steering of Roaming
UpuAck (Document)	/{supi}/am-data/upu-ack	PUT	Providing acknowledgement of UE parameters update
CagAck (Document)	/{supi}/am-data/cag-ack	PUT	Providing acknowledgement of UE CAG configuration update
EnhancedCoverageRestrictionData	/{supi}/am-data/ecr-data	GET	Retrieve the UE’s subscribed Enhance Coverage Restriction Data
SmfSelectionSubscriptionData (Document)	/{supi}/smf-select-data	GET	Retrieve the UE’s subscribed SMF Selection Data
UeContextInSmfData (Document)	/{supi}/ue-context-in-smf-data	GET	Retrieve the UE’s Context in SMF Data
SessionManagementSubscriptionData (Document)	/{supi}/sm-data	GET	Retrieve the UE’s session management subscription data
SMSSubscriptionData (Document)	/{supi}/sms-data	GET	Retrieve the UE’s SMS subscription data
SMSManagementSubscriptionData (Document)	/{supi}/sms-mng-data	GET	Retrieve the UE’s SMS management subscription data
LcsPrivacySubscriptionData (Document)	/{ueId}/lcs-privacy-data	GET	Retrieve the UE’s LCS privacy subscription data
LcsMobileOriginatedSubscriptionData (Document)	/{supi}/lcs-mo-data	GET	Retrieve the UE’s LCS Mobile Originated subscription data
LcsBroadcastAssistanceSubscriptionData (Document)	/{supi}/lcs-bca-data	GET	Retrieve the UE’s LCS Broadcast Assistance subscription data
ProseSubscriptionData (Document)	/{supi}/prose-data	GET	Retrieve the UE’s ProSe subscription data
V2xSubscriptionData (Document)	/{supi}/v2x-data	GET	Retrieve the UE’s V2X subscription data
MbsSubscriptionData (Document)	/{supi}/mbs-data	GET	Retrieve the UE’s 5MBS subscription data
UcSubscriptionData (Document)	/{supi}/uc-data	GET	Retrieve the UE’s User Consent subscription data
SdmSubscriptions (Collection)	/{ueId}/sdm-subscriptions	POST	Create a subscription
Individual subscription (Document)	/{ueId}/sdm-subscriptions/{subscriptionId}	DELETE	Delete the subscription identified by {subscriptionId}, i.e. unsubscribe
Individual subscription (Document)	/{ueId}/sdm-subscriptions/{subscriptionId}	PATCH	Modify the sdm-subscription identified by {subscriptionId}
IdTranslationResult (Document)	/{ueId}/id-translation-result	GET	Retrieve a UE’s SUPI or GPSI
UeContextInSmsfData (Document)	/{supi}/ue-context-in-smsf-data	GET	Retrieve the UE’s Context in SMSF Data
TraceData (Document)	/{supi}/trace-data	GET	Retrieve Trace Configuration Data
SharedData (Collection)	/shared-data	GET	Retrieve shared data
IndividualSharedData (Document)	/shared-data/{sharedDataId}	GET	Retrieve the individual Shared Data
SharedDataSubscriptions (Collection)	/shared-data-subscriptions	POST	Create a subscription
SharedDataIndividual subscription (Document)	/shared-data-subscriptions/{subscriptionId}	DELETE	Delete the subscription identified by {subscriptionId}, i.e. unsubscribe
SharedDataIndividual subscription (Document)	/shared-data-subscriptions/{subscriptionId}	PATCH	Modify the shared data subscription identified by {subscriptionId}
GroupIdentifiers (Document)	/group-data/group-identifiers	GET	Retrieve group identifiers and the UE identifiers belong to the group identifiers.
SnssaisAck (Document)	/{supi}/am-data/subscribed-snssais-ack	PUT	Providing acknowledgement of UE for subscribed S-NSSAIs
MultipleIdentifiers (Document)	/multiple-identifiers	GET	Retrieve SUPIs belong to the GPSIs.

6.1.3.2 Resource: Nssai (Document)

6.1.3.2.1 Description

This resource represents the subscribed Nssai for a SUPI. It is queried by the AMF before registering, and is used to assist network slice selection. See 5.2.2.2.2 and 3GPP TS 23.501 [2] clause 5.15.3.

This resource is also queried by the PGW-C+SMF during PDN connection establishment in the EPC, and is used to select the S-NSSAI provided to the UE, see 3GPP TS 23.502 [3] clause 4.11.0a.5. The PGW-C+SMF shall not indicate support to "Nssaa" feature (see clause 6.1.8) in this query to UDM. If a slice is not present in the Nssai resource returned by UDM, i.e. not subscribed by the UE or subject to Network Slice-Specific Authentication and Authorization, the slice shall not be selected by the PGW-C+SMF.

6.1.3.2.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/nssai

This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.

Table 6.1.3.2.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.2.3 Resource Standard Methods

6.1.3.2.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.

Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
plmn-id	PlmnId	O	0..1	PLMN identity of the PLMN serving the UE
disaster-roaming-ind	boolean	O	0..1	Disaster Roaming Indicator (see 3GPP TS 23.502 [3]). When present, this IE shall be set as follows: – true: Disaster Roaming service is applied; – false (default): Disaster Roaming service is not applied.

If "plmn-id" is included, UDM shall return the Subscribed S-NSSAIs which the UE is subscribed to use in the PLMN identified by "plmn-id".

If "plmn-id" is not included, UDM shall return the Subscribed S-NSSAIs for HPLMN.

This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.

Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
Nssai	M	1	200 OK	Upon success, a response body containing the NSSAI shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.2.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.2.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.3 Resource: SdmSubscriptions (Collection)

6.1.3.3.1 Description

This resource is used to represent subscriptions to notifications.

The UDM will only recognize subscribed DNNs in this resource so for instance, if the SMF receives SessionManagementSubscriptionData for the Wildcard DNN, SMF shall include the wildcard DNN in SdmSubscription. Any request for non-subscribed DNN will be rejected with "404 Not Found".

6.1.3.3.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{ueId}/sdm-subscriptions

This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.

Table 6.1.3.3.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
ueId	VarUeId	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) or Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

6.1.3.3.3 Resource Standard Methods

6.1.3.3.3.1 POST

This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1.

Table 6.1.3.3.3.1-1: URI query parameters supported by the POST method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3.

Table 6.1.3.3.3.1-2: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
SdmSubscription	M	1	The subscription that is to be created.

Table 6.1.3.3.3.1-3: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SdmSubscription	M	1	201 Created	Upon success, a response body containing a representation of the created Individual subscription resource shall be returned including the accepted values, e.g. in case of partial success UDM shall return the list of monitores resource Uri successfully subscribed. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. When stateless UDM is deployed, the stateless UDM may use an FQDN identifying the UDM group to which the UDM belongs as the host part of the resource URI.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors:: – USER_NOT_FOUND
ProblemDetails	O	0..1	501 Not Implemented	The "cause" attribute may be used to indicate one of the following application errors: – UNSUPPORTED_RESOURCE_URI This response shall not be cached.
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

NOTE: In the scenario of stateless UDM deployment, it is assumed that stateless UDMs are organized into several UDM groups, and for each UDM group an FQDN can be allocated.

Table 6.1.3.3.3.1-4: Headers supported by the 201 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm/<apiVersion>/{ueId}/sdm-subscriptions/{subscriptionId}

6.1.3.4 Resource: Individual subscription (Document)

6.1.3.4.1 Description

This resource is used to represent an individual subscription to notifications.

6.1.3.4.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{ueId}/sdm-subscriptions/{subscriptionId}

This resource shall support the resource URI variables defined in table 6.1.3.4.2-1.

Table 6.1.3.4.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
ueId	VarUeId	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) or Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]
subscriptionId	string	The subscriptionId identifies an individual subscription to notifications.

6.1.3.4.3 Resource Standard Methods

6.1.3.4.3.1 DELETE

This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1.

Table 6.1.3.4.3.1-1: URI query parameters supported by the DELETE method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3.

Table 6.1.3.4.3.1-2: Data structures supported by the Delete Request Body on this resource

Data type	P	Cardinality	Description
n/a			The request body shall be empty.

Table 6.1.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource

Data type		P	Cardinality		Response codes	Description
n/a					204 No Content	Upon success, an empty response body shall be returned.
ProblemDetails	O		0..1	404 Not Found		The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.4.3.2 PATCH

This method shall support the URI query parameters specified in table 6.1.3.4.3.2-1.

Table 6.1.3.4.3.2-1: URI query parameters supported by the PATCH method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.4.3.2-2 and the response data structures and response codes specified in table 6.1.3.4.3.2-3.

Table 6.1.3.4.3.2-2: Data structures supported by the PATCH Request Body on this resource

Data type	P	Cardinality	Description
SdmSubsModification	M	1	The modification Instruction

Table 6.1.3.4.3.2-3: Data structures supported by the PATCH Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SdmSubscription	C	0..1	200 OK	Upon partial success, if any of the requested modifications have not been accepted, but the server has set different values than those requested by the client, in any of the attributes of the resource, the modified SdmSubscription shall be returned including the accepted values, e.g. UDM shall return the list of monitored resource Uri successfully subscribed and/or the confirmed expiry time. Also, upon partial success, if the NF service consumer does not support the "PatchReport" feature, the UDM shall return an SdmSubscription object in the response. (NOTE 2)
PatchResult	C	0..1	200 OK	Upon partial success, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature, and in case some of the requested modifications are discarded while the rest of the modification instructions are fully accepted, UDM may return the execution report instead of the whole SdmSubscription. (NOTE 2)
n/a			204 No Content	Upon success, an empty response body shall be returned. (NOTE 2)
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
ProblemDetails	O	0..1	403 Forbidden	One or more attributes are not allowed to be modified. The "cause" attribute may be used to indicate one of the following application errors: – MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. NOTE 2: One of SdmSubscription or PatchResult shall be returned.

6.1.3.5 Resource: AccessAndMobilitySubscriptionData (Document)

6.1.3.5.1 Description

This resource represents the subscribed Access and Mobility Data for a SUPI. It is queried by the AMF after registering.

6.1.3.5.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/am-data

This resource shall support the resource URI variables defined in table 6.1.3.5.2-1.

Table 6.1.3.5.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.5.3 Resource Standard Methods

6.1.3.5.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1.

Table 6.1.3.5.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
plmn-id	PlmnIdNid	O	0..1	PLMN identity of the PLMN serving the UE
adjacent-plmns	array(PlmnId)	O	1..N	PLMN identities of PLMNs adjacent to the PLMN serving the UE. If present the GET response may contain adjacentPlmnRestrictions for the indicated PLMNs.
disaster-roaming-ind	boolean	O	0..1	Disaster Roaming Indicator (see 3GPP TS 23.502 [3]). When present, this IE shall be set as follows: – true: Disaster Roaming service is applied; – false (default): Disaster Roaming service is not applied.

If "plmn-id" is included, UDM shall return the Access and Mobility Data for the SUPI associated to the PLMN or SNPN identified by "plmn-id".

If "plmn-id" is not included, UDM shall return the Access and Mobility Data for the SUPI associated to the HPLMN.

This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3.

Table 6.1.3.5.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.5.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
AccessAndMobilitySubscriptionData	M	1	200 OK	Upon success, a response body containing the Access and Mobility Subscription Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.5.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.5.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.5.4 Resource Custom Operations

6.1.3.5.4.1 Overview

Table 6.1.3.5.4.1-1: Custom operations

Operation Name	Custom operation URI	Mapped HTTP method	Description
update-sor	/{supi}/am-data/update-sor	POST	Trigger the update of Steering of Roaming information at the UE

6.1.3.5.4.2 Operation: update-sor

6.1.3.5.4.2.1 Description

When a UE performs initial registration or emergency registration at an AMF (which already has AccessAndMobilitySubscriptionData stored) within a VPLMN, and the sorUpdateIndicatorList is present in AccessAndMobilitySubscriptionData and contains the corresponding registration type, the AMF shall make use of this operation to trigger the HPLMN to update steering of roaming information for the UE.

6.1.3.5.4.2.2 Operation Definition

This operation shall support the request data structures specified in table 6.1.3.5.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.5.4.2.2-2.

Table 6.1.3.5.4.2.2-1: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
SorUpdateInfo	M	1	Contains the ID of the VPLMN

Table 6.1.3.5.4.2.2-2: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality			Response codes	Description
SorInfo	M	1			200 OK	Upon success, a response body containing the updated Steering Of Roaming information shall be returned.
ProblemDetails	O		0..1	404 Not Found		The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND
NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

6.1.3.6 Resource: SmfSelectionSubscriptionData (Document)

6.1.3.6.1 Description

This resource represents the subscribed SMF Selection Data for a SUPI. It is queried by the AMF after registering.

6.1.3.6.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/smf-select-data

This resource shall support the resource URI variables defined in table 6.1.3.6.2-1.

Table 6.1.3.6.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.6.3 Resource Standard Methods

6.1.3.6.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.6.3.1-1.

Table 6.1.3.6.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
plmn-id	PlmnId	O	0..1	PLMN identity of the PLMN serving the UE
disaster-roaming-ind	boolean	O	0..1	Disaster Roaming Indicator (see 3GPP TS 23.502 [3]). When present, this IE shall be set as follows: – true: Disaster Roaming service is applied; – false (default): Disaster Roaming service is not applied.

If "plmn-id" is included, UDM shall return the SMF Selection Subscription Data for the SUPI associated to the PLMN identified by "plmn-id".

If "plmn-id" is not included, UDM shall return the SMF Selection Subscription Data for the SUPI associated to the HPLMN.

This method shall support the request data structures specified in table 6.1.3.6.3.1-2 and the response data structures and response codes specified in table 6.1.3.6.3.1-3.

Table 6.1.3.6.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.6.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SmfSelectionSubscriptionData	M	1	200 OK	Upon success, a response body containing the SMF Selection Subscription Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.6.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.6.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.7 Resource: UeContextInSmfData (Document)

6.1.3.7.1 Description

This resource represents the allocated SMFs for a SUPI. It is queried by the AMF after registering.

6.1.3.7.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/ue-context-in-smf-data

This resource shall support the resource URI variables defined in table 6.1.3.7.2-1.

Table 6.1.3.7.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.7.3 Resource Standard Methods

6.1.3.7.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.7.3.1-1.

Table 6.1.3.7.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.7.3.1-2 and the response data structures and response codes specified in table 6.1.3.7.3.1-3.

Table 6.1.3.7.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.7.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
UeContextInSmfData	M	1	200 OK	Upon success, a response body containing the UeContextInSmfData shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.8 Resource: SessionManagementSubscriptionData (Document)

6.1.3.8.1 Description

This resource represents the Session Management subscription data for a SUPI. It is queried by the SMF during session setup, using query parameters representing the selected network slice and the DNN. The SMF is responsible for enforcing the user session management subscription data.

UDM will only recognize subscribed DNNs in this resource so for instance, in case SMF receives indication from AMF that the DNN was authorized based on the wildcard APN in the Selection Mode Value, SMF shall include the wildcard DNN in the query parameter and SMF will receive SessionManagementSubscriptionData for the Wildcard DNN. Any request for non-subscribed DNN will be rejected with "404 Not Found".

This resource is also queried by the PGW-C+SMF during PDN connection establishment in the EPC, to select the S-NSSAI for the APN/DNN of the PDN connection, see 3GPP TS 23.502 [3] clause 4.11.0a.5.

NOTE : The PGW-C+SMF shall also retrieve the Nssai resource from UDM, to avoid selection a slice that is subject to Network Slice-Specific Authentication and Authorization (see clause 6.1.3.2.1).

6.1.3.8.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/sm-data

This resource shall support the resource URI variables defined in table 6.1.3.8.2-1.

Table 6.1.3.8.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.8.3 Resource Standard Methods

6.1.3.8.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.8.3.1-1.

Table 6.1.3.8.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
single-nssai	Snssai	O	0..1	When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter.
dnn	Dnn	O	0..1	The DNN shall be the DNN Network Identifier only.
plmn-id	PlmnId	O	0..1	PLMN identity of the PLMN serving the UE

JSON objects (such as Snssai, PlmnId…) shall be included directly as part of the URI query parameters by specifying in the OpenAPI file that the "Content-Type" of such parameters is "application/json".

If "singleNssai" is not included, and "dnn" is not included, UDM shall return all DNN configurations for all network slice(s).

If "singleNssai" is included, and "dnn" is not included, UDM shall return all DNN configurations for the requested network slice identified by "singleNssai".

If "singleNssai" is not included, and "dnn" is included, UDM shall return all DNN configurations identified by "dnn" for all network slices where such DNN is available.

If "singleNssai" is included, and "dnn" is included, UDM shall return the DNN configuration identified by "dnn", if such DNN is available in the network slice identified by "singleNssai".

For all the combinations about the inclusion of "dnn" and "singleNssai" as URI query parameters, if "plmn-id" is included, UDM shall return the configurations for the DNN and network slices associated to the PLMN identified by "plmn-id". Otherwise (i.e. if "plmn-id" is not included), UDM shall return the configurations for the DNN and network slices associated to the HPLMN.

This method shall support the request data structures specified in table 6.1.3.8.3.1-2 and the response data structures and response codes specified in table 6.1.3.8.3.1-3.

Table 6.1.3.8.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.8.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SmSubsData	M	1	200 OK	Upon success, a response body containing the Session Management Subscription data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.8.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.8.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.9 Resource: SMSSubscriptionData (Document)

6.1.3.9.1 Description

This resource represents the subscribed SMS Subscription Data for a SUPI. It is queried by the AMF after registering.

6.1.3.9.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/sms-data

This resource shall support the resource URI variables defined in table 6.1.3.9.2-1.

Table 6.1.3.9.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.9.3 Resource Standard Methods

6.1.3.9.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.9.3.1-1.

Table 6.1.3.9.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
plmn-id	PlmnId	C	0..1	if absent, H-PLMN ID is used as default
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.9.3.1-2 and the response data structures and response codes specified in table 6.1.3.9.3.1-3.

Table 6.1.3.9.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.9.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SmsSubscriptionData	M	1	200 OK	Upon success, a response body containing the SMS Subscription Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.9.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.9.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.10 Resource: SMSManagementSubscriptionData (Document)

6.1.3.10.1 Description

This resource represents the subscribed SMS Management Data for a SUPI. It is queried by the SMSF after registering.

6.1.3.10.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/sms-mng-data

This resource shall support the resource URI variables defined in table 6.1.3.10.2-1.

Table 6.1.3.10.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.10.3 Resource Standard Methods

6.1.3.10.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.10.3.1-1.

Table 6.1.3.10.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
plmn-id	PlmnId	C	0..1	if absent, H-PLMN ID is used as default
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.10.3.1-2 and the response data structures and response codes specified in table 6.1.3.10.3.1-3.

Table 6.1.3.10.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.10.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SmsManagementSubscriptionData	M	1	200 OK	Upon success, a response body containing the SMS Management Subscription Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.10.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.10.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.11 Resource: Supi (Document)

6.1.3.11.1 Description

This resource represents the subscription profile of the subscriber identified by a given SUPI.

6.1.3.11.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}

This resource shall support the resource URI variables defined in table 6.1.3.11.2-1.

Table 6.1.3.11.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.11.3 Resource Standard Methods

6.1.3.11.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.11.3.1-1.

NOTE: The retrieval of these data sets can also be achieved by sending individual GET requests to the corresponding sub-resources under the {supi} resource. When multiple data sets need to be retrieved by the NF Service consumer, it is recommended to use a single GET request with query parameters rather than issuing multiple GET requests.

Table 6.1.3.11.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
dataset-names	DatasetNames	M	1	Contains names of the data sets that are required to retrieve.
plmn-id	PlmnIdNid	C	0..1	If absent, H-PLMN ID is used as default. This IE is only used for data sets whose DataSetNames are listed below: "AM" "SMF_SEL" "SMS_SUB" "SM" "TRACE" "SMS_MNG"
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.11.3.1-2 and the response data structures and response codes specified in table 6.1.3.11.3.1-3.

Table 6.1.3.11.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.11.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SubscriptionDataSets	M	1	200 OK	Upon success, a response body containing the requested data sets shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Table 6.1.3.11.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.11.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.12 Resource: IdTranslationResult (Document)

6.1.3.12.1 Description

This resource represents the SUPI or GPSI. It is queried by the NEF for GPSI to SUPI translation or SUPI to GPSI translation. See 3GPP TS 23.502 [3] clauses 4.13.2.2, 4.13.7.2 and 4.15.6.8.

6.1.3.12.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{ueId}/id-translation-result

This resource shall support the resource URI variables defined in table 6.1.3.12.2-1.

Table 6.1.3.12.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
ueId	VarUeId	Represents the Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8) or Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]

6.1.3.12.3 Resource Standard Methods

6.1.3.12.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.12.3.1-1.

Table 6.1.3.12.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
af-id	string	O	0..1	AF Identifier, see 3GPP TS 23.502 [3] clause 4.13.2.2 and clause 4.13.7.2 If not present, additional authorization on AF indentifier is not required (see 3GPP TS 23.502 [3] clause 4.15.6.8)
app-port-id	AppPortId	C	0..1	Indicates the Application port identity, see 3GPP TS 23.501 [2] clause 4.4.7 or 3GPP TS 23.502 [3] clause 4.13.7.2. This attribute shall be present if ueId is a SUPI in Resource URI variables and if the application port identity is available.
af-service-id	string	C	0..1	Indicates the Application Service Identifier, see 3GPP TS 23.502 [3] clause 4.15.z. This attribute shall be present if ueid is a SUPI in Resouce URI variables and if the application service identifier is available.
mtc-provider-info	MtcProviderInformation	C	0..1	Indicates the information of MTC Service Provider and/or MTC Application. This attribute shall be present if ueid is a SUPI in Resource URI variables and if the MTC provider information is available.
requested-gpsi-type	GpsiType	C	0..1	Indicates the requested GPSI type, and it may be included when the ueId variable in the resource URI is a SUPI. If the ueId variable in the resource URI is a GPSI, this parameter should not be included (i.e., in that case, the UDM returns the GPSI type that was not used in ueId, if available).

This method shall support the request data structures specified in table 6.1.3.12.3.1-2 and the response data structures and response codes specified in table 6.1.3.12.3.1-3.

Table 6.1.3.12.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.12.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P		Cardinality		Response codes		Description
IdTranslationResult	M		1		200 OK		Upon success, a response body containing the SUPI and optionally the MSISDN shall be returned.
ProblemDetails	O		0..1		404 Not Found		The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
ProblemDetails		O		0..1		403 Forbidden		The "cause" attribute may be used to indicate one of the following application errors: – AF_NOT_ALLOWED
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.12.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.12.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.13 Resource: SorAck (Document)

6.1.3.13.1 Description

This resource represents the acknowledgement of the SoR for a SUPI.

6.1.3.13.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/am-data/sor-ack

This resource shall support the resource URI variables defined in table 6.1.3.13.2-1.

Table 6.1.3.13.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.13.3 Resource Standard Methods

6.1.3.13.3.1 PUT

This method shall support the URI query parameters specified in table 6.1.3.13.3.1-1.

Table 6.1.3.13.3.1-1: URI query parameters supported by the PUT method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.13.3.1-2 and the response data structures and response codes specified in table 6.1.3.13.3.1-3.

Table 6.1.3.13.3.1-2: Data structures supported by the PUT Request Body on this resource

Data type	P	Cardinality	Description
AcknowledgeInfo	M	1	Contains the SOR-MAC-Iue received from the UE.

Table 6.1.3.13.3.1-3: Data structures supported by the PUT Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Successful receiving the SorXmacIue in the Request.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate 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 [4] are supported.

6.1.3.14 Resource: TraceData (Document)

6.1.3.14.1 Description

This resource represents the trace configuration data for a SUPI. It is queried by the AMF and SMF after registering.

6.1.3.14.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/trace-data

This resource shall support the resource URI variables defined in table 6.1.3.14.2-1.

Table 6.1.3.14.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.14.3 Resource Standard Methods

6.1.3.14.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.14.3.1-1.

Table 6.1.3.14.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
plmn-id	PlmnId	O	0..1	PLMN identity of the PLMN serving the UE

If "plmn-id" is included, UDM shall return the Trace Data for the SUPI associated to the PLMN identified by "plmn-id".

If "plmn-id" is not included, UDM shall return the Trace Data for the SUPI associated to the HPLMN.

This method shall support the request data structures specified in table 6.1.3.14.3.1-2 and the response data structures and response codes specified in table 6.1.3.14.3.1-3.

Table 6.1.3.14.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.14.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
TraceDataResponse	M	1	200 OK	Upon success, a response body containing the Trace Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.14.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.14.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.15 Resource: SharedData (Collection)

6.1.3.15.1 Description

This resource represents the collection of data that can be shared by multiple UEs.

6.1.3.15.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/shared-data

This resource shall support the resource URI variables defined in table 6.1.3.15.2-1.

Table 6.1.3.15.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1

6.1.3.15.3 Resource Standard Methods

6.1.3.15.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.15.3.1-1.

Table 6.1.3.15.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
shared-data-ids	array(SharedDataId)	M	1..N	Contains unique items
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.15.3.1-2 and the response data structures and response codes specified in table 6.1.3.15.3.1-3.

Table 6.1.3.15.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.15.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
array(SharedData)	M	0..N	200 OK	Upon success, a response body containing a list of SharedData shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.15.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.15.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.16 Resource: SharedDataSubscriptions (Collection)

6.1.3.16.1 Description

This resource is used to represent subscriptions to notifications for shared data.

6.1.3.16.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/shared-data-subscriptions

This resource shall support the resource URI variables defined in table 6.1.3.16.2-1.

Table 6.1.3.16.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1

6.1.3.16.3 Resource Standard Methods

6.1.3.16.3.1 POST

This method shall support the URI query parameters specified in table 6.1.3.16.3.1-1.

Table 6.1.3.16.3.1-1: URI query parameters supported by the POST method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.16.3.1-2 and the response data structures and response codes specified in table 6.1.3.16.3.1-3.

Table 6.1.3.16.3.1-2: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
SdmSubscription	M	1	The subscription that is to be created.

Table 6.1.3.16.3.1-3: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SdmSubscription	M	1	201 Created	Upon success, a response body containing a representation of the created Individual subscription resource shall be returned. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. When stateless UDM is deployed, the stateless UDM shall use the FQDN identifying the UDM set to which the UDM belongs as the host part of the resource URI.
ProblemDetails	O	0..1	501 Not Implemented	The "cause" attribute may be used to indicate one of the following application errors: – UNSUPPORTED_RESOURCE_URI This response shall not be cached.
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

NOTE: In the scenario of stateless UDM deployment, it is assumed that stateless UDMs are organized into several UDM sets, and each UDM set is allocated an FQDN.

Table 6.1.3.16.3.1-4: Headers supported by the 201 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm/<apiVersion>/shared-data-subscriptions/{subscriptionId}

6.1.3.17 Resource: Individual subscription (Document)

6.1.3.17.1 Description

This resource is used to represent an individual subscription to notifications for shared data.

6.1.3.17.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/shared-data-subscriptions/{subscriptionId}

This resource shall support the resource URI variables defined in table 6.1.3.17.2-1.

Table 6.1.3.17.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
subscriptionId	string	The subscriptionId identifies an individual subscription to notifications.

6.1.3.17.3 Resource Standard Methods

6.1.3.17.3.1 DELETE

This method shall support the URI query parameters specified in table 6.1.3.17.3.1-1.

Table 6.1.3.17.3.1-1: URI query parameters supported by the DELETE method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.17.3.1-2 and the response data structures and response codes specified in table 6.1.3.17.3.1-3.

Table 6.1.3.17.3.1-2: Data structures supported by the Delete Request Body on this resource

Data type	P	Cardinality	Description
n/a			The request body shall be empty.

Table 6.1.3.17.3.1-3: Data structures supported by the DELETE Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Upon success, an empty response body shall be returned.
ProblemDetails	O	0..1	404 Not Found	The resource corresponding to the SubscriptionId can’t be found. The "cause" attribute may be used to indicate one of the following application errors:: – SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.17.3.2 PATCH

This method shall support the URI query parameters specified in table 6.1.3.17.3.2-1.

Table 6.1.3.17.3.2-1: URI query parameters supported by the PATCH method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.17.3.2-2 and the response data structures and response codes specified in table 6.1.3.17.3.2-3.

Table 6.1.3.17.3.2-2: Data structures supported by the PATCH Request Body on this resource

Data type	P	Cardinality	Description
SdmSubsModification	M	1	The modification Instruction

Table 6.1.3.17.3.2-3: Data structures supported by the PATCH Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SdmSubscription	C	0..1	200 OK	Upon partial success, if any of the requested modifications have not been accepted, but the server has set different values than those requested by the client, in any of the attributes of the resource,the modified SdmSubscription shall be returned including the accepted values, e.g. UDM shall return the list of monitored resource Uri successfully subscribed and/or the confirmed expiry time. Also, upon partial success, if the NF service consumer does not support the "PatchReport" feature, the UDM shall return an SdmSubscription object in the response. (NOTE 2)
PatchResult	C	0..1	200 OK	Upon partial success, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature, and in case some of the requested modifications are discarded while the rest of the modification instructions are fully accepted, UDM may return the execution report instead of the whole SdmSubscription. (NOTE 2)
n/a			204 No Content	Upon success, an empty response body shall be returned. (NOTE 2)
ProblemDetails	O	0..1	404 Not Found	The resource corresponding to the SubscriptionId can’t be found. The "cause" attribute may be used to indicate one of the following application errors: – SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
ProblemDetails	O	0..1	403 Forbidden	One or more attributes are not allowed to be modified. The "cause" attribute may be used to indicate one of the following application errors: – MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. NOTE 2: One of SdmSubscription or PatchResult shall be returned.

6.1.3.18 Resource: UeContextInSmsfData (Document)

6.1.3.18.1 Description

This resource represents the allocated SMSFs for a SUPI.

6.1.3.18.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/ue-context-in-smsf-data

This resource shall support the resource URI variables defined in table 6.1.3.18.2-1.

Table 6.1.3.18.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.18.3 Resource Standard Methods

6.1.3.18.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.18.3.1-1.

Table 6.1.3.18.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.18.3.1-2 and the response data structures and response codes specified in table 6.1.3.18.3.1-3.

Table 6.1.3.18.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.18.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
UeContextInSmsfData	M	1	200 OK	Upon success, a response body containing the UeContextInSmsfData shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.19 Resource: UpuAck (Document)

6.1.3.19.1 Description

This resource represents the acknowledgement of UE parameters update for a SUPI.

6.1.3.19.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/am-data/upu-ack

This resource shall support the resource URI variables defined in table 6.1.3.19.2-1.

Table 6.1.3.19.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.19.3 Resource Standard Methods

6.1.3.19.3.1 PUT

This method shall support the URI query parameters specified in table 6.1.3.19.3.1-1.

Table 6.1.3.19.3.1-1: URI query parameters supported by the PUT method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.19.3.1-2 and the response data structures and response codes specified in table 6.1.3.19.3.1-3.

Table 6.1.3.19.3.1-2: Data structures supported by the PUT Request Body on this resource

Data type	P	Cardinality	Description
AcknowledgeInfo	M	1	Contains the UPU-MAC-Iue received from the UE and the provisioning time stamp as received within UpuInfo.

Table 6.1.3.19.3.1-3: Data structures supported by the PUT Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Successful receiving the UpuXmacIue in the Request.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND
NOTE: The manadatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

6.1.3.20 Resource: GroupIdentifiers (Document)

6.1.3.20.1 Description

This resource represents the Group Identifiers handled by UDM/UDR. It is queried by the NEF or GMLC for translation between External and Internal Group Identifiers or query the UE identifiers that belong to the provided External or Internal Group Identifier.

It is also queried by the TSCTSF for the SUPI(s) that belong to the provided External or Internal Group Identifier.

6.1.3.20.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/group-data/group-identifiers

This resource shall support the resource URI variables defined in table 6.1.3.20.2-1.

Table 6.1.3.20.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1

6.1.3.20.3 Resource Standard Methods

6.1.3.20.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.20.3.1-1.

Table 6.1.3.20.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
af-id	string	O	0..1	AF Identifier, see 3GPP TS 23.502 [3] clause 4.13.2.2 and clause 4.13.7.2 If not present, additional authorization on AF indentifier is not required (see 3GPP TS 23.502 [3] clause 4.15.6.8)
ext-groud-id	ExtGroupId	C	0..1	External Group ID
int-group-id	GroupId	C	0..1	Internal Group ID
ue-id-ind	boolean	C	0..1	Indication whether UE identifiers are required or not. When present, it shall be set as following: – true: UE identifiers are required – false (default): UE identifiers are not required
NOTE: Either ext-group-id or int-group-id shall be present in the request.

This method shall support the request data structures specified in table 6.1.3.20.3.1-2 and the response data structures and response codes specified in table 6.1.3.20.3.1-3.

Table 6.1.3.20.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.20.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
GroupIdentifiers	M	1	200 OK	Upon success, a response body containing the group identifier(s) shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – GROUP_IDENTIFIER_NOT_FOUND – DATA_NOT_FOUND
ProblemDetails	O	0..1	403 Forbidden	The "cause" attribute may be used to indicate one of the following application errors: – AF_NOT_ALLOWED
NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.20.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.20.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2

6.1.3.21 Resource: SnssaisAck (Document)

6.1.3.21.1 Description

This resource represents the acknowledgement of UE for subscribed S-NSSAIs update for a SUPI.

6.1.3.21.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/am-data/subscribed-snssais-ack

This resource shall support the resource URI variables defined in table 6.1.3.21.2-1.

Table 6.1.3.21.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.21.3 Resource Standard Methods

6.1.3.21.3.1 PUT

This method shall support the URI query parameters specified in table 6.1.3.21.3.1-1.

Table 6.1.3.21.3.1-1: URI query parameters supported by the PUT method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.21.3.1-2 and the response data structures and response codes specified in table 6.1.3.21.3.1-3.

Table 6.1.3.21.3.1-2: Data structures supported by the PUT Request Body on this resource

Data type	P	Cardinality	Description
AcknowledgeInfo	M	1	Contains the provisioning time stamp as received within the Nssai.

Table 6.1.3.21.3.1-3: Data structures supported by the PUT Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Successful receiving the UE acknowledgement for subscribed S-NSSAIs update.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate 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 [4] are supported.

6.1.3.22 Resource: CagAck (Document)

6.1.3.22.1 Description

This resource represents the acknowledgement of UE for CAG update for a SUPI.

6.1.3.22.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/am-data/cag-ack

This resource shall support the resource URI variables defined in table 6.1.3.22.2-1.

Table 6.1.3.22.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.22.3 Resource Standard Methods

6.1.3.22.3.1 PUT

This method shall support the URI query parameters specified in table 6.1.3.22.3.1-1.

Table 6.1.3..3.1-1: URI query parameters supported by the PUT method on this resource

Name	Data type	P	Cardinality	Description
n/a

This method shall support the request data structures specified in table 6.1.3.22.3.1-2 and the response data structures and response codes specified in table 6.1.3.22.3.1-3.

Table 6.1.3.22.3.1-2: Data structures supported by the PUT Request Body on this resource

Data type	P	Cardinality	Description
AcknowledgeInfo	M	1	Contains the provisioning time stamp as received within the CagInfo.

Table 6.1.3.22.3.1-3: Data structures supported by the PUT Response Body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Successful receiving the UE acknowledgement for CAG configuration update.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate 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 [4] are supported.

6.1.3.23 Resource: LcsPrivacySubscriptionData (Document)

6.1.3.23.1 Description

This resource represents the subscribed LCS Privacy Data for a UE. It is queried by the HGMLC or NEF.

6.1.3.23.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{ueId}/lcs-privacy-data

This resource shall support the resource URI variables defined in table 6.1.3.23.2-1.

Table 6.1.3.23.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
ueId	VarUeId	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) or Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7].
NOTE: SUPI is only used to retrieve Location Privacy profile by GMLC.

6.1.3.23.3 Resource Standard Methods

6.1.3.23.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.23.3.1-1.

Table 6.1.3.23.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

UDM shall return the LCS Privacy Data for the UE identified by the ueId.

This method shall support the request data structures specified in table 6.1.3.23.3.1-2 and the response data structures and response codes specified in table 6.1.3.23.3.1-3.

Table 6.1.3.23.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.23.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
LcsPrivacyData	M	1	200 OK	Upon success, a response body containing the LCS Privacy Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 5.4.2)
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.24 Resource: LcsMobileOriginatedSubscriptionData (Document)

6.1.3.24.1 Description

This resource represents the subscribed LCS Mobile Originated Data for a SUPI. It is queried by the AMF after registering.

6.1.3.24.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/lcs-mo-data

This resource shall support the resource URI variables defined in table 6.1.3.24.2-1.

Table 6.1.3.24.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.24.3 Resource Standard Methods

6.1.3.24.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.24.3.1-1.

Table 6.1.3.24.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

UDM shall return the LCS Mobile Originated Data for the SUPI.

This method shall support the request data structures specified in table 6.1.3.24.3.1-2 and the response data structures and response codes specified in table 6.1.3.24.3.1-3.

Table 6.1.3.24.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.24.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
LcsMoData	M	1	200 OK	Upon success, a response body containing the LCS Mobile Originated Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 5.4.2)
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.25 Resource: EnhancedCoverageRestrictionData

6.1.3.25.1 Description

This resource represents the subscribed Enhance Coverage Restriction Data for a SUPI.

6.1.3.25.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/am-data/ecr-data

This resource shall support the resource URI variables defined in table 6.1.3.25.2-1.

Table 6.1.3.25.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.25.3 Resource Standard Methods

6.1.3.25.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.25.3.1-1.

Table 6.1.3.25.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.25.3.1-2 and the response data structures and response codes specified in table 6.1.3.25.3.1-3.

Table 6.1.3.25.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.25.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
EnhancedCoverageRestrictionData	M	1	200 OK	Upon success, a response body containing the Access and Mobility Subscription Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.26 Resource: UeContextInAmfData (Document)

6.1.3.26.1 Description

This resource represents the allocated AMF for a SUPI.

6.1.3.26.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/ue-context-in-amf-data

This resource shall support the resource URI variables defined in table 6.1.3.26.2-1.

Table 6.1.3.26.2-1: Resource URI variables for this resource

Name	Definition
apiRoot	See clause 6.1.1
supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.26.3 Resource Standard Methods

6.1.3.26.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.26.3.1-1.

Table 6.1.3.26.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.26.3.1-2 and the response data structures and response codes specified in table 6.1.3.26.3.1-3.

Table 6.1.3.26.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.26.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
UeContextInAmfData	M	1	200 OK	Upon success, a response body containing the UeContextInAmfData shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.27 Resource: V2xSubscriptionData (Document)

6.1.3.27.1 Description

This resource represents the subscribed V2X Data for a SUPI. It is queried by the AMF after registering.

6.1.3.27.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/v2x-data

This resource shall support the resource URI variables defined in table 6.1.3.27.2-1.

Table 6.1.3.27.2-1: Resource URI variables for this resource

Name	Definition
apiRoot	See clause 6.1.1
supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.27.3 Resource Standard Methods

6.1.3.27.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.27.3.1-1.

Table 6.1.3.27.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.27.3.1-2 and the response data structures and response codes specified in table 6.1.3.27.3.1-3.

Table 6.1.3.27.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.27.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
V2xSubscriptionData	M	1	200 OK	Upon success, a response body containing the V2X Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 5.4.2)
ProblemDetails	O	1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.28 Resource: LcsBroadcastAssistanceSubscriptionData (Document)

6.1.3.28.1 Description

This resource represents the subscribed LCS Broadcast Assistance Data Types for a SUPI. It is queried by the AMF.

6.1.3.28.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/lcs-bca-data

This resource shall support the resource URI variables defined in table 6.1.3.28.2-1.

Table 6.1.3.28.2-1: Resource URI variables for this resource

Name	Definition
apiRoot	See clause 6.1.1
supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.28.3 Resource Standard Methods

6.1.3.28.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.28.3.1-1.

Table 6.1.3.28.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
plmn-id	PlmnId	O	0..1	PLMN identity of the PLMN serving the UE

If "plmn-id" is included, the UDM shall return the LCS Broadcast Assistance Data Types for the SUPI associated to the PLMN identified by "plmn-id".

If "plmn-id" is not included, the UDM shall return the LCS Broadcast Assistance Data Types for the SUPI associated to the HPLMN.

This method shall support the request data structures specified in table 6.1.3.28.3.1-2 and the response data structures and response codes specified in table 6.1.3.28.3.1-3.

Table 6.1.3.28.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.28.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
LcsBroadcastAssistanceTypesData	M	1	200 OK	Upon success, a response body containing the list of Broadcast Assistance Data Types Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 7.1)
ProblemDetails	O	1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.29 Resource: IndividualSharedData (Document)

6.1.3.29.1 Description

This resource represents the individual Shared Data.

6.1.3.29.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/shared-data/{sharedDataId}

This resource shall support the resource URI variables defined in table 6.1.3.29.2-1.

Table 6.1.3.29.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
sharedDataId	SharedDataId	Contains the individual Shared Data Identifier.

6.1.3.29.3 Resource Standard Methods

6.1.3.29.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.29.3.1-1.

Table 6.1.3.29.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

This method shall support the request data structures specified in table 6.1.3.29.3.1-2 and the response data structures and response codes specified in table 6.1.3.29.3.1-3.

Table 6.1.3.29.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.29.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
SharedData	M	1	200 OK	Upon success, a response body containing the individual Shared Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.30 Resource: ProseSubscriptionData (Document)

6.1.3.30.1 Description

This resource represents the subscribed ProSe Data for a UE. It is queried by the 5G DDNMF.

6.1.3.30.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/prose-data

This resource shall support the resource URI variables defined in table 6.1.3.30.2-1.

Table 6.1.3.30.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.30.3 Resource Standard Methods

6.1.3.30.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.30.3.1-1.

Table 6.1.3.30.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

UDM shall return the ProSe Data for the UE identified by the supi.

This method shall support the request data structures specified in table 6.1.3.30.3.1-2 and the response data structures and response codes specified in table 6.1.3.30.3.1-3.

Table 6.1.3.30.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.30.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
ProseSubscriptionData	M	1	200 OK	Upon success, a response body containing the ProSe Subscription Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.31 Resource: MbsSubscriptionData (Document)

6.1.3.31.1 Description

This resource represents the subscribed 5MBS Data for a UE as defined in clause 6.4.2 of 3GPP TS 23.247 [59]. It is queried by the SMF.

6.1.3.31.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/mbs-data

This resource shall support the resource URI variables defined in table 6.1.3.31.2-1.

Table 6.1.3.31.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.31.3 Resource Standard Methods

6.1.3.31.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.31.3.1-1.

Table 6.1.3.31.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6

UDM shall return the 5MBS Subscription Data for the UE identified by the supi.

This method shall support the request data structures specified in table 6.1.3.31.3.1-2 and the response data structures and response codes specified in table 6.1.3.31.3.1-3.

Table 6.1.3.31.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.31.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
MbsSubscriptionData	M	1	200 OK	Upon success, a response body containing the 5MBS Subscription Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.32 Resource: UcSubscriptionData (Document)

6.1.3.32.1 Description

This resource represents the subscribed User Consent Data for a UE as defined in Annex V.2 of 3GPP TS 33.501 [6], clause 5.1.3 of 3GPP TS 33.558 [63] and clause 6.2 of 3GPP TS 23.288 [35]. It is queried by the NWDAF, DCCF, NEF and trusted AF (e.g. EES).

6.1.3.32.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/{supi}/uc-data

This resource shall support the resource URI variables defined in table 6.1.3.32.2-1.

Table 6.1.3.32.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1
supi	Supi	Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7]

6.1.3.32.3 Resource Standard Methods

6.1.3.32.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.32.3.1-1.

Table 6.1.3.32.3.1-1: URI query parameters supported by the GET method on this resource

Name

Data type

Cardinality

Description

supported-features

SupportedFeatures

0..1

see 3GPP TS 29.500 [4] clause 6.6

uc-purpose

UcPurpose

0..1

Contains a user consent purpose.

See clause 6.1.6.3.20.

UDM shall return the User Consent Subscription Data for the UE identified by the supi.

This method shall support the request data structures specified in table 6.1.3.32.3.1-2 and the response data structures and response codes specified in table 6.1.3.32.3.1-3.

Table 6.1.3.32.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.32.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
UcSubscriptionData	M	1	200 OK	Upon success, a response body containing the User Consent Subscription Data shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

6.1.3.33 Resource: MultipleIdentifiers (Document)

6.1.3.33.1 Description

This resource represents the Multiple Identifiers handled by UDM. It is queried by the TSCTSF for translation from list of GPSIs to the list of SUPIs.

6.1.3.33.2 Resource Definition

Resource URI: {apiRoot}/nudm-sdm/<apiVersion>/multiple-identifiers

This resource shall support the resource URI variables defined in table 6.1.3.33.2-1.

Table 6.1.3.33.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 6.1.1

6.1.3.33.3 Resource Standard Methods

6.1.3.33.3.1 GET

This method shall support the URI query parameters specified in table 6.1.3.33.3.1-1.

Table 6.1.3.33.3.1-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
supported-features	SupportedFeatures	O	0..1	see 3GPP TS 29.500 [4] clause 6.6
gpsi-list	array(Gpsi)	M	1..N	List of GPSIs.

This method shall support the request data structures specified in table 6.1.3.33.3.1-2 and the response data structures and response codes specified in table 6.1.3.33.3.1-3.

Table 6.1.3.33.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 6.1.3.33.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
UeIdentifiers	M	1	200 OK	Upon success, a response body containing the list of UE identifier(s) shall be returned.
ProblemDetails	O	0..1	404 Not Found	The "cause" attribute may be used to indicate one of the following application errors: – USER_NOT_FOUND – DATA_NOT_FOUND
NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.

Table 6.1.3.33.3.1-4: Headers supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
If-None-Match	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.2
If-Modified-Since	string	O	0..1	Validator for conditional requests, as described in IETF RFC 7232 [25], clause 3.3

Table 6.1.3.33.3.1-5: Headers supported by the 200 Response Code on this resource

Name	Data type	P	Cardinality	Description
Cache-Control	string	O	0..1	Cache-Control containing max-age, as described in IETF RFC 7234 [26], clause 5.2
ETag	string	O	0..1	Entity Tag, containing a strong validator, as described in IETF RFC 7232 [25], clause 2.3
Last-Modified	string	O	0..1	Timestamp for last modification of the resource, as described in IETF RFC 7232 [25], clause 2.2