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.6 NIDD API 5.6.1 Overview 5.6.2 Data model 5.6.3 Resource structure 5.6.3A Notifications 5.6.4 Used Features 5.6.5 Error handling 5.7 DeviceTriggering API 5.7.1 Overview 5.7.2 Data model 5.7.3 Resource structure 5.7.3A Notifications 5.7.4 Used Features 5.7.5 Error handling
...

5.6 NIDD API p. 154

5.6.1 Overview p. 154

5.6.2 Data model p. 154

5.6.2.1 Resource data types p. 154

5.6.2.1.1 Introduction p. 154

5.6.2.1.2 Type: NiddConfiguration p. 155

5.6.2.1.3 Type: NiddDownlinkDataTransfer p. 157

5.6.2.1.4 Type: NiddUplinkDataNotification p. 159

5.6.2.1.5 Type: NiddDownlinkDataDeliveryStatusNotification p. 159

5.6.2.1.6 Type: NiddConfigurationStatusNotifiation p. 160

5.6.2.1.7 Type: NiddConfigurationPatch p. 160

5.6.2.1.8 Type: GmdNiddDownlinkDataDeliveryNotification p. 161

5.6.2.1.9 Type: ManagePort |R16| p. 161

5.6.2.1.10 Type: ManagePortNotification |R16| p. 162

5.6.2.1.11 Type: NiddDownlinkDataTransferPatch |R17| p. 162

5.6.2.2 Referenced structured data types p. 163

5.6.2.2.1 Introduction p. 163

5.6.2.2.2 Type: RdsPort p. 163

5.6.2.2.3 Type: GmdResult p. 164

5.6.2.2.4 Type: NiddDownlinkDataDeliveryFailure p. 164

5.6.2.2.5 Type: RdsDownlinkDataDeliveryFailure |R16| p. 164

5.6.2.3 Referenced simple data types and enumerations p. 165

5.6.2.3.1 Introduction p. 165

5.6.2.3.2 Simple data types p. 165

5.6.2.3.3 Enumeration: PdnEstablishmentOptions p. 165

5.6.2.3.4 Enumeration: DeliveryStatus p. 165

5.6.2.3.5 Enumeration: NiddStatus p. 166

5.6.2.3.6 Enumeration: PdnEstablishmentOptionsRm p. 166

5.6.2.3.7 Enumeration: ManageEntity |R16| p. 167

5.6.2.3.8 Enumeration: SerializationFormat |R17| p. 167

5.6.3 Resource structure p. 167

5.6.3.1 General p. 167

5.6.3.2 Resource: NIDD Configurations p. 168

5.6.3.2.1 Introduction p. 168

5.6.3.2.2 Resource definition p. 169

5.6.3.2.3 Resource methods p. 169

5.6.3.2.3.1 GET p. 169

5.6.3.2.3.2 PUT p. 170

5.6.3.2.3.3 PATCH p. 170

5.6.3.2.3.4 POST p. 170

5.6.3.2.3.5 DELETE p. 170

5.6.3.3 Resource: Individual NIDD Configuration p. 170

5.6.3.3.1 Introduction p. 170

5.6.3.3.2 Resource definition p. 171

5.6.3.3.3 Resource methods p. 171

5.6.3.3.3.1 GET p. 171

5.6.3.3.3.2 PUT p. 172

5.6.3.3.3.3 PATCH p. 172

5.6.3.3.3.4 POST p. 173

5.6.3.3.3.5 DELETE p. 173

5.6.3.4 Resource: NIDD downlink data deliveries p. 173

5.6.3.4.1 Introduction p. 173

5.6.3.4.2 Resource definition p. 174

5.6.3.4.3 Resource methods p. 174

5.6.3.4.3.1 GET p. 174

5.6.3.4.3.2 PUT p. 175

5.6.3.4.3.3 PATCH p. 175

5.6.3.4.3.4 POST p. 175

5.6.3.4.3.5 DELETE p. 177

5.6.3.5 Resource: Individual NIDD downlink data delivery p. 177

5.6.3.5.1 Introduction p. 177

5.6.3.5.2 Resource definition p. 177

5.6.3.5.3 Resource methods p. 177

5.6.3.5.3.1 GET p. 177

5.6.3.5.3.2 PUT p. 178

5.6.3.5.3.3 PATCH p. 179

5.6.3.5.3.4 POST p. 180

5.6.3.5.3.5 DELETE p. 181

5.6.3.6 Void

5.6.3.7 Void

5.6.3.8 Void

5.6.3.9 Resource: Individual ManagePort Configuration |R16| p. 182

5.6.3.9.1 Introduction p. 182

5.6.3.9.2 Resource definition p. 182

5.6.3.9.3 Resource methods p. 182

5.6.3.9.3.1 GET p. 182

