Content for TS 26.532 Word version: 18.5.0

1… 4… 5… 6… 7… 8… 9… A… B…

6.1 General 6.2 Resources 6.3 Data model 6.4 Error handling 6.5 Mediation by NEF
...

6 Ndcaf_DataReportingProvisioning service p. 30

6.1 General p. 30

This clause specifies the API used by the Provisioning AF of an Application Service Provider to create and manage one or more Data Reporting Provisioning Session resources in the Data Collection AF, and for each Data Reporting Provisioning Session, to create and manipulate its subordinate Data Reporting Configuration resource.

6.2 Resources p. 30

6.2.1 Resource structure p. 30

Figure 6.2.1-1 depicts the URL path model for the Ndcaf_DataReportingProvisioning service.

Copy of original 3GPP image for 3GPP TS 26.532, Fig. 6.2.1-1: URL path model of Ndcaf_DataReportingProvisioning service API

Figure 6.2.1-1: URL path model of Ndcaf_DataReportingProvisioning service API
(⇒ copy of original 3GPP image)

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

Table 6.2.1-1: Resources and methods overview

Service name	Operation name	Resource name	Resource path suffix	HTTP method	Description
Ndcaf_DataReportingProvisioning	CreateSession	Data Reporting Provisioning Sessions collection	/sessions	POST	Provisioning AF establishes a Data Reporting Provisioning Session resource at the Data Collection AF.
	RetrieveSession	Data Reporting Provisioning Session	/sessions/{sessionId}	GET	Retrieves an existing Data Reporting Provisioning Session resource from the Data Collection AF.
	DestroySession	Data Reporting Provisioning Session	/sessions/{sessionId}	DELETE	Destroys a Data Reporting Provisioning Session resource.
	CreateConfiguration	Data Reporting Configurations collection	/sessions/{sessionId}/configurations	POST	Creates a Data Reporting Configuration resource at the Data Collection AF.
	RetrieveConfiguration	Data Reporting Configuration	/sessions/{sessionId}/configurations/{configurationId}	GET	Retrieves an existing Data Reporting Configuration resource from the Data Collection AF.
	UpdateConfiguration			PUT, PATCH	Modifies an existing Data Reporting Configuration resource at the Data Collection AF.
	DestroyConfiguration			DELETE	Destroys a Data Reporting Configuration resource at the Data Collection AF.

6.2.2 Data Reporting Provisioning Sessions resource collection p. 31

6.2.2.1 Description p. 31

The Data Reporting Provisioning Sessions resource collection represents the set of all Data Reporting Provisioning Sessions at a given Data Collection AF (service) instance. The resource collection enables a Provisioning AF to create and manage individual Data Reporting Provisioning Session resources at the Data Collection AF.

6.2.2.2 Resource definition p. 31

Resource URL:

{apiRoot}/3gpp-ndcaf_data-reporting-provisioning/{apiVersion}/sessions

This resource shall support the resource URL variables defined in Table 6.2.2.2-1.

Table 6.2.2.2-1: Resource URL variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.2.
apiVersion		See clause 5.2.

6.2.2.3 Resource Standard Methods p. 32

6.2.2.3.1 Ndcaf_DataReportingProvisioning_CreateSession operation using POST method p. 32

This service operation shall support the URL query parameters specified in Table 6.2.2.3.1-1.

Table 6.2.2.3.1-1: URL query parameters supported by the POST method on this resource

Parameter	Data type	P	Cardinality	Description

This service operation shall support the request data structures specified in Table 6.2.2.3.1-2, the request headers specified in Table 6.2.2.3.1-3. and the response data structures and response codes specified in Table 6.2.2.3.1-4.

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

Data type	P	Cardinality	Description
DataReportingProvisioningSession	M	1	Data supplied by the Provisioning AF to enable creation of a new Data Reporting Provisioning Session at the Data Collection AF.

Table 6.2.2.3.1-3: Headers supported for POST requests on this resource

HTTP request header	Data type	P	Cardinality	Description
Authorization	string	M	1	For authentication of the Provisioning AF (see NOTE).
Origin	string	O	0..1	Indicates the origin of the requester.
NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see Section 2.1 of RFC 6750.

