hash stringlengths 32 32 | doc_id stringlengths 5 12 | section stringlengths 5 1.47k | content stringlengths 0 6.67M |
|---|---|---|---|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.1.3.1 Application Function (AF)
| The Application Function (AF), provides VFL inference for different analytics events to NF service consumers.
The Application Function (AF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification when a VFL inference event is detected.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.1.3.2 NF Service Consumers
| The Network Data Analytics Function (NWDAF) and Network Exposure Function (NEF) support (un)subscription to the notification of different VFL inference events.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2 Service Operations
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.1 Introduction
| Table 5.3.2.1-1: Operations of the Naf_VFLInference service
Service operation name
Description
Initiated by
Naf_VFLInference_Subscribe
This service operation is used by an NF service consumer to subscribe to VFL inference events.
NF service consumer (NWDAF,NEF)
Naf_VFLInference_Unsubscribe
This service operation is used by an NF service consumer to unsubscribe from VFL inference event notifications.
NF service consumer (NWDAF,NEF)
Naf_VFLInference_Notify
This service operation is used by the AF to notify the VFL inference results to the NF service consumer which has subscribed to the event notifications.
AF
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.2 Naf_VFLInference_Subscribe service operation
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.2.1 General
| The Naf_VFLInference_Subscribe service operation is used by an NF service consumer to request AF VFL client(s) to subscribe or update subscription for VFL inference event notifications from the AF acting as VFL client.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.2.2 Subscription for VFL inference event notifications
| Figure 5.3.2.2.2-1 shows a scenario where the NF service consumer sends a request to the AF to subscribe for VFL inference event notification(s) (as shown in 3GPP TS 23.288 [14]).
Figure 5.3.2.2.2-1: NF service consumer subscribes to VFL inference notifications
The NF service consumer shall invoke the Naf_VFLInference_Subscribe service operation to subscribe to VFL inference event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/naf-vflinference/<apiVersion>/subscriptions" as Resource URI representing the "AF VFL Inference Subscriptions", as shown in figure 5.3.2.2.2-1, step 1, to create a subscription for an "Individual VFL Inference Subscription" according to the information in message body.
The VflInferSub data structure provided in the request body shall include:
- an URI where to receive the requested notifications as the "notifUri" attribute;
- a notification correlation identifier assigned by the NF service consumer for the requested notifications as "notifCorrId" attribute; and
- a description of the subscribed analytics event(s) as the "vflInferAnaSubs" attribute.
and may include:
- the VFL reporting information as the "reportingReqs" attribute; and
- the required conditions to apply VFL inference as the "vflInferReq" attribute;
Upon the reception of an HTTP POST request with: "{apiRoot}/naf-vflinference/<apiVersion>/subscriptions" as Resource URI and VflInferSub data structure as request body, the AF shall create a new subscription and store the subscription.
If the AF created an "Individual VFL Inference Subscription" resource, the AF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 5.3.2.2.2-1, step 2. The AF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. "{apiRoot}/naf-vflinference/<apiVersion>/subscriptions/{subscriptionId}".
If the immediate reporting indication is applicable during the event subscription considering the "reportingReqs" attribute in the VflInferSub and VflInferAnaSub data structures, the AF shall include the intermediate VFL inference results of the subscribed events, if available, as the "vflInferResults" attribute in the HTTP POST response.
If any error occurs when processing the HTTP POST request, the AF shall send an HTTP error response as specified in clause 6.2.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.2.3 Update subscription for event notifications
| Figure 5.3.2.2.3-1 shows a scenario that the NF service consumer sends an HTTP PUT request to the AF to modify an existing VFL inference subscription (as shown in 3GPP TS 23.288 [14]).
Figure 5.3.2.2.3-1: Modification of VFL inference events subscription information using HTTP PUT
The NF service consumer shall invoke the Naf_VFLInference_Subscribe service operation to modify an existing VFL inference subscription. The NF service consumer shall send an HTTP PUT request with: "{apiRoot}/naf-vflinference/<apiVersion>/subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the subscriptionId of the existing VFL inference subscription to be modified, to update an "Individual VFL Inference Subscription" according to the information in the message body. The VflInferSub data structure provided in the request body shall include the same contents as described in clause 5.3.2.2.2.
Upon receipt of an HTTP PUT request with: "{apiRoot}/naf-vflinference/<apiVersion>/subscriptions/{subscriptionId}" as Resource URI and VflInferSub data type as request body, if the request is successfully processed and accepted, the AF shall:
- modify the concerned subscription; and
- store the subscription.
If the AF successfully processed and accepted the received HTTP PUT request, the AF shall update an "Individual VFL Inference Subscription" resource, and shall respond with:
- HTTP "204 No Content" response (as shown in figure 5.3.2.2.3-1, step 2a); or
- HTTP "200 OK" response (as shown in figure 5.3.2.2.3-1, step 2b) with a response body containing a representation of the updated subscription in the VflInferSub data type.
If the immediate reporting indication is applicable during the event subscription update considering the "reportingReqs" attribute in the VflInferSub and VflInferAnaSub data structures, the AF shall include the reports of the subscribed events, if available, as the "vflInferResults" attribute in the HTTP PUT response.
If any error occurs when processing the HTTP PUT request, the AF shall send an HTTP error response as specified in clause 6.2.7.
If the AF determines that the received HTTP PUT request needs to be redirected, the AF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.2.4 Partial update subscription for event notifications
| Figure 5.3.2.2.4-1 shows a scenario that the NF service consumer sends an HTTP PATCH request to the AF to partial modify an existing VFL inference subscription (as shown in 3GPP TS 23.288 [14]).
Figure 5.3.2.2.4-1: Partial modification of VFL inference subscription information using HTTP PATCH
The NF service consumer shall invoke the Naf_VFLInference_Subscribe service operation to partial modify an existing VFL inference subscription. The NF service consumer shall send an HTTP PATCH request with: "{apiRoot}/naf-vflinference/<apiVersion>/subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the subscriptionId of the existing VFL inference subscription to be modified, to update an "Individual VFL Inference Subscription" according to the information in the message body.
Upon receipt of an HTTP PATCH request with: "{apiRoot}/naf-vflinference/<apiVersion>/subscriptions/{subscriptionId}" as Resource URI and VflInferSubPatch data type as request body, if the request is successfully processed and accepted, the AF shall:
- partial modify the concerned subscription; and
- store the subscription.
If the AF successfully processed and accepted the received HTTP PATCH request, the AF shall partially update an "Individual VFL Inference Subscription" resource, and shall respond with:
- HTTP "204 No Content" response (as shown in figure 5.3.2.2.4-1, step 2a); or
- HTTP "200 OK" response (as shown in figure 5.3.2.2.4-1, step 2b) with a response body containing a representation of the updated subscription in the VflInferSub data type.
If the immediate reporting indication is applicable during the event subscription update considering the "reportingReqs" attribute within the in the VflInferSub and VflInferAnaSub data structures on the event subscription or the event subscription update, the AF shall include the reports of the subscribed events, if available, as the "vflInferResults" attribute in the HTTP PATCH response.
If any error occurs when processing the HTTP PATCH request, the AF shall send an HTTP error response as specified in clause 6.2.7.
If the AF determines that the received HTTP PATCH request needs to be redirected, the AF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.3 Naf_VFLInference_Unsubscribe service operation
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.3.1 General
| The Naf_VFLInference_Unsubscribe service operation is used by an NF service consumer to unsubscribe from VFL inference notifications.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.3.2 Unsubscribe from VFL inference notifications
| Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer sends a request to the AF to unsubscribe from a VFL inference notification (see also 3GPP TS 23.288 [14]).
Figure 5.3.2.3.2-1: NF service consumer unsubscribes from VFL inference notifications
The NF service consumer shall invoke the Naf_VFLInference_Unsubscribe service operation to unsubscribe from VFL inference event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/naf-vflinference/<apiVersion>/subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the subscriptionId of the existing VFL inference subscription that is to be deleted.
Upon the reception of an HTTP DELETE request, if the AF successfully processed and accepted the received HTTP DELETE request, the AF shall:
- remove the corresponding subscription; and
- respond with HTTP "204 No Content" status code.
If the AF determines the received HTTP DELETE request needs to be redirected, the AF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
If errors occur when processing the HTTP DELETE request, the AF shall send an HTTP error response as specified in clause 6.2.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.4 Naf_VFLInference_Notify service operation
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.4.1 General
| The Naf_VFLInference_Notify service operation is used by an AF to notify NF consumers about subscribed VFL inference events.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.3.2.4.2 Notification about subscribed event
| Figure 5.3.2.4.2-1 shows a scenario where the AF sends a request to the NF Service Consumer to notify for VFL inference event notifications (see also 3GPP TS 23.288 [14]).
Figure 5.3.2.4.2-1: AF notifies the subscribed VFL inference event
The AF shall invoke the Naf_VFLInference_Notify service operation to notify about a subscribed VFL inference event. The AF shall send an HTTP POST request with "{notifUri}" received in the Naf_VFLInference_Subscribe service operation as Resource URI, as shown in figure 5.3.2.4.2-1, step 1. The VflInferNotif data structure provided in the request body that shall include:
- a notification correlation identifier as "notifCorrId" attribute;
- description of the notified event as "vflInferResults" attribute.
Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code.
If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].
If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 6.2.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4 Naf_Training Service
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.1 Service Description
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.1.1 Overview
| The Naf_Training service exposed by the AF acting as VFL server and enables an NF service consumer to:
- request the creation/update of a Training subscription; and
- receive Training related event(s) reporting.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.1.2 Service Architecture
| The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [14]. The VFL signalling flows are defined in 3GPP TS 29.552 [15].
The Naf_Training service is part of the Naf service-based interface exhibited by the trusted Application Function (AF) or untrusted Application Function (AF).
Known consumers of the Naf_Training service are:
- Network Data Analytics Function (NWDAF) when the AF is trusted.
- Network Exposure Function (NEF) when the AF is untrusted.
Figure 5.4.1.2-1: Reference Architecture for the Naf_Training service; SBI representation
Figure 5.4.1.2-2: Reference Architecture for the Naf_Training service: reference point representation
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.1.3 Network Functions
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.1.3.1 Application Function (AF)
| The Application Function (AF) acting as VFL server provides training for different analytics events to NF service consumers.
The Application Function (AF) acting as VFL server allows NF service consumers to subscribe to and unsubscribe from training event notifications.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.1.3.2 NF Service Consumers
| The Network Data Analytics Function (NWDAF) and Network Exposure Function (NEF) support (un)subscription to the notification of different training events.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2 Service Operations
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.1 Introduction
| The service operations defined for the Naf_Training service are shown in table 5.4.2.1-1.
Table 5.4.2.1-1: Naf_Training Service Operations
Service Operation Name
Description
Initiated by
Naf_Training_Subscribe
This service operation enables the NF service consumer to request the creation/update of a Training Subscription.
e.g., NWDAF, NEF
Naf_Training_Unsubscribe
This service operation enables the NF service consumer to request the deletion of a Training Subscription.
e.g., NWDAF, NEF
Naf_Training_Notify
This service operation enables the NF service consumer to receive Training related event(s) reporting.
AF
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.2 Naf_Training_Subscribe
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.2.1 General
| This service operation is used by an NF service consumer to request the creation/update of a Training Subscription at the AF.
The following procedures are supported by the "Naf_Training_Subscribe" service operation:
- Training Subscription Creation.
- Training Subscription Update.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.2.2 Training Subscription Creation
| Figure 5.4.2.2.2-1 depicts a scenario where an NF service consumer sends a request to the AF to request the creation of a Training Subscription (see also clause 6.2H of 3GPP°TS°23.288°[14]).
Figure 5.4.2.2.2-1: Procedure for Training Subscription Creation
1. In order to subscribe to Training, the NF service consumer shall send an HTTP POST request to the AF targeting the URI of the "Training Subscriptions" collection resource, with the request body including the TrainEventsSubsc data structure.
2a. Upon success, the AF shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created "Individual Training Subscription" resource within the TrainEventsSubsc data structure, and an HTTP "Location" header field containing the URI of the created resource.
2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.2.3 Training Subscription Update
| Figure 5.4.2.2.3-1 depicts a scenario where an NF service consumer sends a request to the AF to request the update of an existing Training Subscription (see also clause 6.2H of 3GPP°TS°23.288°[14]).
Figure 5.4.2.2.3-1: Procedure for Training Subscription Update
1. In order to request the update of an existing Training Subscription, the NF service consumer shall send an HTTP PUT/PATCH request to the AF, targeting the URI of the corresponding "Individual Training Subscription" resource, with the request body including either:
- the updated representation of the resource within the TrainEventsSubsc data structure, in case the HTTP PUT method is used; or
- the requested modifications to the resource within the TrainEventsSubscPatch data structure, in case the HTTP PATCH method is used.
2a. Upon success, the AF shall update the targeted "Individual Training Subscription" resource accordingly and respond with either:
- an HTTP "200 OK" status code with the response body containing a representation of the updated "Individual Training Subscription" resource within the TrainEventsSubsc data structure; or
- an HTTP "204 No Content" status code.
2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT/PATCH response body, as specified in clause 6.3.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.3 Naf_Training_Unsubscribe
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.3.1 General
| This service operation is used by an NF service consumer to request the deletion of a Training Subscription at the AF.
The following procedures are supported by the "Naf_Training_Unsubscribe" service operation:
- Training Subscription Deletion.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.3.2 Training Subscription Deletion
| Figure 5.4.2.3.2-1 depicts a scenario where an NF service consumer sends a request to the AF to delete an existing Training Subscription (see also clause 6.2H of 3GPP°TS°23.288°[14]).
Figure 5.4.2.3.2-1: Procedure for Training Subscription Deletion
1. In order to request the deletion of an existing Training Subscription, the NF service consumer shall send an HTTP DELETE request to the AF targeting the URI of the corresponding "Individual Training Subscription" resource.
2a. Upon success, the AF shall respond with an HTTP "204 No Content" status code.
2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP DELETE response body, as specified in clause 6.3.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.4 Naf_Training_Notify
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.4.1 General
| This service operation is used by the AF to notify a previously subscribed service consumer on:
- Training report(s).
The following procedures are supported by the "Naf_Training_Notify" service operation:
- Training Notification.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.4.2.4.2 Training Notification
| Figure 5.4.2.4.2-1 depicts a scenario where the AF sends a request to notify a previously subscribed service consumer on Training report(s) (see also clause 6.2H of 3GPP°TS°23.288°[14]).
Figure 5.4.2.4.2-1: Procedure for Training Notification
1. In order to notify a previously subscribed service consumer on Training report(s), the AF shall send an HTTP POST request to the NF service consumer with the request URI set to "{notifUri}", where the "notifUri" variable is set to the value received from the NF service consumer during the creation/update of the corresponding Training Subscription using the procedures defined in clauses 5.4.2.2, and the request body including the TrainEventsNotif data structure.
2a. Upon success, the NF service consumer shall respond to the AF with an HTTP "204 No Content" status code to acknowledge the reception of the notification.
2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5 Naf_Inference Service
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.1 Service Description
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.1.1 Overview
| The Naf_Inference service as defined in 3GPP TS 23.288 [14], is provided by the Application Function (AF) acting as VFL server.
This service allows the NF service consumers to:
- subscribe to and unsubscribe from different inference events;
- modify inference subscriptions; and
- be notified about events for corresponding inference subscriptions.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.1.2 Service Architecture
| The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [14]. The VFL signalling flows are defined in 3GPP TS 29.552 [15].
The Naf_Inference service is part of the Naf service-based interface exhibited by the trusted Application Function (AF) or untrusted Application Function (AF).
Known consumers of the Naf_Inference service are:
- Network Data Analytics Function (NWDAF) when the AF is trusted.
- Network Exposure Function (NEF) when the AF is untrusted.
Figure 5.5.1.2-1: Reference Architecture for the Naf_Inference service; SBI representation
Figure 5.5.1.2-2: Reference Architecture for the Naf_Inference service: reference point representation
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.1.3 Network Functions
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.1.3.1 Application Function (AF)
| The Application Function (AF) acting as VFL server provides inference for different analytics events to NF service consumers.
The Application Function (AF) acting as VFL server allows NF service consumers to subscribe to and unsubscribe from inference events.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.1.3.2 NF Service Consumers
| The Network Data Analytics Function (NWDAF) and Network Exposure Function (NEF) support (un)subscription to the notification of different inference events.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2 Service Operations
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.1 Introduction
| Service operations defined for the Naf_Inference Service are shown in table 5.5.2-1.
Table 5.5.2-1: Naf_Inference Service Operations
Service Operation Name
Description
Initiated by
Naf_Inference_Subscribe
This service operation is used by an NF service consumer to subscribe to, or modify a subscription in the AF for Inference event notifications.
NF Consumer (i.e., NWDAF, NEF)
Naf_Inference_Unsubscribe
This service operation is used by an NF service consumer to unsubscribe from Inference event notifications.
NF Consumer (i.e., NWDAF, NEF)
Naf_Inference_Notify
This service operation is used by the AF to report Inference related event(s) to the NF service consumer which has subscribed to the event report service.
AF
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.2 Naf_Inference_Subscribe
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.2.1 General
| The Naf_Inference_Subscribe service operation is used by an NF service consumer to request AF VFL servers(s) to subscribe or update subscription for inference event notifications from the AF acting as VFL server.
The following procedures are supported by the "Naf_Inference_Subscribe" service operation:
- Inference Subscription Creation.
- Inference Subscription Update.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.2.2 Inference Subscription Creation
| Figure 5.5.2.2.2-1 a scenario where an NF service consumer sends a request to the AF to request the creation of an Inference Subscription.
Figure 5.5.2.2.2-1: Procedure for Inference subscription
In order to subscribe to Inference event notifications, the NF service consumer shall send an HTTP POST request to the AF targeting the URI of the "Inference Subscriptions" collection resource, with the request body including the InferEventSubsc data structure as defined in clause 6.4.6.2.2.
Upon the reception of an HTTP POST request with: "{apiRoot}/naf-inference/<apiVersion>/subscriptions" as Resource URI and InferEventSubsc data structure as request body:
- If the VFL server is a trusted AF:
- If no VFL model is already trained, the VFL server initiates VFL Training by sending Nnwdaf_VFLTraining_Subscribe towards NWDAF(s) acting as VFL Client(s).
- If VFL model is already trained, the VFL server may decide to initiate the VFL inference procedure towards the selected NWDAF VFL client(s) by sending Nnwdaf_VFLInference_Subscribe.
- If the VFL server is an untrusted AF:
- If no VFL model is already trained, the VFL server initiates VFL Training by sending for each NWDAF acting as VFL client an Nnef_VFLTraining_Subscribe request towards NEF indicating the identity of the NWDAF acting as VFL Client.
- If VFL model is already trained, the VFL server may decide to initiate the VFL inference procedure. For each selected NWDAF VFL client the VFL server sends an Nnef_VFLInference_Subscribe request to the NEF indicating the identity of the NWDAF acting as VFL Client.
If no NWDAF VFL Client(s) are selected, the VFL server may generate the VFL inference results based only on its local trained ML model associated with the determined VFL correlation ID.
Upon success, the AF shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created "Individual Inference Subscription" resource within the InferEventsSubsc data structure, and an HTTP "Location" header field containing the URI of the created resource.
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.2.3 Inference Subscription Update
| Figure 5.5.2.2.3-1 illustrates the modification of an existing subscription.
Figure 5.5.2.2.3-1: Modification of an existing subscription
In order to request the update of an existing inference subscription, the NF service consumer shall send an HTTP PUT/PATCH request to the AF, targeting the URI of the corresponding "Individual Inference Subscription" resource, with the request body including either:
- the updated representation of the resource within the InferEventSubsc data structure, in case the HTTP PUT method is used; or
- the requested modifications to the resource within the InferEventSubscPatch data structure, in case the HTTP PATCH method is used.
Upon receipt of the HTTP PUT/PATCH request from the NF service consumer the AF shall:-
- if the VFL server is a trusted AF and there are NWDAF VFL subscriptions associated to the AF inference subscription, the VFL updates those NWDAF VFL inference subscriptions by sending an Nnwdaf_VFLInference_Subscribe request towards each applicable NWDAF VFL client(s);
- if the VFL server is an untrusted AF and there are NWDAF VFL subscriptions associated to the AF inference subscription, the VFL updates those NWDAF VFL inference subscriptions by sending for each applicable NWDAF client an Nnef_VFLInference_Subscribe request to the NEF indicating the identity of the NWDAF VFL Client;
Upon success, the AF shall update the targeted "Individual Inference Subscription" resource accordingly and respond with either:
- an HTTP "200 OK" status code with the response body containing a representation of the updated "Individual Inference Subscription" resource within the InferEventsSubsc data structure; or
- an HTTP "204 No Content" status code.
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT/PATCH response body, as specified in clause 6.4.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.3 Naf_Inference_Unsubscribe
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.3.1 General
| The Naf_Inference_Unsubscribe service operation is used by an NF service consumer to subscribe from inference notifications.
The following procedures are supported by the "Naf_Inference_Unsubscribe" service operation:
- Inference Subscription Deletion.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.3.2 Inference Subscription Deletion
| Figure 5.5.2.3.2-1 shows a scenario where the NF service consumer sends a request to the AF to unsubscribe from an inference notification (see also 3GPP TS 23.288 [14]).
Figure 5.5.2.3.2-1: NF service consumer unsubscribes from inference notifications
In order to request the deletion of an existing Inference Subscription, the NF service consumer shall send an HTTP DELETE request to the AF targeting the URI of the corresponding "Individual Inference Subscription" resource.
Upon success, the AF shall respond with an HTTP "204 No Content" status code.
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP DELETE response body, as specified in clause 6.4.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.4 Naf_Inference_Notify
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.4.1 General
| The Naf_Inference_Notify service operation is used by an AF to notify NF consumers about subscribed inference events.
The following procedures are supported by the "Naf_Inference_Notify" service operation:
- Inference Notification.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 5.5.2.4.2 Inference Notification
| Figure 5.5.2.4.2-1 shows a scenario where the AF sends a request to the NF Service Consumer to notify for inference event notifications (see also 3GPP TS 23.288 [14]).
Figure 5.5.2.4.2-1: AF notifies the subscribed inference event
In order to notify a previously subscribed service consumer on Inference event(s), the AF shall send an HTTP POST request to the NF service consumer with the request URI set to "{notifUri}", where the "notifUri" variable is set to the value received from the NF service consumer during the creation/update of the corresponding Individual Inference Subscription resource using the procedures defined in clauses 5.5.2.2.2 and 5.5.2.2.3, and the request body including the InferNotif data structure.
Upon success, the NF service consumer shall respond to the AF with an HTTP "204 No Content" status code to acknowledge the reception of the notification.
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6 API Definitions
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1 Naf_VFLTraining Service API
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.1 Introduction
| The Naf_VFLTraining shall use the Naf_VFLTraining API.
The API URI of the Naf_VFLTraining API shall be:
{apiRoot}/<apiName>/<apiVersion>
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
- The <apiName> shall be "naf-vfl-train".
- The <apiVersion> shall be "v1".
- The <apiSpecificResourceUriPart> shall be set as described in clauses 6.1.3 and 6.1.4.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.2 Usage of HTTP
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.2.1 General
| HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Naf_VFLTraining API is contained in Annex A.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.2.2 HTTP standard headers
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.2.2.1 General
| See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.2.2.2 Content type
| If the AF is untrusted, support of HTTP/1.1 (IETF RFC 9112 [19], IETF RFC 9110 [20] and IETF RFC 9111[21] over TLS is mandatory and support of HTTP/2 (IETF RFC 9113 [11]) over TLS is recommended. TLS shall be used as specified in clause 12.3 and clause 13.1 of 3GPP TS 33.501 [8].
If the AF is trusted, HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [4].
HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Naf_VFLTraining API is contained in Annex A.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.2.3 HTTP custom headers
| The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3 Resources
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.1 Overview
| This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 6.1.3.1-1 depicts the resource URIs structure for the Naf_VFLTraining API.
Figure 6.1.3.1-1: Resource URI structure of the Naf_VFLTraining API
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.1.3.1-1: Resources and methods overview
Resource purpose/name
Resource URI (relative path after API URI)
HTTP method or custom operation
Description (service operation)
VFL Training Subscriptions
/subscriptions
POST
Create a new VFL Training Subscription.
Individual VFL Training Subscription
/subscriptions/{subscriptionId}
GET
Retrieve an existing "Individual VFL Training Subscription" resource.
PUT
Request the update of an existing "Individual VFL Training Subscription" resource.
PATCH
Request the modification of an existing "Individual VFL Training Subscription" resource.
DELETE
Request the deletion of an existing "Individual VFL Training Subscription" resource.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.2 Resource: VFL Training Subscriptions
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.2.1 Description
| This resource represents the collection of VFL Training Subscription(s) managed by the AF.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.2.2 Resource Definition
| Resource URI: {apiRoot}/naf-vfl-train/<apiVersion>/subscriptions
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
Table 6.1.3.2.2-1: Resource URI variables for this resource
Name
Data type
Definition
apiRoot
string
See clause 6.1.1.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.2.3 Resource Standard Methods
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.2.3.1 POST
| The HTTP POST method allows a service consumer to request the creation of a VFL Training Subscription at the AF.
This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
Table 6.1.3.2.3.1-1: URI query parameters supported by the 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 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3.
Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type
P
Cardinality
Description
VflTrainingSubs
M
1
Represents the parameters to request the creation of a VFL Training Subscription.
Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
VflTrainingSubs
M
1
201 Created
Successful case. The VFL Training Subscription is successfully created and a representation of the created "Individual VFL Training Subscription" resource shall be returned.
An HTTP "Location" header that contains the URI of the created resource shall also be included.
NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.
Table 6.1.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}/naf-vfl-train/<apiVersion>/subscriptions/{subscriptionId}
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.2.4 Resource Custom Operations
| There are no resource custom operations defined for this resource in this release of the specification.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.3 Resource: Individual VFL Training Subscription
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.3.1 Description
| This resource represents a VFL Training Subscription managed by the AF.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.3.2 Resource Definition
| Resource URI: {apiRoot}/naf-vfl-train/<apiVersion>/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.
Table 6.1.3.3.2-1: Resource URI variables for this resource
Name
Data type
Definition
apiRoot
string
See clause 6.1.1.
subscriptionId
string
Represents the unique identifier of the "Individual VFL Training Subscription" resource.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.3.3 Resource Standard Methods
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.3.3.1 GET
| The GET method allows an NF service consumer to retrieve an existing "Individual VFL Training Subscription" resource managed by the AF.
This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1.
Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource
Name
Data type
P
Cardinality
Description
Applicability
n/a
This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3.
Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource
Data type
P
Cardinality
Description
n/a
Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
VflTrainingSubs
M
1
200 OK
Successful case. The requested "Individual VFL Training Subscription" resource is returned.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: The mandatory HTTP error status codes for the HTTP GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.1.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
Table 6.1.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.3.3.2 PUT
| The PUT method allows an NF service consumer to request the update of an existing "Individual VFL Training Subscription" resource managed by the AF.
This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1.
Table 6.1.3.3.3.2-1: URI query parameters supported by the PUT method on this resource
Name
Data type
P
Cardinality
Description
Applicability
n/a
This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3.
Table 6.1.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource
Data type
P
Cardinality
Description
VflTrainingSubs
M
1
Contains the updated representation of the "Individual VFL Training Subscription" resource.
Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
VflTrainingSubs
M
1
200 OK
Successful case. The "Individual VFL Training Subscription" resource is successfully updated and a representation of the updated resource is returned in the response body.
n/a
204 No Content
Successful case. The "Individual VFL Training Subscription" resource is successfully updated and no content is returned in the response body.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: The mandatory HTTP error status codes for the HTTP PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.1.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
Table 6.1.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
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.3.3.3 PATCH
| The PATCH method allows an NF service consumer to request the modification of an existing "Individual VFL Training Subscription" resource managed by the AF.
This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1.
Table 6.1.3.3.3.3-1: URI query parameters supported by the PATCH method on this resource
Name
Data type
P
Cardinality
Description
Applicability
n/a
This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3.
Table 6.1.3.3.3.3-2: Data structures supported by the PATCH Request Body on this resource
Data type
P
Cardinality
Description
VflTrainingSubsPatch
M
1
Contains the parameters to request the modification of the "Individual VFL Training Subscription" resource.
Table 6.1.3.3.3.3-3: Data structures supported by the PATCH Response Body on this resource
Data type
P
Cardinality
Response
codes
Description
VflTrainingSubs
M
1
200 OK
Successful case. The "Individual VFL Training Subscription" resource is successfully modified and a representation of the updated resource is returned in the response body.
n/a
204 No Content
Successful case. The "Individual VFL Training Subscription" resource is successfully modified and no content is returned in the response body.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: The mandatory HTTP error status codes for the HTTP PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
Table 6.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.3.3.3.4 DELETE
| The DELETE method allows an NF service consumer to request the deletion of an existing "Individual VFL Training Subscription" resource managed by the AF.
This method shall support the URI query parameters specified in table 6.1.3.3.3.4-1.
Table 6.1.3.3.3.4-1: URI query parameters supported by the DELETE method on this resource
Name
Data type
P
Cardinality
Description
Applicability
n/a
This method shall support the request data structures specified in table 6.1.3.3.3.4-2 and the response data structures and response codes specified in table 6.1.3.3.3.4-3.
Table 6.1.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource
Data type
P
Cardinality
Description
n/a
Table 6.1.3.3.3.4-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 VFL Training Subscription" resource is successfully deleted.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(NOTE 2)
NOTE 1: The mandatory HTTP error status codes for the HTTP DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.1.3.3.3.4-4: Headers supported by the 307 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
Table 6.1.3.3.3.4-5: Headers supported by the 308 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI of the resource located in an alternative AF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target AF (service) instance towards which the request is redirected.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.4 Custom Operations without associated resources
| There are no custom operations without associated resources defined for this API in this release of the specification.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.5 Notifications
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.5.1 General
| Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5].
Table 6.1.5.1-1: Notifications overview
Notification
Callback URI
HTTP method or custom operation
Description
(service operation)
VFL Training Notification
{notifUri}
POST
Enables the AF to notify a previously subscribed NF service consumer on VFL Training report(s).
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.5.2 VFL Training Notification
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.5.2.1 Description
| The VFL Training Notification is used by the AF to notify a previously subscribed NF service consumer on VFL Training report(s).
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.5.2.2 Target URI
| The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1.
Table 6.1.5.2.2-1: Callback URI variables
Name
Definition
notifUri
Represents the callback URI encoded as a string formatted as a URI.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.5.2.3 Standard Methods
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.5.2.3.1 POST
| This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2.
Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body
Data type
P
Cardinality
Description
VflTrainingNotify
M
1
Represents the VFL Training Notification.
Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body
Data type
P
Cardinality
Response codes
Description
n/a
204 No Content
Successful case. The VFL Training Notification is successfully received.
RedirectResponse
O
0..1
307 Temporary Redirect
Temporary redirection.
(NOTE 2)
RedirectResponse
O
0..1
308 Permanent Redirect
Permanent redirection.
(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 [4] also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]).
Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target NF service consumer (service) instance towards which the notification request is redirected.
Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource
Name
Data type
P
Cardinality
Description
Location
string
M
1
Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4].
3gpp-Sbi-Target-Nf-Id
string
O
0..1
Identifier of the target NF service consumer (service) instance towards which the notification request is redirected.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6 Data Model
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.1 General
| This clause specifies the application data model supported by the API.
Table 6.1.6.1-1 specifies the data types defined for the Naf_VFLTraining service-based interface protocol.
Table 6.1.6.1-1: Naf_VFLTraining API specific Data Types
Data type
Clause defined
Description
Applicability
VflTrainingSubs
6.1.6.2.2
Represents a VFL Training Subscription.
VflTrainingSubsPatch
6.1.6.2.3
Represents the requested modifications to a VFL Training Subscription.
Table 6.1.6.1-2 specifies data types re-used by the Naf_VFLTraining 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 Naf_VFLTraining service-based interface.
Table 6.1.6.1-2: Naf_VFLTraining API re-used Data Types
Data type
Reference
Comments
Applicability
ReportingInformation
3GPP TS 29.523 [17]
Represents the event reporting requirements.
SupportedFeatures
3GPP TS 29.571 [16]
Represents the list of supported feature(s) and used to negotiate the applicability of the optional features.
Uri
3GPP TS 29.571 [16]
Represents a URI.
VflTrainingNotify
3GPP TS 29.520 [18]
Represents a VFL Training Notification.
VflTrainingSub
3GPP TS 29.520 [18]
Represents a VFL Training set.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.2 Structured data types
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.2.1 Introduction
| This clause defines the structures to be used in resource representations.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.2.2 Type: VflTrainingSubs
| Table 6.1.6.2.2-1: Definition of type VflTrainingSubs
Attribute name
Data type
P
Cardinality
Description
Applicability
vflTrainSubs
array(VflTrainingSub)
M
1..N
Contains the subscribed VFL training set(s).
notifUri
Uri
C
0..1
Represents the URI via which VFL Training related notifications shall be delivered.
It shall be present if the "vflPreFlag" attribute is not included or set to "false".
notifCorrId
string
C
0..1
Represents the notification Correlation Identifier.
It shall be present if the "vflPreFlag" attribute is not included or set to "false".
vflPreFlag
boolean
O
0..1
Indicates the subscription is for preparation of VFL, when it is included and set to "true". The default value is "false" if omitted.
It shall be present when the service is for preparation of VFL.
(NOTE)
reportingReqs
ReportingInformation
O
0..1
Contains the reporting requirements applicable for VFL Training related reporting.
trainReports
array(VflTrainingNotify)
O
1..N
Contains the VFL Training related event(s) report(s).
This attribute may be present only if immediate reporting was requested via the "reportingReqs" attribute.
suppFeat
SupportedFeatures
C
0..1
Contains the list of supported features among the ones defined in clause 6.1.8.
This attribute shall be present only when feature negotiation is required.
NOTE: When the service is for VFL preparation (the "vflPreFlag" attribute sets to "true"), the NF service producer shall send no notification until it is updated with the value of the "vflPreFlag" attribute as "false", and the "trainReports" attribute shall be absent in the HTTP POST response.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.2.3 Type: VflTrainingSubsPatch
| Table 6.1.6.2.3-1: Definition of type VflTrainingSubsPatch
Attribute name
Data type
P
Cardinality
Description
Applicability
vflTrainSubs
array(VflTrainingSub)
O
1..N
Contains the updated subscribed VFL training set(s).
notifUri
Uri
O
0..1
Contains the updated URI via which VFL Training related notifications shall be delivered.
notifCorrId
string
O
0..1
Notification Correlation Identifier.
reportingReqs
ReportingInformation
O
0..1
Contains the reporting requirements applicable for VFL Training related reporting.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.3 Simple data types and enumerations
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.3.1 Introduction
| This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.3.2 Simple data types
| The simple data types defined in table 6.1.6.3.2-1 shall be supported.
Table 6.1.6.3.2-1: Simple data types
Type Name
Type Definition
Description
Applicability
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.4 Data types describing alternative data types or combinations of data types
| There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification.
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.5 Binary data
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.6.5.1 Binary Data Types
| Table 6.1.6.5.1-1: Binary Data Types
Name
Clause defined
Content type
|
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.7 Error Handling
| |
21583c06c9a14c098fd1bd4da409262a | 29.530 | 6.1.7.1 General
| For the Naf_VFLTraining API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] 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 3GPP TS 29.500 [4].
In addition, the requirements in the following clauses are applicable for the Naf_VFLTraining API.
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.