5.2.18 Resource: EeSubscriptions

29.5053GPP5G SystemRelease 18Stage 3TSUsage of the Unified Data Repository services for Subscription Data

5.2.18.1 Description

This resource represents the collection of EE Subscriptions for a UE.

This resource is modelled with the Collection resource archetype (see clause C.1 of 3GPP TS 29.501 [7]).

5.2.18.2 Resource Definition

Resource URI: {apiRoot}/nudr-dr/<apiVersion>/subscription-data/{ueId}/context-data/ee-subscriptions

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

Table 5.2.18.2-1: Resource URI variables for this resource

Name

Definition

apiRoot

See 3GPP TS 29.504 [2] clause 6.1.1

ueId

Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3]

5.2.18.3 Resource Standard Methods

5.2.18.3.1 GET

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

Table 5.2.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 [8] clause 6.6

event-types

array(EventType)

O

1..N

Indicates only to return the EE subscription data which contains at least one of the indicated Event Types and returned monitoring configuration data in EE subscription data only contains the data related to the indicated event types.

nf-identifiers

array(NfIdentifier)

O

1..N

Indicates to return relevant EE subscription data along with associated Subscription resources created and stored while initiating subscriptions to NFs identified by NfType and NfInstanceId

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

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

Data type

P

Cardinality

Description

n/a

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

Data type

P

Cardinality

Response

codes

Description

array(EeSubscriptionExt)

M

1..N

200 OK

Upon success, a response body containing the individual EE subscriptions shall be returned.

NOTE: In addition common data structures as listed in table 5.5-1 are supported.

5.2.18.3.2 POST

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

Table 5.2.18.3.2-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 5.2.18.3.1-2 and the response data structures and response codes specified in table 5.2.18.3.1-3.

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

Data type

P

Cardinality

Description

EeSubscription

M

1

Identifies the subscriber data subscription to be stored in the UDR.

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

Data type

P

Cardinality

Response

codes

Description

EeSubscription

M

1

201 Created

Upon success, a response body containing a representation of the UeId’s 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: In addition common data structures as listed in table 5.5-1 are supported.