Table 6.2.2.3.1-4: Data structures supported by the POST response body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingProvisioningSession	M	1	201 Created	The creation of a Data Reporting Provisioning Session resource is confirmed by the Data Collection AF.
NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of TS 29.500 also apply.

Table 6.2.2.3.1-5: Headers supported by the 201 (Created) response code on this resource

HTTP response header	Data type	P	Cardinality	Description
Location	string	M	1	The URL of the newly created resource at the Data Collection AF, according to the structure: {apiRoot}/ndcaf-data-reporting-provisioning/{apiVersion}/sessions/{sessionId}
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, DELETE
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location

6.2.3 Data Reporting Provisioning Session resource p. 33

6.2.3.1 Description p. 33

The Data Reporting Provisioning Session resource represents a single session within the collection of Data Reporting Provisioning Sessions at a given Data Collection AF service instance.

6.2.3.2 Resource definition p. 33

Resource URL:

{apiRoot}/3gpp-ndcaf_data-reporting-provisioning/{apiVersion}/sessions/{sessionionId}

This resource shall support the resource URI variables defined in Table 6.2.3.2-1.

Table 6.2.3.2-1: Resource URL variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.2.
apiVersion	String	See clause 5.2
sessionId	string	Identifier of the Data Reporting Provisioning Session at the Data Collection AF.

6.2.3.3 Resource standard methods p. 33

6.2.3.3.1 Ndcaf_DataReportingProvisioning_RetrieveSession operation using GET method p. 33

This method shall support the URL query parameters specified in Table 6.2.3.3.1-1 and the request headers specified in Table 6.2.3.3.1-2.

Table 6.2.3.3.1-1: URL query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description

Table 6.2.3.3.1-2: Headers supported for GET requests on this resource

HTTP request header	Data type	P	Cardinality	Description
Authorization	string	M	1	For authentication of the Provisioning AF (see NOTE).
Origin	string	O	0..1	Indicates the origin of the requester.
NOTE: If OAuth 2.0 authorization is used, the value is Bearer followed by a string representing the access token, see Section 2.1 of RFC 6750.

This method shall support the response data structures and response codes specified in Table 6.2.3.3.1-3.

Table 6.2.3.3.1-3: Data structures supported by the GET response body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingProvisioningSession	M	1	200 OK	The requested Data Reporting Provisioning Session resource is returned to the Provisioning AF by the Data Collection AF.
ProblemDetails	O	0..1	307 Temporary Redirect	Temporary redirection during a Data Reporting Session Provisioning session retrieval procedure. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" (Extended Support of HTTP 307/308 redirection as defined in TS 29.502) is supported.
ProblemDetails	O	0..1	308 Permanent Redirect	Permanent redirection during a Data Reporting Session Provisioning session retrieval procedure. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" is supported.
ProblemDetails	O	0..1	404 Not Found	This Data Reporting Provisioning Session resource does not exist (see NOTE 2).
NOTE 1: The mandatory HTTP error status codes for the GET method as listed in Table 5.2.7.1-1 of TS 29.500 also apply. NOTE 2: Failure cases are described in subclause 6.2.4.

Table 6.2.3.3.1-4: Headers supported by the 200 response code on this resource

HTTP response header	Data type	P	Cardinality	Description
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, DELETE.
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location.

Table 6.2.3.3.1-5: Headers supported by the 307 and 308 response codes on this resource

HTTP response header	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URL of the resource located in another Data Collection AF (service) instance.
3gpp-Sbi-Target-Nf-Id	string	O	0..1	Identifier of the target NF (service) instance towards which the request is redirected
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, DELETE
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location

6.2.3.3.2 Ndcaf_DataReportingProvisioning_UpdateSession operation p. 35

The PUT or PATCH method shall not be used as the update operation is not permitted on the Data Reporting Provisioning Session resource.

6.2.3.3.3 Ndcaf_DataReportingProvisioning_DestroySession operation using DELETE method p. 35

This service operation shall support the URL query parameters specified in Table 6.2.3.3.3-1.

Table 6.2.3.3.3-1: URL query parameters supported by the DELETE method on this resource

Name	Data type	P	Cardinality	Description

