5.24 DataReportingProvisioning API

29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

5.24.1 Introduction

The Nnef_DataReportingProvisioning service shall use the DataReportingProvisioning API.

The API URI of the DataReportingProvisioning API shall be:

{apiRoot}/<apiName>/<apiVersion>

The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [4], i.e.:

{apiRoot}/<apiName>/<apiVersion>/<apiSpecificSuffixes>

with the following components:

– "apiRoot" is set as defined in clause 5.2.4 of 3GPP TS 29.122 [4].

– "apiName" shall be set to "3gpp-data-reporting-provisioning".

– "apiVersion" shall be set to "v1" for the current version defined in the present document.

All resource URIs in the clauses below are defined relative to the above API URI.

5.24.2 Resources

This clause describes the structure for the Resource URIs as shown in Figure 5.24.2-1 and the resources and HTTP methods used for the DataReportingProvisioning API.

Figure 5.24.2-1: Resource URI structure of the DataReportingProvisioning API

Table 5.24.2-1 provides an overview of the resources and applicable HTTP methods.

Table 5.24.2-1: Resources and methods overview

Resource name	Resource URI (relative path under API URI)	HTTP method	Description (service operation)
Data Reporting Provisioning Sessions	/sessions	POST	Create a Data Reporting Provisioning Session.
Individual Data Reporting Provisioning Session	/sessions/{sessionId}	GET	Retreive an existing Individual Data Reporting Provisioning Session resource.

		DELETE	Delete an existing Individual Data Reporting Provisioning Session resource.
Data Reporting Configuration	/sessions/{sessionId}/ configurations	POST	Create a new Data Reporting Configuration.
Individual Data Reporting Configuration	/sessions/{sessionId}/ configurations/{configurationId}	GET	Retrieves an existing individual Data Reporting Configuration resource.
		PUT	Update an existing individual Data Reporting Configuration resource.
		PATCH	Modify an existing Individual Data Reporting Configuration resource.
		DELETE	Delete an existing Individual Data Reporting Configuration resource.

5.24.2.2 Resource: Data Reporting Provisioning Sessions

5.24.2.2.1 Introduction

This resource represents the collection of Data Reporting Provisioning Sessions managed by the NEF.

This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [3]).

5.24.2.2.2 Resource definition

Resource URL: {apiRoot}/3gpp-data-reporting-provisioning/v1/sessions

This resource shall support the resource URI variables defined in table 5.24.2.2.2-1.

Table 5.24.2.2.2-1: Resource URL variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.24.1.

5.24.2.2.3 Resource Methods

5.24.2.2.3.1 POST

This method enables an AF to request the creation of a Data Reporting Provisioning Session at the NEF.

This method shall support the URI query parameters specified in table 5.24.2.2.3.1-1.

Table 5.24.2.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 5.24.2.2.3.1-2 and the response data structures and response codes specified in table 5.24.2.2.3.1-4.

Table 5.24.2.2.3.1-2: Data structures supported by the POST request body on this resource

Data type

Cardinality

Description

DataReportingProvisioningSession

(NOTE)

Representation of the Individual Data Reporting Provisioning Session to be created in the NEF.

NOTE: The “provisioningSessionId” attribute of the DataReportingProvisioningSession data type shall not be provided as it is not applicable.

Table 5.24.2.2.3.1-3: Data structures supported by the POST response body on this resource

Data type

Cardinality

Response

codes

Description

DataReportingProvisioningSession

(NOTE 2)

201 Created

Successful case. A representation of the created Individual Data Reporting Provisioning Session resource is returned.

The URI of the created resource shall be returned in an HTTP "Location" header.

NOTE 1: 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.

NOTE 2: The “provisioningSessionId” attribute of the DataReportingProvisioningSession data type shall not be provided as it is not applicable.

Table 5.24.2.2.3.1-4: Headers supported by the 201 response code on this resource

HTTP response header	Data type	P	Cardinality	Description
Location	string	M	1	The URI of the newly created resource, according to the structure: {apiRoot}/3gpp-data-reporting-provisioning/v1/sessions/{sessionId}

5.24.2.3 Resource: Individual Data Reporting Provisioning Session

5.24.2.3.1 Introduction

This resource represents an Individual Data Reporting Provisioning Session managed by the NEF.

This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [3]).

5.24.2.3.2 Resource Definition

Resource URL: {apiRoot}/3gpp-data-reporting-provisioning/v1/sessions/{sessionId}

This resource shall support the resource URI variables defined in table 5.24.2.3.2-1.

Table 5.24.2.3.2-1: Resource URL variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.24.1
sessionId	string	Represents the identifierof the Individual Data Reporting Provisioning Session resource.

5.24.2.3.3 Resource standard methods

5.24.2.3.3.1 GETThis method enables an AF to retrieve an existing Individual Data Reporting Provisioning Session resource at the NEF.

This method shall support the URI query parameters specified in table 5.24.2.3.3.1-1.

Table 5.24.2.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 5.24.2.3.3.1-2 and the response data structures and response codes specified in table 5.24.2.3.3.1-3.

