Tech-invite 3GPPspace IETFspace

21 22 23 24 25 26 27 28 29 31 32 33 34 35 36 37 38 4‑5x

Content for TS 29.122 Word version: 18.4.0

1… 4.4… 4.4.3… 4.4.5… 4.4.7… 4.4.8… 4.4.12… 5… 5.6… 5.8… 5.10… 5.12… 6…

5.1 Introduction 5.2 Information applicable to several APIs 5.2.1 Data Types 5.2.2 Usage of HTTP 5.2.3 Content type 5.2.4 URI structure 5.2.5 Notifications 5.2.6 Error handling 5.2.7 Feature negotiation 5.2.8 HTTP custom headers 5.2.9 Conventions for Open API specification files 5.2.10 Redirection handling 5.2.11 Support of Load and Overload Control 5.2.12 Query parameters 5.2.13 Vendor-specific extensions 5.3 MonitoringEvent API 5.3.1 Overview 5.3.2 Data model 5.3.3 Resource structure 5.3.3A Notifications 5.3.4 Used Features 5.3.5 Error handling 5.4 ResourceManagementOfBdt API 5.4.1 Overview 5.4.2 Data model 5.4.3 Resource structure 5.4.3A Notifications 5.4.4 Used Features 5.4.5 Error handling 5.5 ChargeableParty API 5.5.1 Overview 5.5.2 Data model 5.5.3 Resource structure 5.5.3A Notifications 5.5.4 Used Features 5.5.5 Error handling
...

5 T8 APIs p. 54

5.1 Introduction p. 54

5.2 Information applicable to several APIs p. 55

5.2.1 Data Types p. 55

5.2.1.1 Introduction p. 55

5.2.1.2 Referenced structured data types p. 58

5.2.1.2.1 Type: SponsorInformation p. 58

5.2.1.2.2 Type: UsageThreshold p. 58

5.2.1.2.3 Type: TimeWindow p. 58

5.2.1.2.4 Type: Acknowledgement p. 59

5.2.1.2.5 Type: NotificationData p. 59

5.2.1.2.6 Type: EventReport p. 59

5.2.1.2.7 Type: AccumulatedUsage p. 59

5.2.1.2.8 Type: FlowInfo p. 59

5.2.1.2.9 Type: TestNotification p. 60

5.2.1.2.10 Type: WebsockNotifConfig p. 60

5.2.1.2.11 Type: LocationArea p. 60

5.2.1.2.12 Type: ProblemDetails p. 61

5.2.1.2.13 Type: InvalidParam p. 61

5.2.1.2.14 Type: PlmnId p. 62

5.2.1.2.15 Type: ConfigResult p. 62

5.2.1.2.16 Type: UsageThresholdRm p. 62

5.2.1.2.17 Type: LocationArea5G p. 62

5.2.1.2.18 Type: EthFlowInfo |R17| p. 63

5.2.1.3 Referenced Simple data types and enumerations p. 63

5.2.1.3.1 Introduction p. 63

5.2.1.3.2 Simple data types p. 63

5.2.1.3.3 Enumeration: Event p. 64

5.2.1.3.4 Enumeration: ResultReason p. 65

5.2.1.4 Conventions for documenting structured data types p. 65

5.2.2 Usage of HTTP p. 66

5.2.2.1 General p. 66

5.2.2.2 Usage of the HTTP PATCH method p. 66

5.2.3 Content type p. 66

5.2.4 URI structure p. 67

5.2.4.1 Resource URI structure |R17| p. 67

5.2.4.2 Custom operations URI structure |R17| p. 67

5.2.4.3 Callback URI structure |R17| p. 67

5.2.5 Notifications p. 68

5.2.5.1 General p. 68

5.2.5.2 Notification Delivery using a separate HTTP connection p. 68

5.2.5.3 Notification Test Event p. 68

5.2.5.4 Notification Delivery using Websocket p. 68

5.2.6 Error handling p. 70

5.2.7 Feature negotiation p. 72

5.2.8 HTTP custom headers p. 72

5.2.8.1 General p. 72

5.2.8.2 Reused HTTP custom headers p. 72

5.2.8.3.1 General |R17| p. 72

5.2.9 Conventions for Open API specification files p. 74

5.2.9.1 General p. 74

5.2.9.2 Formatting of OpenAPI files p. 74

5.2.9.3 Structured data types p. 74

5.2.9.4 Info p. 76

5.2.9.5 Servers p. 76

5.2.9.6 References to other 3GPP-defined Open API specification files p. 76

5.2.9.7 Server-initiated communication p. 77

5.2.9.8 Describing the body of HTTP PATCH requests p. 77

5.2.9.8.1 General |R17| p. 77

5.2.9.8.2 JSON Merge Patch |R17| p. 77

5.2.9.8.3 JSON PATCH |R17| p. 78

5.2.9.9 Error Responses p. 78

5.2.9.10 Enumerations p. 79

5.2.9.11 Read only attribute p. 80

