DCCF Analytics Subscriptions

/analytics-subscriptions

POST

Creates a new Individual DCCF Analytics Subscription resource.

Individual DCCF Analytics Subscription

/analytics-subscriptions/{subscriptionId}

PUT

Modifies an existing Individual DCCF Analytics Subscription resource.

DELETE

Deletes an Individual DCCF Analytics Subscription identified by {subscriptionId}.

DCCF Data Subscriptions

/data-subscriptions

POST

Creates a new Individual DCCF Data Subscription resource.

Individual DCCF Data Subscription

/data-subscriptions/{subscriptionId}

PUT

Modifies an existing DCCF Data Subscription resource.

DELETE

Deletes an Individual DCCF Data Subscription identified by {subscriptionId}.

apiRoot

string

See clause 5.1.1

n/a

NdccfAnalyticsSubscription

M

1

New Individual DCCF Analytics Subscription resource to be created.

NdccfAnalyticsSubscription

M

1

201 Created

The creation of an Individual DCCF Analytics Subscription resource is confirmed and a representation of that resource is returned.

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.1.7.

Location

string

M

1

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

apiRoot

string

See clause 5.1.1

subscriptionId

string

Identifies an analytics subscription to the Ndccf_DataManagement Service

n/a

NdccfAnalyticsSubscription

M

1

Parameters to replace a subscription to DCCF Analytics Subscription resource.

NdccfAnalyticsSubscription

M

1

200 OK

The Individual DCCF Analytics Subscription resource was modified successfully and a representation of that resource is returned.

n/a

204 No Content

The Individual DCCF Analytics Subscription resource was modified successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

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

RedirectResponse

O

0..1

308 Permanent Redirect

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

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.1.7.

Location

string

M

1