This method shall support the request data structures and headers as specified in Table 6.2.3.3.3-2 and Table 6.2.3.3.3-3. Furthermore, this method shall support the response data structures as specified in Table 6.2.3.3.3-4, and the different response codes as specified in Table 6.2.3.3.3-5 and Table 6.2.3.3.3-6.

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

Data type	P	Cardinality	Description

Table 6.2.3.3.3-3: Headers supported for DELETE requests on this resource

HTTP request header	Data type	P	Cardinality	Description
Authorization	string	M	1	For authentication of the Provisioning AF (see NOTE).
Origin	string	O	0..1	Indicates the origin of the requester.)
NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see Section 2.1 of RFC 6750.

Table 6.2.3.3.3-4: Data structures supported by the DELETE response body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Success case: The Data Reporting Provisioning Session resource matching the sessionId was destroyed at the Data Collection AF.
ProblemDetails	O	0..1	307 Temporary Redirect	Temporary redirection during Data Reporting Provisioning Session destruction. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" as defined in TS 29.502 is supported.
ProblemDetails	O	0..1	308 Permanent Redirect	Permanent redirection during Data Reporting Provisioning Session destruction. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" is supported.
ProblemDetails	O	0..1	404 Not Found	The Data Reporting Provisioning Session resource does not exist (see NOTE 2).
NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of TS 29.500 also apply. NOTE 2: Failure cases are described in subclause 6.2.4.

Table 6.2.3.3.3-5: Headers supported by the 204 response code on this resource

HTTP response header	Data type	P	Cardinality	Description
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, DELETE.
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location.

Table 6.2.3.3.3-6: Headers supported by the 307 and 308 response codes on this resource

HTTP response header	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URL of the resource located in another Data Collection AF (service) instance.
3gpp-Sbi-Target-Nf-Id	string	O	0..1	Identifier of the target NF (service) instance towards which the request is redirected
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10].Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, PATCH, DELETE.
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location.

6.2.4 Data Reporting Configurations resource collection p. 36

6.2.4.1 Description p. 36

The Data Reporting Configurations resource collection represents the set of all Data Reporting Configurations that have been created within the scope of a particular Data Reporting Provisioning Session at a given Data CollectionAF (service) instance. The resource collection enables a Provisioning AF to create and manage individual Data Reporting Configuration resources at the Data Collection AF.

6.2.4.2 Resource definition p. 36

Resource URL:

{apiRoot}/3gpp-ndcaf_data-reporting-provisioning/{apiVersion}/sessions/{sessionId}/configurations/

This resource shall support the resource URL variables defined in Table 6.2.4.2-1.

Table 6.2.4.2-1: Resource URL variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.2.
apiVersion		See clause 5.2.
sessionId	ResourceId	Identifier of the Data Reporting Provisioning Session resource at the Data Collection AF.

6.2.4.3 Resource standard methods p. 37

6.2.4.3.1 Ndcaf_DataReportingProvisioning_CreateConfiguration operation using POST method p. 37

This service operation shall support the URL query parameters specified in Table 6.2.4.3.1-1.

Table 6.2.4.3.1-1: URL query parameters supported by the POST method on this resource

Parameter	Data type	P	Cardinality	Description

This service operation shall support the request data structures and headers specified in Table 6.2.4.3.1-2 and Table 6.2.4.3.1-3, respectively, and the response data structures and response codes specified in Table 6.2.4.3.1-4.

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

Data type	P	Cardinality	Description
DataReportingConfiguration	M	1	Configuration data supplied by the Provisioning AF to the Data Collection AF regarding UE data collection and reporting by data collection clients, and subsequent event exposure by the Data Collection AF.

Table 6.2.4.3.1-3: Headers supported for POST requests on this resource

HTTP request header	Data type	P	Cardinality	Description
Authorization	string	M	1	For authentication of the Provisioning AF (see NOTE).
Origin	string	O	0..1	Indicates the origin of the requester.
NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see Section 2.1 of RFC 6750.

Table 6.2.4.3.1-4: Data structures supported by the POST response body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingConfiguration	M	1	201 Created	The creation of a Data Reporting Configuration resource is confirmed by the Data Collection AF.
NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of TS 29.500 also apply.

