ADRF Data Store Records

/data-store-records

GET

Retrieve the stored data or analytics

POST

Create a new Individual Data Store resource.

Individual ADRF Data Store Record

/data-store-records/{storeTransId}

DELETE

Delete an individual ADRF Data Store Record identified by {storeTransId}.

ADRF Data Retrieval Subscriptions

/data-retrieval-subscriptions

POST

Create a new Individual ADRF Data Retrieval Subscription resource.

Individual ADRF Data Retrieval Subscription

/data-retrieval-subscriptions/{subscriptionId}

DELETE

Delete an individual ADRF Data Retrieval Subscription identified by {subscriptionId}.

apiRoot

string

See clause 5.1.1

n/a

NadrfDataStoreRecord

M

1

New individual Data Store Record to be created

NadrfDataStoreRecord

M

1

201 Created

The creation of an Individual Data Store Record resource is confirmed, and a representation of that resource is returned.

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nadrf-datamanagement/<apiVersion>/data-store-records/{storeTransId}

store-trans-id

string

O

0..1

Identifies the "Storage Transaction Identifier" of data store record in ADRF. (NOTE)

fetch-correlation-ids

array(string)

O

1..N

Identifies fetch correlation identifiers received as part of fetch instruction. (NOTE)

NOTE: Either "store-trans-id" or "fetch-correlation-ids" shall be provided.

n/a

NadrfDataStoreRecord

M

1

200 OK

Data Store record.

n/a

204 No Content

If the request ADRF Data Store Record does not exist, the ADRF shall respond with "204 No Content ".

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

apiRoot

string

See clause 5.1.1.

storeTransId

string

Identifies an individual data store record.

n/a

n/a

n/a

204 No Content

The Individual ADRF Data Store Record resource was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual ADRF Data Store Record deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ADRF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual ADRF Data Store Record deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ADRF (service) instance.

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

Location

string

M

1

An alternative URI of the resource located in an alternative ADRF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

An alternative URI of the resource located in an alternative ADRF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

apiRoot

string

See clause 5.1.1

n/a

NadrfDataRetrievalSubscription

M

1

Individual ADRF Data Retrieval Subscription resource to be created.

NadrfDataRetrievalSubscription

M

1

201 Created

The creation of an Individual ADRF Data Retrieval Subscription resource is confirmed and a representation of that resource is returned.

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.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nadrf-datamanagement/<apiVersion>/data-retrieval-subscriptions/{subscriptionId}

apiRoot

string

See clause 5.1.1

subscriptionId

string

Identifies a subscription to the Nadrf_DataManagement service.

n/a

n/a

n/a

204 No Content

The Individual ADRF Data Retrieval Subscription resource was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual ADRF Data Retrieval Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ADRF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual ADRF Data Retrieval Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ADRF (service) instance.

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

Location

string

M

1

An alternative URI of the resource located in an alternative ADRF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

An alternative URI of the resource located in an alternative ADRF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

{apiRoot}/nadrf-datamanagement/<apiVersion>/request-storage-sub

POST

Request the ADRF to create a subscription for data or analytics and then store the received data or analytics in the ADRF.

{apiRoot}/nadrf-datamanagement/<apiVersion>/request-storage-sub-removal

POST

Request the ADRF to remove a subscription for data or analytics.

{apiRoot}/nadrf-datamanagement/<apiVersion>/remove-stored-data-analytics

POST

Request the ADRF to remove already stored data or analytics.

NadrfDataStoreSubscription

M

1

Information about the storage subscription that the ADRF shall create.

NadrfDataStoreSubscriptionRef

M

1

200 OK

Successful request to trigger the creation of a subscription for data or analytics at the ADRF. A reference is provided.

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply.

NadrfDataStoreSubscriptionRef

M

1

Reference used to identify the subscription that the ADRF shall remove.

n/a

204 No Content

Successful request to trigger the removal of a subscription for data or analytics at the ADRF.

NOTE: The manadatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply.

NadrfStoredDataSpec

M

1

Information about the specification of data or analytics stored in ADRF.

n/a

204 No Content

Successful request to remove data or analytics at the ADRF based on a data or analytics specification.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply.

Retrieval Notification

{notificationURI}

POST

Report data or analytics from ADRF.

notificationURI

String formatted as URI with the Callback Uri

NadrfDataRetrievalNotification

M

1

Provides information about observed data or analytics.

n/a

204 No Content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during the retrieval notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during the retrieval notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

DataNotification

5.1.6.2.9

Represents a data subscription notification of one of various possible data sources.

DataSubscription

5.1.6.2.8

Contains information about Data specification.

NadrfDataRetrievalNotification

5.1.6.2.5

Represents a notification that corresponds with an Individual ADRF Data Retrieval Subscription resource.

NadrfDataRetrievalSubscription

5.1.6.2.4

Represents an Individual ADRF Data Retrieval Subscription resource.

NadrfDataStoreRecord