5.2.9.12 externalDocs p. 80

5.2.9.13 Operation identifiers |R17| p. 80

5.2.9.14 Usage of the "tags" field |R17| p. 80

5.2.10 Redirection handling |R16| p. 81

5.2.11 Support of Load and Overload Control |R17| p. 81

5.2.12 Query parameters |R17| p. 82

5.2.13 Vendor-specific extensions |R18| p. 82

5.2.13.1 General p. 82

5.2.13.2 Vendor-specific extensions to the data model p. 82

5.2.13.3 Vendor-specific query parameters p. 83

5.3 MonitoringEvent API p. 84

5.3.1 Overview p. 84

5.3.2 Data model p. 84

5.3.2.1 Resource data types p. 84

5.3.2.1.1 Introduction p. 84

5.3.2.1.2 Type: MonitoringEventSubscription p. 87

5.3.2.1.3 Void

5.3.2.2 Notification data types p. 99

5.3.2.2.1 Introduction p. 99

5.3.2.2.2 Type: MonitoringNotification p. 99

5.3.2.3 Referenced structured data types p. 100

5.3.2.3.1 Introduction p. 100

5.3.2.3.2 Type: MonitoringEventReport p. 100

5.3.2.3.3 Type: IdleStatusInfo p. 104

5.3.2.3.4 Type: UePerLocationReport p. 104

5.3.2.3.5 Type: LocationInfo p. 104

5.3.2.3.6 Type: FailureCause p. 106

5.3.2.3.7 Type: PdnConnectionInformation |R16| p. 107

5.3.2.3.8 Type: AppliedParameterConfiguration |R16| p. 107

5.3.2.3.9 Type: ApiCapabilityInfo |R16| p. 107

5.3.2.3.10 Type: MonitoringEventReports |R17| p. 108

5.3.2.3.11 Type: UavPolicy |R17| p. 108

5.3.2.3.11a Type: ConsentRevocNotif |R17| p. 108

5.3.2.3.12 Type: ConsentRevoked |R17| p. 109

5.3.2.3.13 Type: GroupMembListChanges |R18| p. 109

5.3.2.3.14 Type: RangeDirection |R18| p. 109

5.3.2.3.15 Type: TwodrelativeLocation |R18| p. 109

5.3.2.3.16 Type: ThreedrelativeLocation |R18| p. 109

5.3.2.3.17 Type: UpLocRepAddrAfRm |R18| p. 110

5.3.2.3.18 Type: UpCumEvtRep |R18| p. 110

5.3.2.4 Referenced simple data types and enumerations p. 110

5.3.2.4.1 Introduction p. 110

5.3.2.4.2 Simple data types p. 110

5.3.2.4.3 Enumeration: MonitoringType p. 110

5.3.2.4.4 Enumeration: ReachabilityType p. 111

5.3.2.4.5 Enumeration: LocationType p. 112

5.3.2.4.6 Enumeration: AssociationType p. 112

5.3.2.4.7 Enumeration: Accuracy p. 112

5.3.2.4.8 Enumeration: PdnConnectionStatus |R16| p. 113

5.3.2.4.9 Enumeration: PdnType |R16| p. 113

5.3.2.4.10 Enumeration: InterfaceIndication |R16| p. 113

5.3.2.4.11 Enumeration: LocationFailureCause |R16| p. 114

5.3.2.4.12 Enumeration: SubType |R17| p. 114

5.3.2.4.13 Enumeration: SACRepFormat |R17| p. 114

5.3.3 Resource structure p. 114

5.3.3.1 General p. 114

5.3.3.2 Resource: Monitoring Event Subscriptions p. 115

5.3.3.2.1 Introduction p. 115

5.3.3.2.2 Resource definition p. 115

5.3.3.2.3 Resource methods p. 115

5.3.3.2.3.1 GET p. 115

5.3.3.2.3.2 PUT p. 116

5.3.3.2.3.3 PATCH p. 116

5.3.3.2.3.4 POST p. 117

5.3.3.2.3.5 DELETE p. 118

5.3.3.3 Resource: Individual Monitoring Event Subscription p. 118

5.3.3.3.1 Introduction p. 118

5.3.3.3.2 Resource definition p. 118

5.3.3.3.3 Resource methods p. 118

5.3.3.3.3.1 GET p. 118

5.3.3.3.3.2 PUT p. 119

5.3.3.3.3.3 PATCH p. 120

5.3.3.3.3.4 POST p. 121

5.3.3.3.3.5 DELETE p. 121

5.3.3.4 Void

5.3.3A Notifications |R17| p. 122

5.3.3A.1 General p. 122

5.3.3A.2 Monitoring Notification p. 123

5.3.3A.2.1 Description p. 123

5.3.3A.2.2 Target URI p. 123

5.3.3A.2.3 Standard Methods p. 123

5.3.3A.2.3.1 Notification via POST p. 123

5.3.3A.2.3.2 Notification via Websocket p. 124

