5.5 NiddConfigurationTrigger API

29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS

5.5.1 Resources

There is no resource defined for this API.

5.5.2 Notifications

5.5.2.1 Introduction

Upon receipt of a NIDD connection establishment request from the SMF and there is no NIDD configuration for the UE, the NEF may send an HTTP POST message in order to trigger the AF to start the NIDD configuration procedure as described in clause 5.6.3.2.3.4 of 3GPP TS 29.122 [4].

Table 5.5.2.1-1: Notifications overview

Notification	Callback URI	HTTP method or custom operation	Description (service operation)
Event Notification	{notificationUri}	POST	Request for the NIDD Configuration Trigger

5.5.2.2 Event Notification

The Callback URI "{notificationUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1.

Table 5.5.2.2-1: Callback URI variables

Name	Data type	Definition
notificationUri	Link	A URI indicating the notification destination where N33 notification requests shall be delivered to. This URI shall be preconfigured in the NEF.

5.5.2.3 Operation Definition

5.5.2.3.1 Notification via HTTP POST

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

Table 5.5.2.3.1-1: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
NiddConfigurationTrigger	M	1	The NIDD Configuration Trigger is provided by the NEF to the AF.

Table 5.5.2.3.1-2: Data structures supported by the POST Response Body on this resource

Data type	P	Cardinality	Response codes	Description
NiddConfigurationTriggerReply	M	1	200 OK	The trigger is received successfully.
N/A			307 Temporary Redirect	Temporary redirection, during Configuration Trigger. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
N/A			308 Permanent Redirect	Permanent redirection, during Configuration Trigger. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Tabl  5.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	An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

Table 5.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	An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

5.5.2.3.2 Notification via Websocket

Not specified in the present specification.

5.5.3 Data Model

5.5.3.1 General

This clause specifies the application data model supported by the NiddConfigurationTrigger API.

5.5.3.2 Reused data types

The data types reused by the NiddConfigurationTrigger API from other specifications are listed in table 5.5.3.2-1.

Table 5.5.3.2-1: Re-used Data Types

Data type	Reference	Comments
Gpsi	3GPP TS 29.571 [8]	Identifies a GPSI.
SupportedFeatures	3GPP TS 29.571 [8]	Used to negotiate the applicability of the optional features defined in table 5.5.4-1.

5.5.3.3 Structured data types

5.5.3.3.1 Introduction

This clause defines the structured data types to be used in resource representations.

5.5.3.3.2 Type: NiddConfigurationTrigger

This type represents a NIDD configuration trigger which is sent from the NEF to the AF.

Table 5.5.3.3.2-1: Definition of type NiddConfigurationTrigger

Attribute name	Data type	P	Cardinality	Description	Applicability (NOTE)
afId	string	M	1	Identifies the trigger receiving entity.
nefId	string	M	1	Identifies the trigger sending entity.
gpsi	Gpsi	M	1	Identifies a user.
suppFeat	SupportedFeatures	M	1	Indicates the list of Supported features used as described in clause 5.5.4.
NOTE: Properties marked with a feature as defined in clause 5.5.4 are applicable as described in clause 5.2.7 of 3GPP TS 29.122 [4]. If no feature is indicated, the related property applies for all the features.

5.5.3.3.3 Type: NiddConfigurationTriggerReply

This data type represents a reply to a NIDD configuration trigger and is sent from the AF to the NEF.

Table 5.5.3.3.3-1: Definition of type NiddConfigurationTriggerReply

Attribute name	Data type	P	Cardinality	Description	Applicability (NOTE)
suppFeat	SupportedFeatures	M	1	Indicates the list of Supported features used as described in clause 5.5.4.
NOTE: Properties marked with a feature as defined in clause 5.5.4 are applicable as described in clause 5.2.7 of 3GPP TS 29.122 [4]. If no feature is indicated, the related property applies for all the features.

5.5.3.4 Simple data types and enumerations

5.5.3.4.1 Introduction

This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.

5.5.3.4.2 Simple data types

The simple data types defined in table 5.5.3.4.2-1 shall be supported.

Table 5.5.3.4.2-1: Simple data types

Type Name	Type Definition	Description	Applicability

5.5.4 Used Features

The table below defines the features applicable to the NiddConfigurationTrigger API. Those features are negotiated as described in clause 5.2.7 of 3GPP TS 29.122 [4].

Table 5.5.4-1: Features used by NiddConfigurationTrigger API

Feature number

Feature Name

Description

5.5.5 Error handling

5.5.5.1 General

HTTP error handling shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [4].

In addition, the requirements in the following clauses shall apply.

5.5.5.2 Protocol Errors

In this Release of the specification, there are no additional protocol errors applicable for the NiddConfigurationTrigger API.

5.5.5.3 Application Errors

The application errors defined for NiddConfigurationTrigger API are listed in table 5.5.5.3-1.

Table 5.5.5.3-1: Application errors

Application Error	HTTP status code	Description	Applicability