6.2.5 Data Reporting Configuration resource p. 37

6.2.5.1 Description p. 37

A Data Reporting Configuration represents a subordinate resource of a single Data Reporting Provisioning Session resource within the scope of an individual application of an Application Service Provider and associated event. As described in clause 4.2.3.3.2, it contains instructions for data collection clients regarding the collection, processing and reporting of UE data to the Data Collection AF, and may include data exposure restriction rules to be followed by the Data Collection AF for controlling event exposure by to subscriber entities.

6.2.5.2 Resource definition p. 38

Resource URL:

{apiRoot}/3gpp-ndcaf_data-reporting-provisioning/{apiVersion}/sessions/{sessionId}/configurations/{configurationId}

This resource shall support the resource URL variables defined in Table 6.2.5.2-1.

Table 6.2.5.2-1: Resource URL variables for this resource

Name	Data type	Definition
apiRoot	string	See clause 5.2.
apiVersion		See clause 5.2.
sessionId	ResourceId	Identifier of the Data Reporting Provisioning Session resource at the Data Collection AF.
configurationId	ResourceId	Identifier of the Data Reporting Configuration resource at the Data Collection AF.

6.2.5.3 Resource standard methods p. 38

6.2.5.3.1 Ndcaf_DataReportingProvisioning_RetrieveConfiguration operation using GET method p. 38

This method shall support the URL query parameters specified in Table 6.2.5.3.1-1 and the headers specified in Table 6.2.5.3.1-2.

Table 6.2.5.3.1-1: URL query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description

Table 6.2.5.3.1-2: Headers supported for GET requests on this resource

HTTP request header	Data type	P	Cardinality	Description
Authorization	string	M	1	For authentication of the Provisioning AF (see NOTE).
Origin	string	O	0..1	Indicates the origin of the requester.
NOTE: If OAuth 2.0 authorization is used, the value is Bearer followed by a string representing the access token, see Section 2.1 of RFC 6750.

This method shall support the response data structures and response codes specified in Table 6.2.5.3.1-3.

Table 6.2.5.3.1-3: Data structures supported by the GET response body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingConfiguration	M	1	200 OK	The requested Data Reporting Configuration resource is returned to the Provisioning AF by the Data Collection AF.
ProblemDetails	O	0..1	307 Temporary Redirect	Temporary redirection during a Data Reporting Configuration retrieval procedure. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" (Extended Support of HTTP 307/308 redirection as defined in TS 29.502) is supported.
ProblemDetails	O	0..1	308 Permanent Redirect	Permanent redirection during a Data Reporting Session Configuration retrieval procedure. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" is supported.
ProblemDetails	O	0..1	404 Not Found	This Data Reporting Provisioning Session resource does not exist (see NOTE 2).
NOTE 1: The mandatory HTTP error status codes for the GET method as listed in Table 5.2.7.1-1 of TS 29.500 also apply. NOTE 2: Failure cases are described in clause 6.4.

Table 6.2.5.3.1-4: Headers supported by the 200 response code on this resource

HTTP response header	Data type	P	Cardinality	Description
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, DELETE.
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location.

Table 6.2.5.3.1-5: Headers supported by the 307 and 308 response codes on this resource

HTTP response header	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URL of the resource located in another Data Collection AF (service) instance.
3gpp-Sbi-Target-Nf-Id	string	O	0..1	Identifier of the target NF (service) instance towards which the request is redirected
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, DELETE
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location

6.2.5.3.2 Ndcaf_DataReportingProvisioning_UpdateConfiguration operation using PUT or PATCH method p. 40

This method shall support the URL query parameters specified in Table 6.2.5.3.2-1.

Table 6.2.5.3.2-1: URL query parameters supported by the PUT or PATCH method on this resource

Name	Data type	P	Cardinality	Description

The PUT and PATCH methods shall support the request data structures specified in Table 6.2.5.3.2-2 and Table 6.2.5.3.2-2a, respectively, the request headers specified in Table 6.2.5.3.2-3, and the response data structures and response codes specified in Table 6.2.5.3.2-4 and Table 6.2.5.3.2-5, respectively.

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

Data type	P	Cardinality	Description
DataReportingConfiguration	M	1	Parameters to replace an existing Data Reporting Configuration resource.