Table 5.24.2.3.3.1-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.24.2.3.3.1-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingProvisioningSession (NOTE 2)	M	1	200 OK	Successful case. The requested Individual Data Reporting Provisioning Session resource is returned to the AF.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE 1: The mandatory HTTP error status code for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. NOTE 2: The “provisioningSessionId” attribute of the DataReportingProvisioningSession data type shall not be provided as it is not applicable.

Table 5.24.2.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 target URI located in an alternative NEF.

Table 5.24.2.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 target URI of the resource located in an alternative NEF.

5.24.2.3.3.2 Void

5.24.2.3.3.3 DELETE

This method enables an AF to request the deletion of an existing Individual Data Reporting Provisioning Session resource at the NEF.

This method shall support the URI query parameters specified in table 5.24.2.3.3.3-1.

Table 5.24.2.3.3.3-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.24.2.3.3.3-2 and the response data structures and response codes specified in table 5.24.2.3.3.3-3.

Table 5.24.2.3.3.3-2: Data structures supported by the DELETE request body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.24.2.3.3.3-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 response. The Individual Data Reporting Provisioning Session resource was successfully deleted.
			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.24.2.3.3.3-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 on an alternative service instance within the same NEF.

Table 5.24.2.3.3.3-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 on an alternative service instance within the same NEF.

5.24.2.4 Resource: Data Reporting Configurations

5.24.2.4.1 Introduction

This resource represents the collection of Data Reporting Configurations managed by the NEF.

This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [3]).

5.24.2.4.2 Resource definition

Resource URL: {apiRoot}/3gpp-data-reporting-provisioning/v1/sessions/{sessionId}/configurations

This resource shall support the resource URI variables defined in table 5.24.2.4.2-1.

Table 5.24.2.4.2-1: Resource URL variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.24.1.
sessionId	string	Represents the identifier of the existing Data Reporting Provisioning Session resource.

5.24.2.4.3 Resource Methods

5.24.2.4.3.1 POST

This method enables an AF to request the creation of a Data Reporting Configuration at the NEF.

This method shall support the URI query parameters specified in table 5.24.2.4.3.1-1.

Table 5.24.2.4.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.24.2.4.3.1-2 and the response data structures and response codes specified in table 5.24.2.4.3.1-4.

Table 5.24.2.4.3.1-2: Data structures supported by the POST request body on this resource

Data type

Cardinality

Description

DataReportingConfiguration

(NOTE)

Representation of the Data Reporting Configuration to be created in the NEF.

NOTE: The “dataReportingConfigurationId” attribute of the DataReportingConfiguration data type shall not be provided as it is not applicable.

Table 5.24.2.4.3.1-3: Data structures supported by the POST response body on this resource

Data type

Cardinality

Response

codes

Description

DataReportingConfiguration

(NOTE 2)

201 Created

Successful case. A representation of the created Individual Data Reporting Configuration resource is returned.

The URI of the created resource shall be returned in an HTTP "Location" header.

NOTE 1: 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.

NOTE 2: The “dataReportingConfigurationId” attribute of the DataReportingConfiguration data type shall not be provided as it is not applicable.

Table 5.24.2.4.3.1-4: Headers supported by the 201 response code on this resource

HTTP response header	Data type	P	Cardinality	Description
Location	string	M	1	The URI of the newly created resource, according to the structure: {apiRoot}/3gpp-data-reporting-provisioning /v1/sessions/{sessionId}/configurations

Table 5.24.2.4.3.1-5: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative target URI located in an alternative NEF.

Table 5.24.2.4.3.1-6: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative target URI of the resource located in an alternative NEF.

5.24.2.5 Resource: Individual Data Reporting Configuration

5.24.2.5.1 Introduction

This resource represents an Individual Data Reporting Configuration resource managed by the NEF.

This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [3]).

5.24.2.5.2 Resource Definition

Resource URL: {apiRoot}/3gpp-data-reporting-provisioning/v1/sessions/{sessionId}/configurations/{configurationId}

This resource shall support the resource URI variables defined in table 5.24.2.5.2-1.

Table 5.24.2.5.2-1: Resource URL variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.24.1
sessionId	string	Represents the identifier of the Individual Data Reporting Provisioning Session resource.
configurationId	string	Represents the identifier of the Individual Data Reporting Configuration resource.

5.24.2.5.3 Resource standard methods

5.24.2.5.3.2 GET

This method enables an AF to retrieve an existing Individual Data Reporting Configuration resource at the NEF.

This method shall support the URI query parameters specified in table 5.24.2.5.3.2-1.

Table 5.24.2.5.3.2-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 5.24.2.5.3.2-2 and the response data structures and response codes specified in table 5.24.2.5.3.2-3.

Table 5.24.2.5.3.2-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.24.2.5.3.2-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingConfiguration (NOTE 2)	M	1	200 OK	Successful case. The requested Individual Data Reporting Configuration resource is returned to the AF.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE 1: The mandatory HTTP error status code for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. NOTE 2: The “dataReportingConfigurationId” attribute of the DataReportingConfiguration data type shall not be provided as it is not applicable.