5.3.3A.3 User Consent Revocation Notification p. 124

5.3.3A.3.1 Description p. 124

5.3.3A.3.2 Target URI p. 124

5.3.3A.3.3 Operation Definition p. 125

5.3.3A.3.3.1 Notification via HTTP POST p. 125

5.3.3A.3.3.2 Notification via Websocket p. 125

5.3.4 Used Features p. 125

5.3.5 Error handling p. 128

5.3.5.1 General p. 128

5.3.5.2 Protocol Errors p. 128

5.3.5.3 Application Errors p. 128

5.4 ResourceManagementOfBdt API p. 130

5.4.1 Overview p. 130

5.4.2 Data model p. 130

5.4.2.1 Resource data types p. 130

5.4.2.1.1 Introduction p. 130

5.4.2.1.2 Type: Bdt p. 130

5.4.2.1.3 Type: BdtPatch p. 131

5.4.2.1.4 Type: ExNotification |R16| p. 132

5.4.2.2 Referenced structured data types p. 132

5.4.2.2.1 Introduction p. 132

5.4.2.2.2 Type: TransferPolicy p. 132

5.4.2.3 Referenced simple data types and enumerations |R16| p. 133

5.4.2.3.1 Introduction p. 133

5.4.2.3.2 Simple data types p. 133

5.4.3 Resource structure p. 133

5.4.3.1 General p. 133

5.4.3.2 Resource: BDT Subscriptions p. 134

5.4.3.2.1 Introduction p. 134

5.4.3.2.2 Resource definition p. 134

5.4.3.2.3 Resource methods p. 134

5.4.3.2.3.1 GET p. 134

5.4.3.2.3.2 PUT p. 135

5.4.3.2.3.3 PATCH p. 135

5.4.3.2.3.4 POST p. 135

5.4.3.2.3.5 DELETE p. 136

5.4.3.3 Resource: Individual BDT Subscription p. 136

5.4.3.3.1 Introduction p. 136

5.4.3.3.2 Resource definition p. 136

5.4.3.3.3 Resource methods p. 136

5.4.3.3.3.1 GET p. 136

5.4.3.3.3.2 PUT p. 137

5.4.3.3.3.3 PATCH p. 138

5.4.3.3.3.4 POST p. 139

5.4.3.3.3.5 DELETE p. 139

5.4.3.4 Void

5.4.3A Notifications |R17| p. 140

5.4.3A.1 General p. 140

5.4.3A.2 BDT Warning Notification p. 141

5.4.3A.2.1 Description p. 141

5.4.3A.2.2 Target URI p. 141

5.4.3A.2.3 Standard Methods p. 141

5.4.3A.2.3.1 Notification via POST p. 141

5.4.3A.2.3.2 Notification via Websocket p. 142

5.4.4 Used Features p. 142

5.4.5 Error handling |R17| p. 142

5.4.5.1 General p. 142

5.4.5.2 Protocol Errors p. 142

5.4.5.3 Application Errors p. 142

5.5 ChargeableParty API p. 143

5.5.1 Overview p. 143

5.5.2 Data model p. 143

5.5.2.1 Resource data types p. 143

5.5.2.1.1 Introduction p. 143

5.5.2.1.2 Type: ChargeableParty p. 143

5.5.2.1.3 Type: ChargeablePartyPatch p. 145

5.5.3 Resource structure p. 145

5.5.3.1 General p. 145

5.5.3.2 Resource: Chargeable Party Transactions p. 146

5.5.3.2.1 Introduction p. 146

5.5.3.2.2 Resource definition p. 146

5.5.3.2.3 Resource methods p. 146

5.5.3.2.3.1 GET p. 146

5.5.3.2.3.2 PUT p. 147

5.5.3.2.3.3 PATCH p. 147

5.5.3.2.3.4 POST p. 147

5.5.3.2.3.5 DELETE p. 148

5.5.3.3 Resource: Individual Chargeable Party Transaction p. 148

5.5.3.3.1 Introduction p. 148

5.5.3.3.2 Resource definition p. 148

5.5.3.3.3 Resource methods p. 148

5.5.3.3.3.1 GET p. 148

5.5.3.3.3.2 PUT p. 149

5.5.3.3.3.3 PATCH p. 149

5.5.3.3.3.4 POST p. 150

5.5.3.3.3.5 DELETE p. 150

5.5.3.4 Void

5.5.3A Notifications |R17| p. 151

5.5.3A.1 General p. 151

5.5.3A.2 Event Notification p. 152

5.5.3A.2.1 Description p. 152

5.5.3A.2.2 Target URI p. 152

5.5.3A.2.3 Standard Methods p. 152

5.5.3A.2.3.1 Notification via POST p. 152

5.5.3A.2.3.2 Notification via Websocket p. 153

5.5.4 Used Features p. 153

5.5.5 Error handling |R17| p. 153

5.5.5.1 General p. 153

5.5.5.2 Protocol Errors p. 153

5.5.5.3 Application Errors p. 153