Table 6.2.5.3.2-2a: Data structures supported by the PATCH request body on this resource

Data type	P	Cardinality	Description
DataReportingConfigurationPatch	M	1	Parameters to modify an existing Data Reporting Configuration resource.

Table 6.2.5.3.2-3: Headers supported for PUT or PATCH requests on this resource

HTTP request header	Data type	P	Cardinality	Description
Authorization	string	M	1	For authentication of the Provisioning AF (see NOTE).
Origin	string	O	0..1	Indicates the origin of the requester.
NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see Section 2.1 of RFC 6750.

Table 6.2.5.3.2-4: Data structures supported by the PUT or PATCH response body on this resource

Data type	P	Cardinality	Response codes	Description
DataReportingConfiguration	M	1	200 OK	Confirmation of successful replacement or modification of a Data Reporting Configuration resource, along with a representation of the status of the update operation, carried in the response body, is returned by the Data Collection AF.
n/a		0	204 No Content	Confirmation of successful replacement or modification of a Data Reporting Configuration resource is returned by the Data Collection AF, without an associated response body.
ProblemDetails	O	0..1	307 Temporary Redirect	Temporary redirection, during a Data Reporting Configuration update operation. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" (Extended Support of HTTP 307/308 redirection as defined in TS 29.502) is supported.
ProblemDetails	O	0..1	308 Permanent Redirect	Permanent redirection, during a Data Reporting Configuration update operation. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" is supported.
ProblemDetails	O	0..1	404 Not Found	This Data Reporting Configuration resource does not exist (see NOTE 2).
NOTE 1: The mandatory HTTP error status codes for the PUT and PATCH methods listed in Table 5.2.7.1-1 of TS 29.500 also apply. NOTE 2: Failure cases are described in clause 6.4.

Table 6.2.5.3.2-5: Headers supported by the 200 or 204 response code on this resource

HTTP response header	Data type	P	Cardinality	Description
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, DELETE.
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location.

Table 6.2.5.3.2-6: Headers supported by the 307 and 308 response codes on this resource

HTTP response header	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URL of the resource located in another Data Collection AF (service) instance.
3gpp-Sbi-Target-Nf-Id	string	O	0..1	Identifier of the target NF (service) instance towards which the request is redirected
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, PATCH, DELETE
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location

6.2.5.3.3 Ndcaf_DataReportingProvisioning_DestroyConfiguration operation using DELETE method p. 42

This service operation shall support the URL query parameters specified in Table 6.2.5.3.3-1.

Table 6.2.5.3.3-1: URL query parameters supported by the DELETE method on this resourc

Name	Data type	P	Cardinality	Description

This method shall support the request data structures and headers specified in Table 6.2.5.3.3-2 and Table 6.2.5.3.3-3, respectively. Furthermore, this method shall support the response data structures specified in Table 6.2.5.3.3-4, and the different response codes specified in Table 6.2.5.3.3-5 and Table 6.2.5.3.3-6, respectively.

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

Data type	P	Cardinality	Description

Table 6.2.5.3.3-3: Headers supported for DELETE requests on this resource

HTTP request header	Data type	P	Cardinality	Description
Authorization	string	M	1	For authentication of the Provisioning AF (see NOTE).
Origin	string	O	0..1	Indicates the origin of the requester.)
NOTE: If OAuth 2.0 authorization is used the value is Bearer followed by a string representing the access token, see Section 2.1 of RFC 6750.

Table 6.2.5.3.3-4: Data structures supported by the DELETE response body on this resource

Data type	P	Cardinality	Response codes	Description
n/a			204 No Content	Success case: The Data Reporting Configuration resource matching the configurationId was destroyed at the Data Collection AF.
ProblemDetails	O	0..1	307 Temporary Redirect	Temporary redirection during Data Reporting Configuration destruction. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" as defined in TS 29.502 is supported.
ProblemDetails	O	0..1	308 Permanent Redirect	Permanent redirection during Data Reporting Configuration destruction. The response shall include a Location header field containing an alternative URL of the resource located in another Data Collection AF (service) instance. Applicable if the feature "ES3XX" is supported.
ProblemDetails	O	0..1	404 Not Found	The Data Reporting Configuration resource does not exist (see NOTE 2).
NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of TS 29.500 also apply. NOTE 2: Failure cases are described in clause 6.4.