Table 5.24.2.5.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 target URI located in an alternative NEF.

Table 5.24.2.5.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 target URI of the resource located in an alternative NEF.

5.24.2.5.3.3 PUT

This method enables an AF to update an existing Individual Data Reporting Configuration resource at the NEF.

This method shall support the URI query parameters specified in table 5.24.2.5.3.3-1.

Table 5.24.2.5.3.3-1: URI query parameters supported by the PUT method on this resource

Name	Data type	P	Cardinality	Description

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

Table 5.24.2.5.3.3-2: Data structures supported by the PUT request body on this resource

Data type

Cardinality

Description

DataReportingConfiguration

(NOTE)

Parameters to updatethe Individual Data Reporting Configuration resource.

NOTE: The “dataReportingConfigurationId” attribute of the DataReportingConfiguration data type shall not be provided as it is not applicable.

Table 5.24.2.5.3.3-3: Data structures supported by the PUT response body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingConfiguration (NOTE 2)	M	1	200 OK	The Individual Data Reporting Configuration resource was updated successfully and a representation of the updated resource is returned in the response body.
n/a			204 No Content	The Individual Data Reporting Configuration resource was successfully updated and no content is to be returned in the response body.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. NOTE 2: The “dataReportingConfigurationId” attribute of the DataReportingConfiguration data type shall not be provided as it is not applicable.

Table 5.24.2.5.3.3-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 NEF.

Table 5.24.2.5.3.3-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 NEF.

5.24.2.5.3.3A PATCH

The PATCH method is used to modify an existing Individual Data Reporting Configuration resource.

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

Table 5.24.2.5.3.3A-1: Data structures supported by the PATCH request body on this resource

Data type	P	Cardinality	Description
DataReportingConfigurationPatch	M	1	Parameters to modify for a Data Reporting Configuration resource.

Table 5.24.2.5.3.3A-2: Data structures supported by the PATCH response body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingConfiguration (NOTE 2)	M	1	200 OK	The Data Reporting Configuration resource was updated successfully by configuration data provided.
n/a			204 No Content	The Data Reporting Configuration resource was successfully updated and no content is to be returned in the response body.
n/a			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
n/a			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE 1: The mandadatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. NOTE 2: The “dataReportingConfigurationId” attribute of the DataReportingConfiguration data type shall not be provided as it is not applicable.

Table 5.24.2.5.3.3A-3: 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 NEF.

Table 5.24.2.5.3.3A-4: 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 NEF.

5.24.2.5.3.4 DELETE

This method enables an AF to request the deletion of an existing Individual Data Reporting Configuration resource at the NEF.

This method shall support the URI query parameters specified in table 5.24.2.5.3.4-1.

Table 5.24.2.5.3.4-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.24.2.5.3.4-2 and the response data structures and response codes specified in table 5.24.2.5.3.4-3.

Table 5.24.2.5.3.4-2: Data structures supported by the DELETE request body on this resource

Data type	P	Cardinality	Description
n/a

Table 5.24.2.5.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 response. The Data Reporting Configuration resource was successfully deleted.
			307 Temporary Redirect	Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
			308 Permanent Redirect	Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.24.2.5.3.4-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 NEF.

Table 5.24.2.5.3.4-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 NEF.

5.24.3 Custom Operations without associated resources

There are no custom operations without associated resources defined for this API in this release of the specification.

5.24.4 Notifications

There are no notifications defined for this API in this release of the specification.

5.24.5 Data Model

5.24.5.1 General

This subclause specifies the application data model supported by the DataReportingProvisioning API. Table 5.24.5.1-1 specifies the data types defined for the DataReportingProvisioning API.

Table 5.24.5.1-1: DataReportingProvisioning specific Data Types

Data type	Clause defined	Description
n/a

Table 5.24.5.1-2 specifies data types re-used by the DataReportingProvisioning API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the DataReportingProvisioning API.

Table 5.24.5.1-2: DataReportingProvisioning re-used Data Types

Data type	Reference	Comments	Applicability
DataReportingProvisioningSession	3GPP TS 26.532 [60]	Configuration by the AF specifying the data to be collected, processed and reported.
DataReportingConfiguration	3GPP TS 26.532 [60]	Configuration data related to UE data collection and reporting.
DataReportingConfigurationPatch	3GPP TS 26.532 [60]	Contains the requested modifications to the configuration data regarding UE data collection and reporting.

5.24.6 Used Features

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

Table 5.24.6-1: Features used by DataReportingProvisioning API

Feature number	Feature Name	Description

5.24.7 Error handling

5.24.7.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 subclauses shall apply.

5.24.7.2 Protocol Errors

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

5.24.7.3 Application Errors

The application errors defined for the DataReportingProvisioning API are listed in table 5.24.7.3-1.

Table 5.24.7.3-1: Application errors

Application Error	HTTP status code	Description