5.6.3.9.3.2 PUT p. 183

5.6.3.9.3.3 PATCH p. 184

5.6.3.9.3.4 POST p. 184

5.6.3.9.3.5 DELETE p. 184

5.6.3.10 Void

5.6.3.11 Resource: ManagePort Configurations |R16| p. 185

5.6.3.11.1 Introduction p. 185

5.6.3.11.2 Resource definition p. 186

5.6.3.11.3 Resource methods p. 186

5.6.3.11.3.1 GET p. 186

5.6.3.11.3.2 PUT p. 187

5.6.3.11.3.3 PATCH p. 187

5.6.3.11.3.4 POST p. 187

5.6.3.11.3.5 DELETE p. 187

5.6.3A Notifications |R17| p. 187

5.6.3A.1 General p. 187

5.6.3A.2 NIDD Configuration Update Notification p. 187

5.6.3A.2.1 Description p. 187

5.6.3A.2.2 Target URI p. 188

5.6.3A.2.3 Standard Methods p. 188

5.6.3A.2.3.1 Notification via POST p. 188

5.6.3A.2.3.2 Notification via Websocket p. 189

5.6.3A.3 NIDD Downlink Data Delivery Status Notification p. 189

5.6.3A.3.1 Description p. 189

5.6.3A.3.2 Target URI p. 189

5.6.3A.3.3 Standard Methods p. 189

5.6.3A.3.3.1 Notification via POST p. 189

5.6.3A.3.3.2 Notification via Websocket p. 191

5.6.3A.4 NIDD Uplink Data Notification p. 191

5.6.3A.4.1 Description p. 191

5.6.3A.4.2 Target URI p. 191

5.6.3A.4.3 Standard Methods p. 191

5.6.3A.4.3.1 Notification via POST p. 191

5.6.3A.4.3.2 Notification via Websocket p. 192

5.6.3A.5 ManagePort Notification p. 192

5.6.3A.5.1 Description p. 192

5.6.3A.5.2 Target URI p. 192

5.6.3A.5.3 Standard Methods p. 193

5.6.3A.5.3.1 Notification via POST p. 193

5.6.3A.5.3.2 Notification via Websocket p. 193

5.6.4 Used Features p. 194

5.6.5 Error handling p. 194

5.6.5.1 General p. 194

5.6.5.2 Protocol Errors p. 194

5.6.5.3 Application Errors p. 194

5.7 DeviceTriggering API p. 195

5.7.1 Overview p. 195

5.7.2 Data model p. 195

5.7.2.1 Resource data types p. 195

5.7.2.1.1 Introduction p. 195

5.7.2.1.2 Type: DeviceTriggering p. 196

5.7.2.1.3 Type: DeviceTriggeringDeliveryReportNotification p. 197

5.7.2.1.4 Type: DeviceTriggeringPatch |R17| p. 198

5.7.2.2 Referenced simple data types and enumerations p. 198

5.7.2.2.1 Introduction p. 198

5.7.2.2.2 Simple data types p. 198

5.7.2.2.3 Enumeration: DeliveryResult p. 198

5.7.2.2.4 Enumeration: Priority p. 199

5.7.3 Resource structure p. 199

5.7.3.1 General p. 199

5.7.3.2 Resource: Device Triggering Transactions p. 200

5.7.3.2.1 Introduction p. 200

5.7.3.2.2 Resource definition p. 200

5.7.3.2.3 Resource methods p. 200

5.7.3.2.3.1 GET p. 200

5.7.3.2.3.2 PUT p. 201

5.7.3.2.3.3 PATCH p. 201

5.7.3.2.3.4 POST p. 201

5.7.3.2.3.5 DELETE p. 202

5.7.3.3 Resource: Individual Device Triggering Transaction p. 202

5.7.3.3.1 Introduction p. 202

5.7.3.3.2 Resource definition p. 202

5.7.3.3.3 Resource methods p. 202

5.7.3.3.3.1 GET p. 202

5.7.3.3.3.2 PUT p. 203

5.7.3.3.3.3 PATCH p. 204

5.7.3.3.3.4 POST p. 205

5.7.3.3.3.5 DELETE p. 205

5.7.3.4 Void

5.7.3A Notifications |R17| p. 206

5.7.3A.1 General p. 206

5.7.3A.2 Device Triggering Delivery Report Notification p. 207

5.7.3A.2.1 Description p. 207

5.7.3A.2.2 Target URI p. 207

5.7.3A.2.3 Standard Methods p. 207

5.7.3A.2.3.1 Notification via POST p. 207

5.7.3a.2.3.2 Notification via Websocket p. 208

5.7.4 Used Features p. 208

5.7.5 Error handling |R17| p. 208

5.7.5.1 General p. 208

5.7.5.2 Protocol Errors p. 208

5.7.5.3 Application Errors p. 208