Table 6.2.5.3.3-5: Headers supported by the 204 response code on this resource

HTTP response header	Data type	P	Cardinality	Description
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, DELETE.
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location.

Table 6.2.5.3.3-6: Headers supported by the 307 and 308 response codes on this resource

HTTP response header	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URL of the resource located in another Data Collection AF (service) instance.
3gpp-Sbi-Target-Nf-Id	string	O	0..1	Identifier of the target NF (service) instance towards which the request is redirected
Access-Control-Allow-Origin	string	O	0..1	Part of CORS [10].Supplied if the request included the Origin header.
Access-Control-Allow-Methods	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: POST, PUT, PATCH, DELETE.
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location.

6.3 Data model p. 44

6.3.1 General p. 44

Table 6.3.1-1 specifies the data types used by the Ndcaf_DataReportingProvisioning service operations.

Table 6.3.1-1: Data types specific to Ndcaf_DataReportingProvisioning service operations

Data type	Clause defined	Description
DataReportingProvisioningSession	6.3.2.1	A session provisioned in the Data Collection AF for the purpose of collecting, reporting and exposing UE data for a particular type of Event.
DataReportingConfiguration	6.3.2.2	The provisioned configuration for one type of data collection client within the scope of a Data Reporting Provisioning Session.
DataReportingConfigurationPatch	6.3.2.2A	Parameters to be modified in an existing provisioned configuration for one type of data collection client within the scope of a Data Reporting Provisioning Session.

Table 6.3.1-2 specifies data types re-used from other specifications by the Ndcaf_DataReportingProvisioning service operations, including a reference to their respective specifications.

Table 6.3.1-2: Externally defined data types used by Ndcaf_DataReportingProvisioning service operations

Data type	Comments	Reference
AfEvent	Identifies a type of event.	TS 29.517
ApplicationId	Identifies the reporting application.	TS 29.571
DateTime	A point in time, expressed as an ISO 8601 [25] date and time.
DurationSec	A period of time, expressed in seconds.
Double
Float
Int32
Int64
Uint16
Uint32
Uint64
Uinteger

6.3.2 Structured data types p. 45

6.3.2.1 DataReportingProvisioningSession resource type p. 45

Table 6.3.2.1-1: Definition of DataReportingProvisioningSession resource type

Property name	Data type	Cardinality	Usage	Description
provisioningSessionId	string	1..1	C: RO R: RO U: RO	A unique identifier for this Data Reporting Provisioning Session assigned by the Data Collection AF when the resource is created.
aspId	AspId	1..1	C: W R: RO U: RO	The identity of the Application Service Provider (as specified in clause 5.6.2.3 of TS 29.514) whose Provisioning AF is responsible for this Data Reporting Provisioning Session.
externalApplicationId	ApplicationID	1..1	C: RW R: RO U: RO	The external application identifier (see TS 29.571), nominated by the Provisioning AF, to which this Data Reporting Provisioning Session pertains, and which is present in data reports submitted to the Data Collection AF. This property may also be used by the Event Consumer AF (located outside trusted domain) to subscribe to events in the Data Collection AF (located inside trusted domain).
internalApplicationId	ApplicationID	0..1	C: RW R: RO U: RO	The internal application identifier (see TS 29.571) to be used by event consumers inside the trusted domain (including the NWDAF, the Event Consumer AF and the NEF) when subscribing to events in the Data Collection AF. This shall be provided by a Provisioning AF deployed inside the trusted domain when it creates a Data Reporting Provisioning Session. When the Provisioning AF is deployed outside the trusted domain, the NEF shall supply this property on behalf of the Provisioning AF by translating the externalApplicationId value supplied above into the corresponding internal application identifier here. Always present when this Data Reporting Provisioning Session is returned to an entity inside the trusted domain. Never present when the Data Reporting Provisioning Session is returned to an entity outside the trusted domain.
eventId	AfEvent	1..1	C: RW R: RO U: RO	The type of event to which this Data Reporting Provisioning Session pertains. (See clause 5.6.3.3 of TS 29.517.)
dataReportingConfigurationIds	array(ResourceId)	0..1	C: RO R: RO U: RO	A set of identifiers for Data Reporting Configurations currently associated with this Data Reporting Provisioning Session. Always present in responses from the Data Collection AF, but may be an empty array if there is no Data Reporting Configurations currently.

