Content for TS 26.532 Word version: 18.5.0

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

7.1 General 7.2 Resources 7.3 Data model 7.4 Error handling 7.5 Mediation by NEF
...

7 Ndcaf_DataReporting service p. 49

7.1 General p. 49

This clause specifies the APIs used by clients of the Data Collection AF to obtain a data collection and reporting configuration from, and then report data to, the Data Collection AF.

7.2 Resources p. 49

7.2.1 Resource structure p. 49

Figure 7.2.1-1 depicts the URL path model for the Ndcaf_DataReporting service.

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

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

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

Table 7.2.1-1: Resources and methods overview

Service name	Operation name	Resource name	Resource path suffix	HTTP method or custom operation path suffix	Description
Ndcaf_DataReporting	CreateSession	Data Reporting Sessions	/sessions	POST	Data collection client establishes a UE data reporting session with the Data Collection AF, providing information about what UE data it can report, and is provided with a configuration in response.
	RetrieveSession	Data Reporting Session	/sessions/{sessionId}	GET	Retrieves a Data Reporting Session resource from the Data Collection AF.
	DestroySession			DELETE	Destroys a Data Reporting Session resource.
	Report			/report (POST)	Data collection client reports data to the Data Collection AF via the established Data Reporting Session.

7.2.2 Data Reporting Sessions resource collection p. 50

The Data Reporting Sessions resource collection represents the set of all Data Collection Sessions at a given Data Collection AF (service) instance. The resource collection allows a data collection client to create a new Data Reporting Session resource at, and to receive configuration details for that session from, the Data Collection AF.

7.2.2.2 Resource definition p. 50

Resource URL:

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

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

Table 7.2.2.2-1: Resource URL variables for this resource

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

7.2.2.3 Resource standard methods p. 50

7.2.2.3.1 Ndcaf_DataReporting_CreateSession operation using POST method p. 50

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

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

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

Data type	P	Cardinality	Description
DataReportingSession	M	1	Data supplied by the data collection client to enable creation of a new Data Reporting Session at the Data Collection AF.

Table 7.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 data collection client. (NOTE 1)
Origin	string	O	0..1	Indicates the origin of the requester. (NOTE 2)
NOTE 1: 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. NOTE 2: The Origin header is always supplied if the data collection client is deployed in a web browser.

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

Data type	P	Cardinality	Response codes	Description
DataReportingSession	M	1	201 Created	The creation of a Data Reporting Session is confirmed and configuration data for the data collection client for the session is provided 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 7.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.
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

7.2.3 Data Reporting Session resource p. 52

7.2.3.1 Description p. 52

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

7.2.3.2 Resource definition p. 52

Resource URL:

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

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

Table 7.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	Identifies a Data Reporting Session at the Data Collection AF.

7.2.3.3 Resource standard methods p. 52

7.2.3.3.1 Ndcaf_DataReporting_RetrieveSession operation using GET method p. 52

This service operation shall support the URL query parameters specified in Table 7.2.3.3.1-1 and the request headers specified in Table 7.2.3.3.1-2.

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

Name	Data type	P	Cardinality	Description

Table 7.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 data collection client. NOTE 1
Origin	string	O	0..1	Indicates the origin of the requester. NOTE 2
NOTE 1: 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. NOTE 2: The Origin header is always supplied if the data collection client is deployed in a Web Browser.

This service operation shall support the response data structures and response codes specified in Table 7.2.3.3.1-3.

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