An alternative URI of the resource located in an alternative DCCF (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 DCCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

n/a

n/a

n/a

204 No Content

The Individual DCCF Analytics Subscription resource was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

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

RedirectResponse

O

0..1

308 Permanent Redirect

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

NOTE: The mandatory 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 DCCF (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 DCCF (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

NdccfDataSubscription

M

1

Individual DCCF Data Subscription resource to be created.

NdccfDataSubscription

M

1

201 Created

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

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.1.7.

Location

string

M

1

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

apiRoot

string

See clause 5.1.1

subscriptionId

string

Identifies a data subscription to the Ndccf_DataManagement Service

n/a

NdccfDataSubscription

M

1

Parameters to replace a subscription to DCCF Data Subscription resource.

NdccfDataSubscription

M

1

200 OK

The Individual DCCF Data Subscription resource was modified successfully and a representation of that resource is returned.

n/a

204 No Content

The Individual DCCF Data Subscription resource was modified successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

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

RedirectResponse

O

0..1

308 Permanent Redirect

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

ProblemDetails

O

0..1

400 Bad Request

(NOTE 2)

ProblemDetails

O

0..1

403 Forbidden

(NOTE 2)

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

NOTE 2: Failure cases are described in clause 5.1.7.

Location

string

M

1

An alternative URI of the resource located in an alternative DCCF (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 DCCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

n/a

n/a

n/a

204 No Content

The Individual DCCF Data Subscription resource was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

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

RedirectResponse

O

0..1

308 Permanent Redirect

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

NOTE: The mandatory 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 DCCF (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 DCCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Analytics Event Notification

{anaNotifUri}

POST

Report one or several observed analytics events.

Data Event Notification

{dataNotifUri}

POST

Report one or several observed data collection events.

Fetch Notification

{fetchUri}

POST

Fetch one or several notified data or analytics.

anaNotifUri

String formatted as URI with the Callback Uri.

The Callback Uri is assigned within the Individual DCCF Analytics Subscription resource and described within the NdccfAnalyticsSubscription type (see table 5.1.6.2.2-1).

NdccfAnalyticsSubscriptionNotification

M

1

Provides information about observed analytics events

n/a

204 No Content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during the analytics event 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 analytics event 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.

dataNotifUri

String formatted as URI with the Callback Uri.

The Callback Uri is assigned within the Individual DCCF Data Subscription resource and described within the NdccfDataSubscription type (see table 5.1.6.3.2-1).

NdccfDataSubscriptionNotification

M

1

Provides Information about observed data collection events.

n/a

204 No Content

The receipt of the notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during the data event 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 data event 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.

fetchUri

Uri

Fetch Uri as assigned during the procedure of notification about the subscribed data or analytics within the FetchInstruction data type.

n/a

array(string)

M

1..N

Indicate the fetch correlation identifier(s).

NdccfAnalyticsSubscriptionNotification

C

0..1

200 OK

The stored analytics related to the fetch correlation identifier(s).

(NOTE 2)

NdccfDataSubscriptionNotification

C

0..1

200 OK

The stored data related to the fetch correlation identifier(s).

(NOTE 2)

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative DCCF.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative DCCF.

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

NOTE 2: In case of a 200 OK response, one of NdccfAnalyticsSubscriptionNotification data structure and NdccfDataSubscriptionNotification data structure shall be included, depending on if the Fetch Notification included fetch correlation identifiers from an analytics notification or from a data notification.

Location

string

M

1

An alternative URI of the resource located in an alternative DCCF.

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

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

AggregationLevel

5.1.6.3.4

Contains an aggregation level for processing instructions (e.g. per UE, per Area of Interest).

DataCollectionPurpose

5.1.6.3.5

Represents the purpose for data collection.

DccfEvent

5.1.6.2.13

Represents the event type exposed by DCCF

EventParamReport

5.1.6.2.10

Represents a summarized report for one event parameter.

FormattingInstruction

5.1.6.2.6

Contains data or analytics formatting Instructions.

NdccfAnalyticsSubscription

5.1.6.2.2

Represents an Individual DCCF Analytics Subscription resource.

NdccfAnalyticsSubscriptionNotification

5.1.6.2.4

Represents a notification that corresponds with an Individual DCCF Analytics Subscription resource.

NdccfDataSubscription

5.1.6.2.3

Represents an Individual DCCF Data Subscription resource.

NdccfDataSubscriptionNotification

5.1.6.2.5

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

NotifSummaryReport

5.1.6.2.9

Represents summarized notifications based on processing instructions.

ParameterProcessingInstruction

5.1.6.2.8

Contains an event parameter name and the respective event parameter values and sets of attributes to be used in summarized reports.

ProcessingInstruction

5.1.6.2.7

Contains instructions related to the processing (e.g. clubbing) of notifications.

ReportingOptions

5.1.6.2.11

Represents reporting options for notifications that are processed.

SummarizationAttribute

5.1.6.3.3

Represents attribute in the summarized report.

AfEvent

3GPP TS 29.517 [21]

Represents an AF Event id

AmfEventType

3GPP TS 29.518 [19]

Represents an AMF Event id

DataSubscription

3GPP TS 29.575 [25]

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

DataNotification

3GPP TS 29.575 [25]

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

DateTime

3GPP TS 29.571 [17]

Identifies the time.

DurationSec

3GPP TS 29.571 [17]

Time in seconds.

EventType

3GPP TS 29.503 [20]

Represents an UDM Event id

FetchInstruction

3GPP TS 29.576 [26]

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

NefEvent

3GPP TS 29.591 [22]

Represents a NEF Event id

NetworkAreaInfo

3GPP TS 29.554 [28]

Identifies a network area.

NfInstanceId

3GPP TS 29.571 [17]

NF instance identifier.

NfSetId

3GPP TS 29.571 [17]

NF set identifier.

NnwdafEventsSubscription

3GPP TS 29.520 [15]

Represents a NWDAF analytics subscription.

NnwdafEventsSubscriptionNotification

3GPP TS 29.520 [15]

Represents a NWDAF analytics subscription notification.

NumberAverage

3GPP TS 29.520 [15]

Represents average and variance of a parameter value.

SACEvent

3GPP TS 29.536 [27]

Represents a NSAC Event id

SmfEvent

3GPP TS 29.508 [18]

Represents a SMF Event id

Supi

3GPP TS 29.571 [17]

Contains a SUPI.

SupportedFeatures

3GPP TS 29.571 [17]

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

TimeWindow

3GPP TS 29.122 [23]

Represents a time window.

Uinteger

3GPP TS 29.571 [17]

Unsigned Integer.

Uri

3GPP TS 29.571 [17]

URI.

anaSub

NnwdafEventsSubscription

M

1

Subscribed analytics events. (NOTE 1)

anaNotifUri

Uri

M

1

Notification target address.

anaNotifCorrId

string

M

1

Notification correlation identifier.

formatInstruct

FormattingInstruction

O

0..1

Formatting instructions to be used for sending event notifications.

procInstructs

array(ProcessingInstruction)

O

1..N

Processing instructions to be used for sending event notifications.

targetNfId

NfInstanceId

O

0..1

NF instance identifier to which the DCCF shall create the requested subscription. (NOTE 3)

targetNfSetId

NfSetId

O

0..1

NF set identifier to which the DCCF shall create the requested subscription.

(NOTE 3)

adrfId

NfInstanceId

O

0..1

Identifier of the ADRF to be used by the DCCF.

If the subscription is for runtime analytics (i.e. the "timePeriod" attribute is either absent or contains a time window in the future) then the DCCF shall store the notifications in this ADRF.

If the subscription is for historical analytics (i.e. the "timePeriod" attribute contains a time window in the past) then the DCCF shall retrieve the data from this ADRF. (NOTE 3)

adrfSetId

NfSetId

O

0..1

Identifier of the ADRF Set to be used by the DCCF.

If the subscription is for runtime analytics (i.e. the "timePeriod" attribute is either absent or contains a time window in the future) then the DCCF shall store the notifications in this ADRF Set.

If the subscription is for historical analytics (i.e. the "timePeriod" attribute contains a time window in the past) then the DCCF shall retrieve the data from this ADRF Set. (NOTE 3)

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.

timePeriod

TimeWindow

O

0..1

Represents a start time and a stop time during which the analytics was performed or is requested to be performed. If this attribute is provided, then the attribute "monDur" within the reporting information of the attribute "anaSub" shall not be provided.

(NOTE 2)

dataCollectPurposes

array(DataCollectionPurpose)

O

1..N

The purposes of data collection. This attribute may only be provided if user consent is required depending on local policy and regulations and the consumer has not checked user consent.

checkedConsentInd

boolean

O

0..1

If set to "true", it indicates that the NF service consumer has already checked the user consent. The default value is "false".

UserConsent

suppFeat

SupportedFeatures

C

0..1

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

It shall be present in the POST request if at least one feature defined in clause 5.1.8 is supported, and it shall be present in the POST response if the NF service consumer included the"suppFeat" attribute in the POST request.

NOTE 1: The "notificationURI" and "notifCorreId" attributes of NnwdafEventsSubscription data type shall be ignored by the DCCF. The DCCF will provide the notification target address and the notification correlation ID of the DCCF itself in the NnwdafEventsSubscription data type during the event subscription request to the NWDAF.

NOTE 2: It includes the time period either in the past or in the future (i.e., start time as past time and stop time as future time is not allowed).

NOTE 3: "targetNfId" and "targetNfSetId" are mutually exclusive. "adrfId" and "adrfSetId" are also mutually exclusive.

dataSub

DataSubscription

M

1

Represents the requested events subscription.

(NOTE 1)

dataNotifUri

Uri

M

1

Notification target address.

dataNotifCorrId

string

M

1

Notification correlation identifier.

formatInstruct

FormattingInstruction

O

0..1

Formatting instructions to be used for sending event notifications.

procInstructs

array(ProcessingInstruction)

O

1..N

Processing instructions to be used for sending event notifications.

targetNfId

NfInstanceId

O

0..1

Data Producer NF instance identifier to which the DCCF shall create the requested subscription. (NOTE 3)

targetNfSetId

NfSetId

O

0..1

Data Producer NF set identifier to which the DCCF shall create the requested subscription. (NOTE 3)

adrfId

NfInstanceId

O

0..1

Identifier of the ADRF to be used by the DCCF.

If the subscription is for runtime data (i.e. the "timePeriod" attribute is either absent or contains a time window in the future) then the DCCF shall store the notifications in this ADRF.

If the subscription is for historical data (i.e. the "timePeriod" attribute contains a time window in the past) then the DCCF shall retrieve the data from this ADRF. (NOTE 3)

adrfSetId

NfSetId

O

0..1

Identifier of the ADRF Set to be used by the DCCF.

If the subscription is for runtime data (i.e. the "timePeriod" attribute is either absent or contains a time window in the future) then the DCCF shall store the notifications in this ADRF Set.

If the subscription is for historical data (i.e. the "timePeriod" attribute contains a time window in the past) then the DCCF shall retrieve the data from this ADRF Set. (NOTE 3)

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.

timePeriod

TimeWindow

O

0..1

Represents a start time and a stop time during which data was collected or is requested to be collected. If this attribute is included, then the internal attributes of the data subscription that indicate a subscription duration (e.g. the "targetPeriod" attribute of an "eventSubs" attribute of an "smfDataSub" attribute, or the "monDur" attribute of the ReportingInformation data type) shall not be provided.

(NOTE 2)

dataCollectPurposes

array(DataCollectionPurpose)

O

1..N

The purposes of data collection. This attribute may only be provided if user consent is required depending on local policy and regulations and the consumer has not checked user consent.

checkedConsentInd

boolean

O

0..1

If set to "true", it indicates that the NF service consumer has already checked the user consent. The default value is "false".

UserConsent

suppFeat

SupportedFeatures

C

0..1

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

It shall be present in the POST request if at least one feature defined in clause 5.1.8 is supported, and it shall be present in the POST response if the NF service consumer included the"suppFeat" attribute in the POST request.

NOTE 1: The notification target address contained in the subscription attribute that is provided within the "dataSub" attribute (i.e. "eventNotifyUri" of "amfDataSub", "notifUri" of "smfDataSub", "callbackReference" of "udmDataSub", "notifUri" of "nefDataSub", "notifUri" of "afDataSub", "nfStatusNotificationUri" of "nrfDataSub", or "eventNotifyUri" of "nsacfDataSub") and the notification correlation ID contained in the subscription attribute that is provided within the "dataSub" attribute (i.e. the "notifyCorrelationId" of "amfDataSub", "notifId" of "smfDataSub", "notifyCorrelationId" of "udmDataSub", "notifId" of "nefDataSub", "notifId" of "afDataSub", or "notifyCorrelationId" of "nsacfDataSub") shall be ignored by the DCCF. The DCCF will provide the notification target address and the notification correlation ID of the DCCF itself in the data type during the event subscription request to each NF.

NOTE 2: It includes the time period either in the past or in the future (i.e., start time as past time and stop time as future time is not allowed).

NOTE 3: "targetNfId" and "targetNfSetId" are mutually exclusive. "adrfId" and "adrfSetId" are also mutually exclusive.

anaNotifications

array(NnwdafEventsSubscriptionNotification)

C

1..N

List of analytics subscription notifications. (NOTE 1, NOTE 3)

anaReports

array(NotifSummaryReport)

C

1..N

List of reports with summarized data from multiple analytics notifications that the DCCF has received from NWDAF. (NOTE 1)

fetchInstruct

FetchInstruction

C

0..1

Instructions for the NF service consumer to fetch the notifications itself. (NOTE 1, NOTE 2)

anaNotifCorrId

string

M

1

Notification correlation identifier.

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 DCCF completed preparation of the requested analytics. (NOTE 3)

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

NOTE 2: The "fetchInstruct" attribute shall not be included in Ndccf_DataManagement_Fetch response body.

NOTE 3: If the DCCF has received the notifications from another source without a timestamp, then the DCCF adds itself a timestamp based on the time it received the notification in "timeStampGen" attribute contained in "dataNotification" attribute within the EventNotification data type in the NnwdafEventsSubscriptionNotification data type.

dataNotif

DataNotification

C

0..1

Data subscription notification. (NOTE 1, NOTE 3)

dataReports

array(NotifSummaryReport)

C

1..N

List of reports with summarized data from multiple notifications received from data producer. (NOTE 1)

fetchInstruct

FetchInstruction

C

0..1

Instructions for the NF service consumer to fetch the notifications itself. (NOTE 1, NOTE 2)

dataNotifCorrId

string

M

1

Notification correlation identifier.

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 DCCF completed preparation of the requested analytics. (NOTE 3)

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

NOTE 2: The "fetchInstruct" attribute shall not be included in the response body of a Fetch operation.

NOTE 3: If the DCCF has received the notifications from another source without a timestamp, then the DCCF adds itself a timestamp based on the time it received the notification in the "timeStamp" attribute within the DataNotification data type.

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 Ndccf_DataManagement or Nmfaf_3caDataManagement Service.

The default value is "false".

reportingOptions

ReportingOptions

O

0..1

This attribute is provided if the NF service consumer requires clubbing of notifications and its contents describe how the notifications shall be clubbed, i.e. when they should be sent.

eventId

DccfEvent

M

1

Identifies the (event exposure or analytics) event that the processing instructions apply to.

procInterval

DurationSec

M

1

Indicates the interval (in seconds) over which the processing of data for inclusion in each notification sent to consumers shall occur.

paramProcInstructs

array(ParameterProcessingInstruction)

O

1..N

List of event parameter name(s), and for each event parameter name, respective event parameter values and sets of the attributes to be used in the summarized reports.

name

string

M

1

This attribute contains a JSON pointer value (as defined in IETF RFC 6901 [24]) that references an attribute, i.e. a target location, within the notification object (e.g. of NefEventExposureNotif, AfEventExposureNotif, AmfEventNotification, NsmfEventExposureNotification, MonitoringReport, NotificationData, or SACEventReport data type) to which the processing instruction is applied.

values

array(Any type)

M

1..N

A list of values for the attribute identified by the "name" attribute, which shall be matched with values contained in the notifications received and summarized by the DCCF.

The data type of the elements of the list shall be the same as the type of the attribute identified by the "name" attribute.

sumAttrs

array(SummarizationAttribute)

M

1..N

Attributes requested to be used in the summarized reports.

aggrLevel

AggregationLevel

O

0..1

Indicates the aggregation level to which the processing instructions shall apply.

supis

array(Supi)

O

1..N

Indicates the UEs for which processed reports are requested. It may be provided only if "aggrLevel" is provided and is set to the value "UE".

areas

array(NetworkAreaInfo)

C

1..N

Indicates the Areas of Interest for which processed reports are requested. It shall be provided only if "aggrLevel" is provided and is set to the value "AOI".

eventId

DccfEvent

M

1

Identifies the (event exposure or analytics) event that this report applies to.

procInterval

DurationSec

M

1

Indicates the interval (in seconds) over which the processing of data for inclusion in this report occurred.

eventReports

array(EventParamReport)

M

1..N

List of event parameter reports.

name

string

M

1

The name of the reported parameter.

values

array(Any type)

M

1..N

The list of values of the reported parameter.

supi

Supi

C

0..1

Indicates the UE that this report is for. It shall be provided if the "aggrLevel" of the instructions had the value "UE".

area

NetworkAreaInfo

C

0..1

Indicates the Area of Interest that this report is for. It shall be provided if the "aggrLevel" of the instructions had the value "AOI".

spacing

NumberAverage

C

0..1

Contains the average and variance of the time interval separating two consecutive occurrences of the same event and parameter value. It shall be provided if available and the "SPACING" value was contained in the "paramProcInstructs" attribute of the instructions.

duration

NumberAverage

C

0..1

Contains the average and variance of time for which the parameter value applies. It shall be provided if available and the "DURATION" value was contained in the "paramProcInstructs" attribute of the instructions.

count

Uinteger

C

0..1

Represents the number of countable occurrences for the parameter. It shall be provided if available and the "OCCURRENCES" value was contained in the "paramProcInstructs" attribute of the instructions.

avgAndVar

NumberAverage

C

0..1

Contains the average and variance of the parameter value. It shall be provided if available and the "AVG_VAR" value was contained in the "paramProcInstructs" attribute of the instructions.

mostFreqVal

Any type

C

0..1

Contains the most frequent value among the elements of the reported "values" attribute. It shall be provided if available and the "FREQ_VAL" value was contained in the "paramProcInstructs" attribute of the instructions.

leastFreqVal

Any type

C

0..1

Contains the least frequent value among the elements of the reported "values" attribute. It shall be provided if available and the "FREQ_VAL" value was contained in the "paramProcInstructs" attribute of the instructions.

minValue

string

C

0..1

Identifies the minimum value of the parameter. It shall be provided if available and the "MIN_MAX" value was contained in the "paramProcInstructs" attribute of the instructions.

maxValue

string

C

0..1

Identifies the maximum value of the parameter. It shall be provided if available and the "MIN_MAX" value was contained in the "paramProcInstructs" attribute of the instructions.

notifyWindow

TimeWindow

C

0..1

Represents a start time and a stop time during which notifications shall be sent. (NOTE)

notifyPeriod

DurationSec

C

0..1

Indicates the period (in seconds) with which notifications are sent to the consumer, irrespective of whether the event occurs (e.g. every 30 minutes). (NOTE)

notifyPeriodInc

DurationSec

C

0..1

Indicates the time interval (in seconds) between the first two notifications (where the first one is sent upon event occurrence), and that the time interval between subsequent notifications shall be increased each time by the value of this attribute. (NOTE)

depEventSubId

string

C

0..1

Notifications for the present subscription are sent only upon occurrence of events of the subscription with identifier that matches this attribute. (NOTE)

minClubbedNotif

Uinteger

O

0..1

Indicates the minimum number of clubbed notifications.

maxClubbedNotif

Uinteger

O

0..1

Indicates the maximum number of clubbed notifications.

NOTE: Exactly one of these attributes shall be provided.

nwdafEvent

NwdafEvent

C

0..1

Identifies the (event exposure or analytics) NWDAF event ID that the processing instructions apply to. (NOTE)

smfEvent

SmfEvent

C

0..1

Identifies the (event exposure or analytics) SMF event ID that the processing instructions apply to. (NOTE)

amfEvent

AmfEventType

C

0..1

Identifies the (event exposure or analytics) AMF event ID that the processing instructions apply to. (NOTE)

nefEvent

NefEvent

C

0..1

Identifies the (event exposure or analytics) NEF event ID that the processing instructions apply to. (NOTE)

udmEvent

EventType

C

0..1

Identifies the (event exposure or analytics) UDM event ID that the processing instructions apply to. (NOTE)

afEvent

AfEvent

C

0..1

Identifies the (event exposure or analytics) AF event ID that the processing instructions apply to. (NOTE)

sacEvent

SACEvent

C

0..1

Identifies the (event exposure or analytics) NSACF event ID that the processing instructions apply to. (NOTE)

nrfEvent

NotificationEventType

C

0..1

Identifies the (event exposure or analytics) NRF event ID that the processing instructions apply to. (NOTE)

NOTE: Exactly one of these attributes shall be provided.

n/a

SPACING

Average and variance of the time interval separating two consecutive occurrences of the same event and parameter value, or periodicity for periodic reporting.

DURATION

Average and variance of the time for which the parameter value applies.

OCCURRENCES

Number of countable occurrences for the parameter.

AVG_VAR

Average and variance of the parameter.

FREQ_VAL

Most and least frequent values.

MIN_MAX

Maximum and minimum parameter values.

UE

Indicates that the summarized reports shall be provided per UE.

AOI

Indicates that the summarized reports shall be provided per Area of Interest.

ANALYTICS_GENERATION

The data is collected for generating the analytics.

MODEL_TRAINING

The data is collected for ML model training.

SUBSCRIPTION_CANNOT_BE_SERVED

400 Bad Request

Indicates that the DCCF cannot use the contents of the request to either a) determine whether the subscription can already be served or interactions with the NWDAF and/or ADRF are required or b) determine what interactions with the NWDAF and/or ADRF are required (if it has determined that they are required).

USER_CONSENT_NOT_GRANTED

403 Forbidden

Indicates that the request shall be rejected because an impacted user consent is not granted.

1

UserConsent

Indicates the support of detailed handling of user consent, e.g. indications that user consent has been checked and error responses related to the user consent is not granted.

DCCF Data Collection Profiles

/data-collection-profiles

POST

Creates a new Individual DCCF Data Collection Profile resource.

Individual DCCF Data Collection Profile

/data-collection-profiles/{profileId}

PUT

Modifies an existing Individual DCCF Data Collection Profile resource.

DELETE

Deletes an Individual DCCF Data Collection Profile identified by {profileId}.

apiRoot

string

See clause 5.2.1

n/a

NdccfDataCollectionProfile

M

1

New Individual DCCF Data Collection Profile resource to be created

NdccfDataCollectionProfile

M

1

201 Created

The creation of an Individual DCCF Data Collection Profile resource is confirmed and a representation of that resource is returned.

NOTE: The mandatory 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}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles/{profileId}

apiRoot

string

See clause 5.1.1

profileId

string

Identifies a data collection profile to the Ndccf_ContextManagement Service

n/a

NdccfDataCollectionProfile

M

1

Parameters to replace Individual DCCF Data Collection Profile resource.

NdccfDataCollectionProfile

M

1

200 OK

The Individual DCCF Data Collection Profile resource was modified successfully, and a representation of that resource is returned.

n/a

204 No Content

The Individual DCCF Data Collection Profile resource was modified successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual DCCF Data Collection Profile modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative DCCF (service) instance.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual DCCF Data Collection Profile modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative DCCF (service) instance.

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

Location

string

M

1

An alternative URI of the resource located in an alternative DCCF (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 DCCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

n/a

n/a

n/a

204 No Content

The Individual DCCF Data Collection Profile resource was deleted successfully.

RedirectResponse

O

0..1

307 Temporary Redirect

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

RedirectResponse

O

0..1

308 Permanent Redirect

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

NOTE: The mandatory 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 DCCF (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 DCCF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

NdccfDataCollectionProfile

5.2.6.2.2

Represents an Individual DCCF Data Collection Profile resource.

DataSubscription

3GPP TS 29.575 [25]

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

NfInstanceId

3GPP TS 29.571 [17]

NF instance identifier.

NfSetId

3GPP TS 29.571 [17]

NF Set identifier.

NnwdafEventsSubscription

3GPP TS 29.520 [15]

Represents an NWDAF analytics subscription.

anaSub

NnwdafEventsSubscription

C

0..1

Representation of the analytics events subscription that is used to collect analytics.

(NOTE 1)

dataSub

DataSubscription

C

0..1

Representation of the data subscription that is used to collect data.

(NOTE 1)

nwdafId

NfInstanceId

C

0..1

NF instance identifier of the NWDAF that this data collection profile belongs to. (NOTE 2)

adrfId

NfInstanceId

C

0..1

NF instance identifier of the ADRF that this data collection profile belongs to. (NOTE 2)

nwdafSetId

NfSetId

C

0..1

Identifier of the set of the NWDAF that this data collection profile belongs to. (NOTE 2)

adrfSetId

NfSetId

C

0..1

Identifier of the set of the ADRF that this data collection profile belongs to. (NOTE 2)

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

NOTE 2: Only one of these attributes shall be provided.