5.1.6.2.2

Represents an Individual ADRF Data Store Record resource.

NadrfDataStoreSubscription

5.1.6.2.3

Contains information to be used by the ADRF to create a Data or Analytics subscription.

NadrfDataStoreSubscriptionRef

5.1.6.2.6

Contains a reference to a request for a Data or Analytics subscription.

NadrfStoredDataSpec

5.1.6.2.7

Contains information about Data or Analytics specification.

AfEventExposureNotif

3GPP TS 29.517 [20]

Represents notifications on AF event(s) that occurred for an Individual AF Event Subscription resource.

AfEventExposureSubsc

3GPP TS 29.517 [20]

Represents AF event subscription.

AmfEventNotification

3GPP TS 29.518 [18]

Represents notifications on AMF event(s) that occurred for an Individual AMF Event Subscription resource.

AmfEventSubscription

3GPP TS 29.518 [18]

Represents AMF event subscription.

DateTime

3GPP TS 29.571 [16]

Identifies the time.

EeSubscription

3GPP TS 29.503 [19]

Represents UDM event subscription.

FetchInstruction

3GPP TS 29.576 [24]

The fetch instruction indicates that the data or analytics can be fetched by the consumer.

FormattingInstruction

3GPP TS 29.574 [23]

DCCF formatting Instructions.

MonitoringReport

3GPP TS 29.503 [19]

UDM Monitoring Report.

NefEventExposureNotif

3GPP TS 29.591 [21]

Represents notifications on network exposure event(s) that occurred for an Individual Network Exposure Event Subscription resource.

NefEventExposureSubsc

3GPP TS 29.591 [21]

Represents NEF event subscription.

NfInstanceId

3GPP TS 29.571 [16]

NF instance identifier.

NfSetId

3GPP TS 29.571 [16]

NF set identifier.

NnwdafEventsSubscription

3GPP TS 29.520 [15]

Represents an NWDAF analytics subscription.

NnwdafEventsSubscriptionNotification

3GPP TS 29.520 [15]

Represents an NWDAF analytics subscription notification.

NotificationData

3GPP TS 29.510 [10]

Represents an NRF event notification.

NsmfEventExposure

3GPP TS 29.508 [17]

Represents SMF event subscription.

NsmfEventExposureNotification

3GPP TS 29.508 [17]

Represents SMF event notification.

ProcessingInstruction

3GPP TS 29.574 [23]

DCCF processing Instructions.

SACEventReport

3GPP TS 29.536 [25]

Represents an NSACF event notification.

SACEventSubscription

3GPP TS 29.536 [25]

Represents and NSACF event subscription.

SubscriptionData

3GPP TS 29.510 [10]

Represents an NRF event subscription.

SupportedFeatures

3GPP TS 29.571 [6]

Used to negotiate the applicability of the optional features defined in table 5.1.8-1.

TimeWindow

3GPP TS 29.122 [22]

Represents a time window.

Uri

3GPP TS 29.571 [16]

URI.

dataNotif

DataNotification

C

0..1

Data subscription notification. (NOTE 1)

anaNotifications

array(NnwdafEventsSubscriptionNotification)

C

1..N

List of analytics subscription notifications. (NOTE 1)

anaSub

NnwdafEventsSubscription

C

0..1

Represents the subscription information of the corresponding analytics notification.

Shall be present if the "anaNotifications" attribute is provided.

(NOTE 2)

dataSub

DataSubscription

C

0..1

Represents the subscription information of the corresponding data notification.

Shall be present if the "dataNotif" attribute is provided.

(NOTE 2)

NOTE 1: Exactly one of the attributes "anaNotifications" and "dataNotif" shall be provided.

NOTE 2: Exactly one of the attributes "anaSub" and "dataSub" shall be provided.

anaSub

NnwdafEventsSubscription

C

0..1

Subscribed analytics events. (NOTE 1)

dataSub

DataSubscription

C

0..1

Represents requested Events subscription.

(NOTE 1)

targetNfId

NfInstanceId

C

0..1

DCCF or NWDAF NF instance identifier to which the ADRF shall create the requested subscription. (NOTE 2)

targetNfSetId

NfSetId

C

0..1

DCCF or NWDAF NF set identifier to which the ADRF shall create the requested subscription. (NOTE 2)

formatInstruct

FormattingInstruction

O

0..1

Formatting instructions to be used for sending event notifications.

procInstruct

ProcessingInstruction

O

0..1

Processing instructions to be used for sending event notifications. (NOTE 3)

multiProcInstructs

array(ProcessingInstruction)

O

1..N

Processing instructions to be used for sending event notifications. (NOTE 3)

MultiProcessingInstruction

suppFeat

SupportedFeatures

C

0..1

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

It shall be present if at least one feature defined in clause 5.1.8 is supported.

NOTE 1: Exactly one of these attributes shall be provided.

NOTE 2: One of "targetNfId" and "targetNfSetId" shall be provided.