Data type	P	Cardinality	Response codes	Description
DataReportingSession	M	1	200 OK	The requested Data Reporting 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 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 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 Session resource does not exist. (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 7.4.

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

7.2.3.3.2 Ndcaf_DataReporting_UpdateSession operation using PUT method p. 54

The update operation is not permitted on the Data Reporting Session resource.

7.2.3.3.3 Ndcaf_DataReporting_DestroySession operation using DELETE method p. 54

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

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

Name	Data type	P	Cardinality	Description

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

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

Data type	P	Cardinality	Description

Table 7.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 data collection client. (NOTE 1)
Origin	string	O	0..1	Indicates the origin of the requester. (NOTE 2)
NOTE 1: 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. NOTE 1: The Origin header is always supplied if the data collection client is deployed in a web browser.

Table 7.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	Successful case: The Data Reporting Session resource matching the sessionId was destroyed at the Data Collection AF.
ProblemDetails	O	0..1	307 Temporary Redirect	Temporary redirection during Data Reporting 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 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 Session resource does not exist. (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 7.4.

Table 7.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 7.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, DELETE.
Access-Control-Expose-Headers	string	O	0..1	Part of CORS [10]. Supplied if the request included the Origin header. Valid values: Location.

7.2.3.4 Resource custom operations p. 55

7.2.3.4.1 Ndcaf_DataReporting_Report operation using POST method p. 55

This operation shall support the URI query parameters specified in Table 7.2.3.4.1-1.

Table 7.2.3.4.1-1: URI query parameters supported by the POST method on this resource

Parameter	Data type	P	Cardinality	Description

This operation shall support the request data structures specified in Table 7.2.3.4.1-2 and the request headers specified in Table 7.2.3.4.1-3.

Table 7.2.3.4.1-2: Data structures supported by the POST request body

Data type	P	Cardinality	Description
DataReport	M	1	UE data reported by the data collection client.

Table 7.2.3.4.1-3: Headers supported for POST requests

HTTP request header	Data type	P	Cardinality	Description
Authorization	string	M	1	For authentication of the data collection client. (NOTE 1)
Origin	string	O	0..1	Indicates the origin of the requester. (NOTE 2)
NOTE 1: 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. NOTE 2: The Origin header is always supplied if the data collection client is deployed in a web browser.

This operation shall support the response data structures and response codes specified in Table 7.2.3.4.1-4 and the response headers specified in Table 7.2.3.4.1-5.

Table 7.2.3.4.1-4: Data structures supported by the POST response body

Data type	P	Cardinality	Response codes	Description
DataReportingSession	O	0..1	200 OK	The report was accepted by the Data Collection AF. A data collection client configuration (updated or unchanged) is provided in the response.
n/a			204 No Content	The report was accepted by the Data Collection AF and no content is returned in the response body.
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 7.2.3.4.1-5: Headers supported by the 200 response code

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. Value: POST

7.3 Data model p. 56

7.3.1 General p. 56

Table 7.3.1-1 specifies the data types used by the Ndcaf_DataReporting service operations.

Table 7.3.1-1: Data types used by Ndcaf_DataReporting service operations

Data type	Clause defined	Description
DataReportingSession	7.3.2.1	Configuration exposed by the Data Collection AF to a data collection client, specifying the UE data to be reported.
DataReport	7.3.2.3	A set of UE data reported by the data collection client to the Data Collection AF.

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

Table 7.3.1-2: Externally defined data types used by Ndcaf_DataReporting service operations

Data type	Comments	Reference
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

7.3.2 Structured data types p. 57

7.3.2.1 DataReportingSession resource type p. 57

Table 7.3.2.1-1: Definition of DataReportingSession resource type

Property name	Data type	Cardinality	Usage	Description
sessionId	string	1..1	C: RO R: RO	Unique identifier for this Data Reporting Session assigned by the Data Collection AF.
validUntil	DateTime	1..1	C: RO R: RO	This property is deprecated and should be omitted. If present, it shall be ignored. HTTP cache control headers should instead be used to indicate the validity of the Data Reporting Session resource.
externalApplicationId	ApplicationID	1..1	C: RW R: RO	The external application identifier, nominated by the data collection client, to which this Data Reporting Session pertains.
supportedDomains	array(DataDomain)	1..1	C: RW R: RO	Set of domains for which the data collection client declares that it is able to report UE data. (See clause 7.3.3.1). An empty array indicates that no UE data can currently be reported.
samplingRules	map(DataDomain → array(DataSamplingRule))	1..1	C: RO R: RO	A map specifying for each reporting domain listed a set of rules for sampling UE data (see clause 5.4.2.1). The indices of the map shall be a subset of the reporting domains declared by the data collection client in supportedDomains. If the array for a particular index in the map is empty, UE data collection shall be disabled for the indicated domain.
reportingConditions	map(DataDomain → array(DataReportingCondition))	1..1	C: RO R: RO	A map specifying for each reporting domain listed the set of conditions (see clause 5.4.2.1A) under which the data collection client reports UE data. The indices of the map shall be a subset of the reporting domains declared by the data collection client in supportedDomains. If the array for a particular index in the map is empty, UE data reporting shall be disabled for the indicated domain.
reportingRules	map(DataDomain → array(DataReportingRule)	1..1	C: RO R: RO	A map specifying for each reporting domain listed a set of rules for reporting collected UE data (see clause 5.4.2.2). The indices of the map shall be a subset of the reporting domains declared by the data collection client in supportedDomains. If the array for a particular index in the map is empty, UE data reporting shall be disabled for the indicated domain.

7.3.2.2 Void

7.3.2.3 DataReport type p. 58

Table 7.3.2.3-1: Definition of DataReport type

Property name	Data type	Cardinality	Description
externalApplicationId	ApplicationID	1	External application identifier.
expedite	boolean	0..1	If present and true, this data report contains UE data requiring expedited processing by the recipient.
serviceExperienceRecords	array(ServiceExperienceRecord)	0..1 (see NOTE)	See clause A.2.
locationRecords	array(LocationRecord)		See clause A.3.
communicationRecords	array(CommunicationRecord)		See clause A.4.
performanceDataRecords	array(PerformanceDataRecord)		See clause A.5.
applicationSpecificRecords	array(ApplicationSpecificRecord)		See clause A.6.
tripPlanRecords	array(TripPlanRecord)		See clause A.7.
mediaStreamingAccessRecords	array(MediaStreamingAccessRecord)		See clause 17.2 of TS 26.512.
aNBRNetworkAssistanceInvocationRecords	array(NetworkAssistanceInvocationRecord)		See clause 17A.2 of TS 26.512.
NOTE: Exactly one of these properties must be present in a DataReport.

7.3.3 Simple data types and enumerations p. 59

7.3.3.1 DataDomain enumeration p. 59

Table 7.3.3.1-1: DataDomain enumeration

Enumeration value	Description	Applicability (refer to Table 7.3.2.3-1)
SERVICE_EXPERIENCE	Service Experience data.	serviceExperienceRecords
LOCATION	Location data.	locationRecords
COMMUNICATION	Communication data.	communicationRecords
PERFORMANCE	Performance data.	performanceDataRecords
APPLICATION_SPECIFIC	Combination of QoE metrics and application service-specific data.	applicationSpecificRecords
MS_ANBR_NETWORK_ASSISTANCE	ANBR-based Network Assistance invocation data.	aNBRNetworkAssistanceInvocationRecords
MS_ACCESS_ACTIVITY	5GMS access activity data.	mediaStreamingAccessRecords
PLANNED_TRIPS	Data related to planned trips.	tripPlanRecords

7.3.3.2 Void

7.3.3.3 Void

7.4 Error handling p. 59

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

7.5 Mediation by NEF p. 59

NEF mediation of data collection client access to the data collection and reporting configuration API exposed by the Data Collection AF is applicable strictly to the Indirect Data Collection Client and the AS.

In the event that the Indirect Data Collection Client 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_DataReporting service API specified in TS 29.522.
In the event that the AS 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.4 of TS 26.531), the NEF shall be employed to mediate the interactions between them, via the Nnef_DataReporting service API specified in TS 29.522.