6.3.2.2 DataReportingConfiguration resource type p. 46

Table 6.3.2.2-1: Definition of DataReportingConfiguration resource type

Property name	Data type	Cardinality	Usage	Description
dataReportingConfigurationId	ResourceId	1..1	C: RO U: -	A unique identifier for this Data Reporting Configuration assigned by the Data Collection AF when the resource is created..
dataCollectionClientType	DataCollectionClientType	1..1	C: RW U: -	The type of data collection client to which this Data Reporting Configuration pertains (see clause 5.4.3.1).
authorizationURL	Url	0..1	C: RW U: RW	A URL that may be used to authorize the consumer entity prior to a data reporting subscription.
dataSamplingRules	array(DataSamplingRule)	0..1	C: RW U: RW	A set of definitions (see clause 5.4.2.1), each pertaining to the domain-specific parameters associated with the Event ID of the parent Data Reporting Provisioning Session, representing instructions on how UE data is to be sampled by the data collection client. If omitted or empty, each parameter shall be sampled at its default frequency in all locations.
dataReportingConditions	array(DataReportingCondition)	1..1	C: RW U: RW	A set of conditions (see clause 5.4.2.1A), each pertaining to the domain-specific parameters associated with the Event ID of the parent Data Reporting Provisioning Session, under which the data collection client reports UE data.
dataReportingRules	array(DataReportingRule)	0..1	C: RW U: RW	A set of definitions (see clause 5.4.2.2), each pertaining to the domain-specific parameters associated with the Event ID of the parent Data Reporting Provisioning Session and logged by the data collection client, representing instructions on how collected UE data is to be reported by the data collection client to the Data Collection AF. If omitted or empty, UE data shall be reported whenever the relevant reporting condition (see above) is met, using a default reporting format and data packaging strategy for the data domain associated with the Event ID of the parent Data Reporting Provisioning Session.
dataAccessProfiles	array(DataAccessProfile)	1..1	C: RW U: RW	One or more Data Access Profile definitions, each describing a set of data processing instructions, applied by the Data Collection AF when exposing events.

6.3.2.2A DataReportingConfigurationPatch resource type p. 47

Table 6.3.2.2A-1: Definition of DataReportingConfigurationPatch resource type

Property name	Data type	Cardinality	Usage	Description
authorizationURL	Url	0..1	C: RW U: RW	A URL that may be used to authorize the consumer entity prior to a data reporting subscription.
dataSamplingRules	array(DataSamplingRule)	0..1	C: RW U: RW	A set of definitions (see clause 5.4.2.1), each pertaining to the domain-specific parameters associated with the Event ID of the parent Data Reporting Provisioning Session, representing instructions on how UE data is to be sampled by the data collection client. If omitted or empty, each parameter shall be sampled at its default frequency in all locations.
dataReportingConditions	array(DataReportingCondition)	1..1	C: RW U: RW	A set of conditions (see clause 5.4.2.1A), each pertaining to the domain-specific parameters associated with the Event ID of the parent Data Reporting Provisioning Session, under which the data collection client reports UE data.
dataReportingRules	array(DataReportingRule)	0..1	C: RW U: RW	A set of definitions (see clause 5.4.2.2), each pertaining to the domain-specific parameters associated with the Event ID of the parent Data Reporting Provisioning Session and logged by the data collection client, representing instructions on how collected UE data is to be reported by the data collection client to the Data Collection AF. If omitted or empty, UE data shall be reported whenever the relevant reporting condition (see above) is met, using a default reporting format and data packaging strategy for the data domain associated with the Event ID of the parent Data Reporting Provisioning Session.
dataAccessProfiles	array(DataAccessProfile)	0..1	C: RW U: RW	One or more Data Access Profile definitions, each describing a set of data processing instructions, applied by the Data Collection AF when exposing events.

6.3.2.3 DataAccessProfile type p. 48

