5.3 Nnwdaf_DataManagement Service API
29.5203GPP5G SystemNetwork Data Analytics ServicesRelease 18Stage 3TS
5.3.1 Introduction
The Nnwdaf_DataManagement service shall use the Nnwdaf_DataManagement API.
The API URI of the Nnwdaf_DataManagement API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [7].
– The<apiName> shall be "nnwdaf-datamanagement".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 5.3.3.
5.3.2 Usage of HTTP
5.3.2.1 General
HTTP/2, IETF RFC 7540 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6].
The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf_DataManagement is contained in Annex A.
5.3.2.2 HTTP standard headers
5.3.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers.
5.3.2.2.2 Content type
JSON, IETF RFC 8259 [10], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [6]. The use of the JSON format shall be signalled by the content type "application/json".
"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [15].
5.3.2.3 HTTP custom headers
The Nnwdaf_DataManagement service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6].
In this release of the specification, no specific custom headers are defined for the Nnwdaf_DataManagement service API.
5.3.3 Resources
5.3.3.1 Resource Structure
This clause describes the structure for the Resource URIs, the resources and methods used for the service.
Figure 5.3.3.1-1 depicts the resource URIs structure for the Nnwdaf_DataManagement API.
Figure 5.3.3.1-1: Resource URI structure of the Nnwdaf_DataManagement API
Table 5.3.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 5.3.3.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
NWDAF Data Management Subscriptions |
/subscriptions |
POST |
Creates a new Individual NWDAF Data Management Subscription resource. |
Individual NWDAF Data Management Subscription |
/subscriptions/{subscriptionId} |
DELETE |
Deletes an Individual NWDAF Data Management Subscription identified by subresource {subscriptionId}. |
PUT |
Modifies an existing Individual NWDAF Data Management Subscription identified by subresource {subscriptionId}. |
5.3.3.2 Resource: NWDAF Data Management Subscriptions
5.3.3.2.1 Description
The NWDAF Data Management Subscriptions resource represents all subscriptions to the Nnwdaf_DataManagement Service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Data Management Subscription resource.
5.3.3.2.2 Resource Definition
Resource URI: {apiRoot}/nnwdaf-datamanagement/<apiVersion>/subscriptions
The <apiVersion> shall be set as described in clause 5.3.1.
This resource shall support the resource URI variables defined in table 5.3.3.2.2-1.
Table 5.3.3.2.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.3.1 |
5.3.3.2.3 Resource Standard Methods
5.3.3.2.3.1 POST
This method shall support the URI query parameters specified in table 5.3.3.2.3.1-1.
Table 5.3.3.2.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 5.3.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.3.2.3.1-3.
Table 5.3.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
NnwdafDataManagementSubsc |
M |
1 |
Create a new Individual NWDAF Data Management Subscription resource. |
Table 5.3.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
NnwdafDataManagementSubsc |
M |
1 |
201 Created |
The creation of an Individual NWDAF Data Management 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 codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. NOTE 2: Failure cases are described in clause 5.3.7. |
Table 5.3.3.2.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}/nnwdaf-datamanagement/<apiVersion>/subscriptions/{subscriptionId} |
5.3.3.2.4 Resource Custom Operations
None in this release of the specification.
5.3.3.3 Resource: Individual NWDAF Data Management Subscription
5.3.3.3.1 Description
The Individual NWDAF Data Management Subscription resource represents a single subscription to the Nnwdaf_DataManagement Service at a given NWDAF.
5.3.3.3.2 Resource definition
Resource URI: {apiRoot}/nnwdaf-datamanagement/<apiVersion>/subscriptions/{subscriptionId}
The <apiVersion> shall be set as described in clause 5.3.1.
This resource shall support the resource URI variables defined in table 5.3.3.3.2-1.
Table 5.3.3.3.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.3.1 |
subscriptionId |
string |
Identifies a subscription to the Nnwdaf_DataManagement Service |
5.3.3.3.3 Resource Standard Methods
5.3.3.3.3.1 PUT
This method shall support the URI query parameters specified in table 5.3.3.3.3.1-1.
Table 5.3.3.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 5.3.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.3.1-3.
Table 5.3.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource
Data type |
P |
Cardinality |
Description |
NnwdafDataManagementSubsc |
M |
1 |
Parameters to replace a subscription to NWDAF Data Management Subscription resource. |
Table 5.3.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
NnwdafDataManagementSubsc |
M |
1 |
200 OK |
The Individual NWDAF Data Management Subscription resource was modified successfully and a representation of that resource is returned. |
n/a |
204 No Content |
The Individual NWDAF Data Management Subscription resource was modified successfully. |
||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual NWDAF Data Management Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual NWDAF Data Management Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. |
ProblemDetails |
O |
0..1 |
400 Bad Request |
(NOTE 2) |
NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. NOTE 2: Failure cases are described in clause 5.3.7. |
Table 5.3.3.3.3.1-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NWDAF (service) instance. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
Table 5.3.3.3.3.1-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NWDAF (service) instance. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
5.3.3.3.3.2 DELETE
This method shall support the URI query parameters specified in table 5.3.3.3.3.2-1.
Table 5.3.3.3.3.2-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 5.3.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.3.2-3.
Table 5.3.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 5.3.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
Successful case: The Individual NWDAF Data Management Subscription resource matching the subscriptionId was deleted. |
||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during Individual NWDAF Data Management Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection, during Individual NWDAF Data Management Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. |
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. |
Table 5.3.3.3.3.2-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NWDAF (service) instance. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
Table 5.3.3.3.3.2-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NWDAF (service) instance. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected |
5.3.3.3.4 Resource Custom Operations
None in this release of the specification.
5.3.4 Custom Operations without associated resources
5.3.5 Notifications
5.3.5.1 General
Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7].
Table 5.3.5.1-1: Notifications overview
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
Event Notification |
{notificURI} |
POST |
Report one or several observed data. |
Fetch Notification |
{fetchUri} |
POST |
Fetch one or several notified data. |
5.3.5.2 Event Notification
5.3.5.2.1 Description
The Event Notification is used by the NWDAF to report one or several observed data to an NF service consumer that has subscribed to such Notifications.
5.3.5.2.2 Operation Definition
Callback URI: {notificURI}
The operation shall support the callback URI variables defined in Table 5.3.5.2.2-1, the request data structures specified in table 5.3.5.2.2-2 and the response data structure and response codes specified in Table 5.3.5.2.2-3.
Table 5.3.5.2.2-1: Callback URI variables
Name |
Data type |
Definition |
notificURI |
Uri |
The Notification Uri is assigned within the Individual NWDAF Data Management Subscription Resource and described within the NnwdafDataManagementSubsc type (see table 5.3.6.2.2-1). |
Table 5.3.5.2.2-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
NnwdafDataManagementNotif |
M |
1 |
Provides Information about observed data. |
Table 5.3.5.2.2-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
The receipt of the Notification is acknowledged. |
||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection, during the 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 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 [6] also apply. |
Table 5.3.5.2.2-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
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 |
Table 5.3.5.2.2-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
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 |
5.3.5.3 Fetch Notification
5.3.5.3.1 Description
The Fetch Notification is used by the NF service consumer to retrieve data from the NWDAF.
5.3.5.3.2 Target URI
The Callback URI "{fetchUri}" shall be used with the callback URI variables defined in table 5.3.5.3.2-1.
Table 5.3.5.3.2-1: Callback URI variables
Name |
Data type |
Definition |
fetchUri |
Uri |
Fetch Uri as assigned during the procedure of notification about the subscribed data within the FetchInstruction data type. |
5.3.5.3.3 Standard Methods
5.3.5.3.3.1 POST
This method shall support the URI query parameters specified in table 5.3.5.3.3.1-1.
Table 5.3.5.3.3.1-1: URI query parameters supported by the POST method on this resource
Name |
Data type |
P |
Cardinality |
Description |
Applicability |
n/a |
This method shall support the request data structures specified in table 5.3.5.3.3.1-2 and the response data structures and response codes specified in table 5.3.5.3.3.1-3.
Table 5.3.5.3.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
array(string) |
M |
1..N |
Indicate the fetch correlation identifier(s). |
Table 5.3.5.3.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
NnwdafDataManagementNotif |
M |
1 |
200 OK |
The stored data related to the fetch correlation identifier(s). |
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 NWDAF. |
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 NWDAF. |
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. |
Table 5.3.5.3.3.1-4: Headers supported by the by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NWDAF. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
Table 5.3.5.3.3.1-5: Headers supported by the 308 response code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative NWDAF. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance towards which the request is redirected. |
5.3.6 Data Model
5.3.6.1 General
This clause specifies the application data model supported by the API.
Table 5.3.6.1-1 specifies the data types defined for the Nnwdaf_DataManagement service based interface protocol.
Table 5.3.6.1-1: Nnwdaf_DataManagement specific Data Types
Data type |
Clause defined |
Description |
Applicability |
NnwdafDataManagementSubsc |
5.3.6.2.2 |
Represents an Individual NWDAF Data Management Subscription resource. |
|
NnwdafDataManagementNotif |
5.3.6.2.3 |
Represents a notification that corresponds with an Individual NWDAF Data Management Subscription resource. |
Table 5.3.6.1-2 specifies data types re-used by the Nnwdaf_DataManagement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnwdaf_DataManagement service based interface.
Table 5.3.6.1-2: Nnwdaf_DataManagement re-used Data Types
Data type |
Reference |
Comments |
Applicability |
DataCollectionPurpose |
3GPP TS 29.574 [26] |
Represents the purpose for data collection, e.g. analytics or model training. |
|
DataNotification |
3GPP TS 29.575 [27] |
Represents data subscription notification from data source (e.g. AMF, SMF, UDM, NEF, AF). |
|
DataSubscription |
3GPP TS 29.575 [27] |
Represents data subscription from data source (e.g. AMF, SMF, UDM, NEF, AF). |
|
DateTime |
3GPP TS 29.571 [8] |
Identifies the time. |
|
FormattingInstruction |
3GPP TS 29.574 [26] |
DCCF formatting Instructions. |
|
FetchInstruction |
3GPP TS 29.576 [28] |
The fetch instruction indicates whether the data can be fetched by the consumer. |
|
NfInstanceId |
3GPP TS 29.571 [8] |
NF instance identifier. |
|
NfSetId |
3GPP TS 29.571 [8] |
NF set identifier. |
|
NnwdafEventsSubscription |
5.1.6.2.2 |
Represents an NWDAF analytics subscription. |
|
NotifSummaryReport |
3GPP TS 29.574 [26] |
Contains a summary report of processed notifications. |
|
ProcessingInstruction |
3GPP TS 29.574 [26] |
DCCF processing Instructions. |
|
SupportedFeatures |
3GPP TS 29.571 [8] |
||
TimeWindow |
3GPP TS 29.122 [19] |
Represents a time window. |
|
Uri |
3GPP TS 29.571 [8] |
URI. |
5.3.6.2 Structured data types
5.3.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
5.3.6.2.2 Type NnwdafDataManagementSubsc
Table 5.3.6.2.2-1: Definition of type NnwdafDataManagementSubsc
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
adrfId |
NfInstanceId |
O |
0..1 |
Identifier of the ADRF to be used by the NWDAF. 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 NWDAF 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 NWDAF shall retrieve the data from this ADRF. (NOTE 2) |
|
adrfSetId |
NfSetId |
O |
0..1 |
Identifier of the ADRF Set to be used by the NWDAF. 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 NWDAF 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 NWDAF shall retrieve the data from this ADRF Set. (NOTE 2) |
|
anaSub |
NnwdafEventsSubscription |
C |
0..1 |
Analytics subscription information to be used by the NWDAF to determine the data that is relevant to these analytics and shall thus be collected and reported. (NOTE 1) |
|
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 |
dataCollectPurposes |
array(DataCollectionPurpose) |
O |
1..N |
The purpose 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. |
|
dataSub |
DataSubscription |
C |
0..1 |
Subscribed data events. (NOTE 1) |
|
formatInstruct |
FormattingInstruction |
O |
0..1 |
Formatting instructions to be used for sending event notifications. |
|
notifCorrId |
string |
M |
1 |
Notification correlation identifier. |
|
notificURI |
Uri |
M |
1 |
Notification target address. |
|
procInstruct |
ProcessingInstruction |
O |
0..1 |
Processing instructions to be used for sending event notifications. This attribute may only be provided if the "dataSub" attribute is provided. (NOTE 4) |
|
multiProcInstructs |
array(ProcessingInstruction) |
O |
1..N |
Processing instructions to be used for sending event notifications. This attribute may only be provided if the "dataSub" attribute is provided. (NOTE 4) |
MultiProcessingInstruction |
suppFeat |
SupportedFeatures |
C |
0..1 |
This IE represents a list of Supported features as described in clause 5.3.8. (NOTE 5) |
|
targetNfId |
NfInstanceId |
O |
0..1 |
NF instance identifier to which the NWDAF shall create the requested subscription. (NOTE 2) |
|
targetNfSetId |
NfSetId |
O |
0..1 |
NF set identifier to which the NWDAF shall create the requested subscription. (NOTE 2) |
|
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 3) |
|
NOTE 1: Exactly one of these attributes shall be provided. NOTE 2: "targetNfId" and "targetNfSetId" are mutually exclusive. "adrfId" and "adrfSetId" are also mutually exclusive. NOTE 3: 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 4: The "multiProcInstructs" attribute shall be used instead of the "procInstruct" attribute when the "MultiProcessingInstruction" feature is supported. NOTE 5 It shall be present in the POST request if at least one feature defined in clause 5.3.8 is supported, and it shall be present in the POST response if the NF service consumer includes the "suppFeat" attribute in the POST request. |
5.3.6.2.3 Type NnwdafDataManagementNotif
able 5.3.6.2.3-1: Definition of type NnwdafDataManagementNotif
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
dataNotification |
DataNotification |
C |
0..1 |
List of data subscription notifications. (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) (NOTE 2) |
|
notifCorrId |
string |
M |
1 |
Notification correlation identifier. |
|
terminationReq |
string |
O |
0..1 |
If set to "true", it indicates that the termination of the data management subscription is requested by the NWDAF, i.e. NWDAF will not provide further notifications related to this subscription. If absent, no termination is requested. |
|
fetchInstruct |
FetchInstruction |
C |
0..1 |
The fetch instruction indicates whether the data are to be fetched by the Consumer. This attribute may not be present in the response of a Fetch request. (NOTE 1) |
|
notifTimestamp |
DateTime |
M |
1 |
It represents time when NWDAF completes preparation of the requested data. |
|
NOTE 1: One of these attributes shall be provided. NOTE 2: For every entry of the array, the "eventId" attribute shall not contain the "nwdafEvent" attribute. NOTE 3: If the NWDAF has received the notifications from another source without a timestamp, then the NWDAF adds itself a timestamp based on the time it received the notification in timeStamp attribute contained in dataNotification attribute. . |
5.3.7 Error handling
5.3.7.1 General
HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6].
For the Nnwdaf_DataManagement API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of TS 29.500 [6]. In addition, the requirements in the following clauses shall apply.
5.3.7.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf_DataManagement API.
5.3.7.3 Application Errors
The application errors defined for the Nnwdaf_DataManagement API are listed in table 5.3.7.3-1.
Table 5.3.7.3-1: Application errors
Application Error |
HTTP status code |
Description |
SUBSCRIPTION_CANNOT_BE_SERVED |
400 Bad Request |
Indicates that the NWDAF cannot use the contents of the request to either a) determine whether the subscription can already be served or interactions with the ADRF and/or data sources are required or b) determine what interactions with the ADRF and/or data sources 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 has not provided the required user consent. |
NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. |
5.3.8 Feature negotiation
The optional features in table 5.3.8-1 are defined for the Nnwdaf_DataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6].
Table 5.3.8-1: Supported Features
Feature number |
Feature Name |
Description |
1 |
MultiProcessingInstruction |
Indicates the support of multiple processing instructions. |
2 |
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 lack of user consent. |
5.3.9 Security
As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf_DataManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see TS 29.510 [12]) plays the role of the authorization server.
If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf_DataManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], clause 5.4.2.2.
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Nnwdaf_DataManagement service.
The Nnwdaf_DataManagement API defines a single scope "nnwdaf-datamanagement" for the entire service, and it does not define any additional scopes at resource or operation level.