NOTE 3: The "multiProcInstructs" attribute shall be used instead of the "procInstruct" attribute when the "MultiProcessingInstruction" feature is supported.

anaSub

NnwdafEventsSubscription

C

0..1

Subscribed analytics events. (NOTE 1)

dataSub

DataSubscription

C

0..1

Represents requested Events subscription.

(NOTE 1)

notificationURI

Uri

M

1

Notification target address.

timePeriod

TimeWindow

M

1

Represents a start time and a stop time during which the requested data is collected and/or will be collected at the data source.

notifCorrId

string

M

1

Notification correlation identifier provided by the NF service consumer to be used later by the ADRF in the notifications that correspond with this subscription. The value of this attribute shall be unique per subscription for a given NF service consumer.

consTrigNotif

boolean

O

0..1

If provided and set to "true", it indicates that notifications shall be buffered (sending only fetch instructions to the NF service consumer) until the NF service consumer requests their delivery using Nadrf_DataManagement Service.

The default value is "false".

NOTE 1: Exactly one of these attributes shall be provided.

notifCorrId

string

M

1

This attribute indicates the notification correlation identifier provided by the NF service consumer during the data retrieval subscription. This parameter can be useful if the NF service consumer uses a common callback URI for multiple subscriptions.

anaNotifications

array(NnwdafEventsSubscriptionNotification)

C

1..N

List of analytics subscription notifications. (NOTE)

dataNotif

DataNotification

C

0..1

Data subscription notification. (NOTE)

fetchInstruct

FetchInstruction

C

0..1

The fetch instruction indicates that the data or analytics can be fetched by the consumer. (NOTE)

terminationReq

boolean

O

0..1

If provided and set to "true", it indicates that the subscription is requested to be terminated, i.e. no further notifications related to this subscription will be provided. The default value is "false".

timeStamp

DateTime

M

1

It represents the time when ADRF completed preparation of the requested data or analytics.

NOTE: Exactly one of these attributes shall be provided.

transRefId

string

M

1

Transaction reference identifier.

suppFeat

SupportedFeatures

C

0..1

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

It shall be present in the POST response if the NF service consumer includes the "suppFeat" attribute in the POST request.

dataSpec

DataSubscription

C

0..1

Represents data specification. (NOTE)

anaSpec

NnwdafEventsSubscription

C

0..1

Represents analytics specification. (NOTE)

timePeriod

TimeWindow

M

1

Represents a start time and a stop time during which the requested data to be removed was collected at the data source.

NOTE: Exactly one of these attributes shall be provided.

amfDataSub

AmfEventSubscription

C

0..1

Represents requested AMF Events subscription.

(NOTE)

smfDataSub

NsmfEventExposure

C

0..1

Represents requested SMF Events subscription.

(NOTE)

udmDataSub

EeSubscription

C

0..1

Represents requested UDM Events subscription.

(NOTE)

nefDataSub

NefEventExposureSubsc

C

0..1

Represents requested NEF Events subscription.

(NOTE)

afDataSub

AfEventExposureSubsc

C

0..1

Represents requested AF Events subscription.

(NOTE)

nrfDataSub

SubscriptionData

C

0..1

Represents requested NRF Events subscription.

(NOTE)

nsacfDataSub

SACEventSubscription

C

0..1

Represents requested NSACF Events subscription.

(NOTE)

NOTE: Exactly one of these attributes shall be provided.

afEventNotifs

array(AfEventExposureNotif)

C

1..N

List of notifications on AF event(s). (NOTE 1)

amfEventNotifs

array(AmfEventNotification)

C

1..N

List of notifications on AMF event(s). (NOTE 1)

smfEventNotifs

array(NsmfEventExposureNotification)

C

1..N

List of notifications on SMF event(s). (NOTE 1)

udmEventNotifs

array(MonitoringReport)

C

1..N

List of monitoring reports containing information about UDM event(s). (NOTE 1)

nefEventNotifs

array(NefEventExposureNotif)

C

1..N

List of notifications on network exposure event(s). (NOTE 1)

nrfEventNotifs

array(NotificationData)

C

1..N

List of notifications on NRF event(s). (NOTE 1)

nsacfEventNotifs

array(SACEventReport)

C

1..N

List of notifications on NSACF event(s). (NOTE 1)

timeStamp

DateTime

O

0..1

Indicates the timestamp for the event(s). (NOTE 2)

NOTE 1: Exactly one of these attributes shall be provided.

NOTE 2: The "timeStamp" attribute within the DataNotification data type may be provided if any of the "timeStamp" attribute within AfEventNotification contained in the AfEventExposureNotif, or within AmfEventReport contained in the AmfEventNotification, or within EventNotification contained in the NsmfEventExposureNotification, or within MonitoringReport, or within NefEventNotification contained in the NefEventExposureNotif or within SACEventReportItem contained in the SACEventReport data type is not provided.

1

MultiProcessingInstruction

Indicates the support of multiple processing instructions.