Tech-
invite
3GPP
space
IETF
space
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TS 26.532
Word version: 18.2.1
1…
4…
4
Procedures for Data Collection and Reporting
5
General Aspects of APIs for Data Collection and Reporting
6
Ndcaf_DataReportingProvisioning service
7
Ndcaf_DataReporting service
8
UE Data Collection, Reporting and Notification API
9
Security and Access Control
10
Data packaging strategies
A
Data reporting data models
B
OpenAPI representation of REST APIs for data collection and reporting
$
Change history
4
Procedures for Data Collection and Reporting
p. 10
4.1
General
p. 10
4.2
Network-side procedures
p. 11
4.2.1
General
p. 11
4.2.2
Data Collection AF registration with NRF
p. 11
4.2.3
Data collection and reporting provisioning
p. 11
4.2.3.1
General
p. 11
4.2.3.2
Provisioning Session procedures
p. 11
4.2.3.2.1
General
p. 11
4.2.3.2.2
Create Provisioning Session
p. 11
4.2.3.2.3
Retrieve Provisioning Session properties
p. 11
4.2.3.2.4
Update Provisioning Session properties
p. 12
4.2.3.2.5
Destroy Provisioning Session
p. 12
4.2.3.3
Data Reporting Configuration procedures
p. 12
4.2.3.3.1
General
p. 12
4.2.3.3.2
Data Reporting Configuration entity
p. 12
4.2.3.3.3
Create Data Reporting Configuration
p. 12
4.2.3.3.4
Retrieve Data Reporting Configuration
p. 13
4.2.3.3.5
Update Data Reporting Configuration
p. 13
4.2.3.3.6
Destroy Data Reporting Configuration
p. 13
4.2.4
Configuration of Indirect Data Collection Client
p. 13
4.2.4.1
General
p. 13
4.2.4.2
Indirect Data Collection Client retrieves its initial configuration by creating a Data Reporting Session
p. 14
4.2.4.3
Updating and renewing data collection and reporting configuration
p. 14
4.2.4.3.1
Introduction
p. 14
4.2.4.3.2
Indirect Data Collection Client retrieves up-to-date configuration
p. 15
4.2.4.3.3
DataReportingSession updated in response to data reporting
p. 15
4.2.4.4
Indirect Data Collection Client destroys Data Reporting Session
p. 15
4.2.5
Configuration of Application Server
p. 16
4.2.5.1
General
p. 16
4.2.5.2
Application Server retrieves its initial configuration by creating a Data Reporting Session
p. 16
4.2.5.3
Updating and renewing data collection and reporting configuration
p. 16
4.2.5.3.1
Introduction
p. 16
4.2.5.3.2
Application Server retrieves up-to-date configuration
p. 17
4.2.5.3.3
DataReportingSession updated in response to data reporting
p. 17
4.2.5.4
Application Server destroys Data Reporting Session
p. 17
4.2.6
Indirect data reporting
p. 17
4.2.7
Reporting by Application Server
p. 18
4.2.8
Event subscription, management and publication
p. 19
4.3
UE-to-network procedures
p. 19
4.3.1
General
p. 19
4.3.2
Configuration of Direct Data Reporting Client
p. 19
4.3.2.1
General
p. 19
4.3.2.2
Direct Data Collection Client retrieves its initial configuration by creating a Data Reporting Session
p. 19
4.3.2.3
Updating and renewing data collection and reporting configuration
p. 20
4.3.2.3.1
Introduction
p. 20
4.3.2.3.2
Direct Data Collection Client retrieves up-to-date configuration
p. 20
4.3.2.3.3
DataReportingSession updated in response to data reporting
p. 20
4.3.2.4
Direct Data Collection Client destroys Data Reporting Session
p. 21
4.3.3
Direct data reporting
p. 21
4.4
UE-internal procedures
p. 22
4.4.1
General
p. 22
4.4.2
Application registration procedure
p. 22
4.4.4
Data reporting procedure
p. 22
4.4.5
Configuration update procedure
p. 22
4.4.6
Procedure for changing consent to report the UE identifier
p. 23
4.4.7
Procedure for changing the opaque client reporting identifier
p. 23
4.4.8
Application deregistration procedure
p. 23
5
General Aspects of APIs for Data Collection and Reporting
p. 23
5.1
Overview
p. 23
5.2
HTTP resource URIs and paths
p. 23
5.3
Usage of HTTP
p. 24
5.3.1
HTTP protocol version
p. 24
5.3.2
HTTP standard headers
p. 24
5.3.2.1
General
p. 24
5.3.2.2
Origin
p. 24
5.3.2.3
Content type
p. 24
5.3.2.4
Access-Control-Allow-Origin
p. 24
5.3.2.5
Access-Control-Allow-Methods
p. 24
5.3.2.6
Access-Control-Allow-Headers
p. 24
5.3.2.7
Cache-Control
|R18|
p. 24
5.3.3
HTTP response codes
p. 24
5.4
Common API data types
p. 25
5.4.0
General
p. 25
5.4.1
Simple data types
p. 25
5.4.2
Structured data types
p. 25
5.4.2.1
DataSamplingRule type
p. 25
5.4.2.1A
DataReportingCondition type
p. 26
5.4.2.2
DataReportingRule type
p. 26
5.4.3
Enumerated data types
p. 27
5.4.3.1
DataCollectionClientType enumeration
p. 27
5.4.3.2
DataReportingConditionType enumeration
p. 27
5.4.3.3
DataReportingEventTrigger enumeration
p. 27
5.5
Explanation of API data model notation
p. 27
6
Ndcaf_DataReportingProvisioning service
p. 28
6.1
General
p. 28
6.2
Resources
p. 28
6.2.1
Resource structure
p. 28
6.2.2
Data Reporting Provisioning Sessions resource collection
p. 29
6.2.2.1
Description
p. 29
6.2.2.2
Resource definition
p. 29
6.2.2.3
Resource Standard Methods
p. 30
6.2.2.3.1
Ndcaf_DataReportingProvisioning_CreateSession operation using POST method
p. 30
6.2.3
Data Reporting Provisioning Session resource
p. 31
6.2.3.1
Description
p. 31
6.2.3.2
Resource definition
p. 31
6.2.3.3
Resource standard methods
p. 31
6.2.3.3.1
Ndcaf_DataReportingProvisioning_RetrieveSession operation using GET method
p. 31
6.2.3.3.2
Ndcaf_DataReportingProvisioning_UpdateSession operation
p. 33
6.2.3.3.3
Ndcaf_DataReportingProvisioning_DestroySession operation using DELETE method
p. 33
6.2.4
Data Reporting Configurations resource collection
p. 34
6.2.4.1
Description
p. 34
6.2.4.2
Resource definition
p. 34
6.2.4.3
Resource standard methods
p. 35
6.2.4.3.1
Ndcaf_DataReportingProvisioning_CreateConfiguration operation using POST method
p. 35
6.2.5
Data Reporting Configuration resource
p. 35
6.2.5.1
Description
p. 35
6.2.5.2
Resource definition
p. 36
6.2.5.3
Resource standard methods
p. 36
6.2.5.3.1
Ndcaf_DataReportingProvisioning_RetrieveConfiguration operation using GET method
p. 36
6.2.5.3.2
Ndcaf_DataReportingProvisioning_UpdateConfiguration operation using PUT or PATCH method
p. 38
6.2.5.3.3
Ndcaf_DataReportingProvisioning_DestroyConfiguration operation using DELETE method
p. 40
6.3
Data model
p. 42
6.3.1
General
p. 42
6.3.2
Structured data types
p. 43
6.3.2.1
DataReportingProvisioningSession resource type
p. 43
6.3.2.2
DataReportingConfiguration resource type
p. 44
6.3.2.2A
DataReportingConfigurationPatch resource type
p. 45
6.3.2.3
DataAccessProfile type
p. 46
6.3.3
Simple data types and enumerations
p. 46
6.3.3.1
EventConsumerType enumeration
p. 46
6.3.3.2
DataAggregationFunctionType enumeration
p. 47
6.4
Error handling
p. 47
6.5
Mediation by NEF
p. 47
7
Ndcaf_DataReporting service
p. 47
7.1
General
p. 47
7.2
Resources
p. 47
7.2.1
Resource structure
p. 47
7.2.2
Data Reporting Sessions resource collection
p. 48
7.2.2.1
Description
p. 48
7.2.2.2
Resource definition
p. 48
7.2.2.3
Resource standard methods
p. 48
7.2.2.3.1
Ndcaf_DataReporting_CreateSession operation using POST method
p. 48
7.2.3
Data Reporting Session resource
p. 50
7.2.3.1
Description
p. 50
7.2.3.2
Resource definition
p. 50
7.2.3.3
Resource standard methods
p. 50
7.2.3.3.1
Ndcaf_DataReporting_RetrieveSession operation using GET method
p. 50
7.2.3.3.2
Ndcaf_DataReporting_UpdateSession operation using PUT method
p. 52
7.2.3.3.3
Ndcaf_DataReporting_DestroySession operation using DELETE method
p. 52
7.2.3.4
Resource custom operations
p. 53
7.2.3.4.1
Ndcaf_DataReporting_Report operation using POST method
p. 53
7.3
Data model
p. 54
7.3.1
General
p. 54
7.3.2
Structured data types
p. 55
7.3.2.1
DataReportingSession resource type
p. 55
7.3.2.2
Void
7.3.2.3
DataReport type
p. 56
7.3.3
Simple data types and enumerations
p. 57
7.3.3.1
DataDomain enumeration
p. 57
7.3.3.2
Void
7.3.3.3
Void
7.4
Error handling
p. 57
7.5
Mediation by NEF
p. 57
8
UE Data Collection, Reporting and Notification API
p. 57
8.1
Overview
p. 57
8.2
Direct Data Collection Client state model
p. 59
8.2.1
Overview
p. 59
8.2.2
Direct Data Collection Client internal operations
p. 60
8.2.3
Starting and stopping the Direct Data Collection Client
p. 60
8.3
Methods
p. 60
8.3.1
Overview
p. 60
9
Security and Access Control
p. 62
10
Data packaging strategies
p. 62
10.1
General
p. 62
10.2
Service Experience data packaging strategies
p. 62
10.3
Location data packaging strategies
p. 62
10.4
Communication data packaging strategies
p. 63
10.5
Performance data packaging strategies
p. 63
10.6
Application-specific data packaging strategies
p. 63
10.7
Planned trips data packaging strategies
p. 63
A
(Normative) Data reporting data models
p. 64
A.1
Introduction
p. 64
A.2
Service Experience reporting
p. 64
A.2.1
ServiceExperienceRecord type
p. 64
A.2.2
PerFlowServiceExperienceInfo type
p. 64
A.3
UE Location reporting
p. 65
A.3.1
LocationRecord type
p. 65
A.4
Communication reporting
p. 65
A.4.1
CommunicationRecord type
p. 65
A.5
Network performance Data reporting
p. 66
A.5.1
PerformanceDataRecord type
p. 66
A.6
Application-specific reporting
p. 66
A.6.0
Introduction
p. 66
A.6.1
ApplicationSpecificRecord type
p. 66
A.7
Trip Plan reporting
p. 67
A.7.0
Introduction
p. 67
A.7.1
TripPlanRecord type
p. 67
B
(Normative) OpenAPI representation of REST APIs for data collection and reporting
p. 68
B.1
General
p. 68
B.2
Data types applicable to multiple services
p. 68
B.3
Ndcaf_DataReportingProvisioning service API
p. 70
B.4
Ndcaf_DataReporting service API
p. 77
$
Change history
p. 84