Table 6.3.2.3-1: Definition of DataAccessProfile type

Property name	Data type	Cardinality	Usage	Description
dataAccessProfileId	string	1..1	C: RW U: RW	A unique identifier for this Data Access Profile.
targetEventConsumerTypes	Array(EventConsumerType)	1..1	C:RW U:RW	The set of Event consumer types (see clause 6.3.3.1) to which this Data Access Profile is targeted. If the set is empty, this Data Access Profile applies to all types of Event consumer.
parameters	Array(String)	1..1	C:RW U:RW	The set of UE data parameters to be collected by the data collection client, and for which the restrictions specified by this Data Access Profile apply. The parameters are uniquely identified by a controlled vocabulary specific to the Event ID indicated by the parent Data Reporting Provisioning Session. If the set is empty, the restrictions apply to all parameters for the Event ID of the parent Data Reporting Provisioning Session.
timeAccessRestrictions	Object	0..1	C:RW U:RW	Configuration for access restrictions along the time dimension.
duration	DurationSec	1..1	C:RW U:RW	The period of time over which access is to be aggregated.
aggregationFunctions	Array(DataAggregationFunctionType)	1..1	C:RW U:RW	An ordered, non-empty list of aggregation functions (see clause 6.3.3.2) applied to the event data prior to exposure to event consumers.
userAccessRestrictions	Object	0..1	C:RW U:RW	Configuration for access restrictions along the user dimension.
groupIds	Array(GroupId)	1..1	C:RW U:RW	Identifiers of the UE groups over which access is to be aggregated.
userIds	Array(Gpsi) or Array(Supi)	1..1	C:RW U:RW	Identifiers of the UEs comprising a group over which access is to be aggregated.
aggregationFunctions	Array(DataAggregationFunctionType)	1..1	C:RW U:RW	An ordered, non-empty list of aggregation functions (see clause 6.3.3.2) applied to the event data prior to exposure to event consumers.
locationAccessRestrictions	Object	0..1	C:RW U:RW	Configuration for access restrictions along the location dimension
locationAreas	Array(LocationArea5G)	1..1	C:RW U:RW	Identifiers of geographical areas over which access is to be aggregated. Event data is grouped by the location of the UE during the data collection.
aggregationFunctions	Array(DataAggregationFunctionType)	1..1	C:RW U:RW	An ordered, non-empty list of aggregation functions (see clause 6.3.3.2) applied to the event data prior to exposure to event consumers.
NOTE: Data types DurationSec, GroupId, Gpsi, Supi and LocationArea5G are defined in TS 29.571.

6.3.3 Simple data types and enumerations p. 48

6.3.3.1 EventConsumerType enumeration p. 48

Table 6.3.3.1-1: Definition of EventConsumerType enumeration

Enumeration value	Description
NWDAF	The Network Data Analytics Function is the Event Consumer.
EVENT_CONSUMER_AF	The Event Consumer AF is the Event Consumer.
NEF	The Network Exposure Function is the Event Consumer.

6.3.3.2 DataAggregationFunctionType enumeration p. 49

Table 6.3.3.2-1: Definition of DataAggregationFunctionType enumeration

Enumeration value	Description
NONE	No aggregation is applied: all values of the UE data parameter(s) are exposed to event consumers.
COUNT	The number of observed events over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.
MEAN	The mean average of the values of the UE data parameter(s) over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.
MAXIMUM	The maximum observed value of the UE data parameter(s) over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.
MINIMUM	The minimum observed value of the UE data parameter(s) over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.
SUM	The sum of the values of the UE data parameter(s) over the indicated time period or the indicated set of users or the indicated set of locations is exposed to event consumers.

6.4 Error handling p. 49

Guidelines regarding error handling of API invocation associated with the Ndcaf_DataReportingProvisioning service are defined in clause 5.3.3.

6.5 Mediation by NEF p. 49

In the event that the Provisioning AF and the Data Collection AF are located in different trust domains, e.g., the former entity resides within the trusted domain and the latter entity resides outside the trusted domain (as in clause A.3 or A.4 of TS 26.531), the NEF shall be employed to mediate the interactions between them, via the Nnef_DataReportingProvisioning service API specified in TS 29.522.