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.548 Word version: 18.1.0

1… 5… 6… A…

6.1 SDD_Transmission Service API 6.2 SDD_DataStorage Service API 6.3 SDD_DDContext Service API 6.4 SDD_TransmissionQualityMeasurement Service API 6.5 SDD_PolicyConfiguration Service API

6 API Definitions p. 42

6.1 SDD_Transmission Service API p. 42

6.1.1 Introduction p. 42

6.1.2 Usage of HTTP p. 42

6.1.3 Resources p. 42

6.1.3.1 Overview p. 42

6.1.3.2 Resource: Connection Status Subscriptions p. 43

6.1.3.2.1 Description p. 43

6.1.3.2.2 Resource Definition p. 43

6.1.3.2.3 Resource Standard Methods p. 43

6.1.3.2.3.1 POST p. 43

6.1.3.2.4 Resource Custom Operations p. 44

6.1.3.3 Resource: Individual Connection Status Subscription p. 44

6.1.3.3.1 Description p. 44

6.1.3.3.2 Resource Definition p. 44

6.1.3.3.3 Resource Standard Methods p. 44

6.1.3.3.3.1 GET p. 44

6.1.3.3.3.2 PUT p. 45

6.1.3.3.3.3 PATCH p. 46

6.1.3.3.3.4 DELETE p. 48

6.1.3.3.4 Resource Custom Operations p. 48

6.1.4 Custom Operations without associated resources p. 49

6.1.4.1 Overview p. 49

6.1.4.2 Operation: RequestTrans p. 49

6.1.4.2.1 Description p. 49

6.1.4.2.2 Operation Definition p. 49

6.1.5 Notifications p. 50

6.1.5.1 General p. 50

6.1.5.2 Connection Status Notification p. 51

6.1.5.2.1 Description p. 51

6.1.5.2.2 Target URI p. 51

6.1.5.2.3 Standard Methods p. 51

6.1.6 Data Model p. 52

6.1.6.1 General p. 52

6.1.6.2 Structured data types p. 53

6.1.6.2.1 Introduction p. 53

6.1.6.2.2 Type: TransReq p. 54

6.1.6.2.3 Type: TransResp p. 54

6.1.6.2.4 Type: ConnInfo p. 55

6.1.6.2.5 Type: QosInfo p. 55

6.1.6.2.6 Type: ValServBdw p. 55

6.1.6.2.7 Type: ValUsersBdw p. 56

6.1.6.2.8 Type: ConnStatusSubsc p. 56

6.1.6.2.9 Type: ConnStatusSubscPatch p. 56

6.1.6.2.10 Type: ConnStatusNotif p. 57

6.1.6.2.11 Type: ConnStatusReport p. 57

6.1.6.2.12 Type: ConnEstabData p. 57

6.1.6.3 Simple data types and enumerations p. 57

6.1.6.3.1 Introduction p. 57

6.1.6.3.2 Simple data types p. 57

6.1.6.3.3 Enumeration: ConnStatusEvent p. 58

6.1.6.3.4 Enumeration: TransType p. 58

6.1.6.4 Data types describing alternative data types or combinations of data types p. 58

6.1.6.5 Binary data p. 58

6.1.6.5.1 Binary Data Types p. 58

6.1.7 Error Handling p. 58

6.1.7.1 General p. 58

6.1.7.2 Protocol Errors p. 58

6.1.7.3 Application Errors p. 59

6.1.8 Feature negotiation p. 59

6.1.9 Security p. 59

6.2 SDD_DataStorage Service API p. 60

6.2.1 Introduction p. 60

6.2.2 Usage of HTTP p. 60

6.2.3 Resources p. 60

6.2.3.1 Overview p. 60

6.2.3.2 Resource: Data Storages p. 62

6.2.3.2.1 Description p. 62

6.2.3.2.2 Resource Definition p. 62

6.2.3.2.3 Resource Standard Methods p. 62

6.2.3.2.3.1 GET p. 62

6.2.3.2.3.2 POST p. 63

6.2.3.2.4 Resource Custom Operations p. 64

6.2.3.3 Resource: Individual Data Storage p. 64

6.2.3.3.1 Description p. 64

6.2.3.3.2 Resource Definition p. 64

6.2.3.3.3 Resource Standard Methods p. 64

6.2.3.3.3.1 GET p. 64

6.2.3.3.3.2 PUT p. 65

6.2.3.3.3.3 PATCH p. 66

6.2.3.3.3.4 DELETE p. 68

6.2.3.3.4 Resource Custom Operations p. 68

6.2.3.4 Resource: Data Storage Delivery Subscriptions p. 69

6.2.3.4.1 Description p. 69

6.2.3.4.2 Resource Definition p. 69

6.2.3.4.3 Resource Standard Methods p. 69

6.2.3.4.3.2 POST p. 69

6.2.3.4.4 Resource Custom Operations p. 70

6.2.3.5 Resource: Individual Data Storage Delivery Subscription p. 70

6.2.3.5.1 Description p. 70

6.2.3.5.2 Resource Definition p. 70

6.2.3.5.3 Resource Standard Methods p. 70

6.2.3.5.3.1 GET p. 70

6.2.3.5.3.2 PUT p. 71

6.2.3.5.3.3 PATCH p. 72

6.2.3.5.3.4 DELETE p. 73

6.2.3.5.4 Resource Custom Operations p. 74

6.2.4 Custom Operations without associated resources p. 74

6.2.4.1 Overview p. 74

6.2.4.2 Operation: DataDeliveryRequest p. 75

6.2.4.2.1 Description p. 75

6.2.4.2.2 Operation Definition p. 75

6.2.4.3 Operation: EstablishDelConn p. 76

6.2.4.3.1 Description p. 76

6.2.4.3.2 Operation Definition p. 76

6.2.5 Notifications p. 77

6.2.5.1 General p. 77

6.2.5.2 Data Management and/or Status Information Notification p. 78

6.2.5.2.1 Description p. 78

6.2.5.2.2 Target URI p. 78

6.2.5.2.3 Standard Methods p. 78

6.2.5.3 Data Storage Delivery Notification p. 79

6.2.5.3.1 Description p. 79

6.2.5.3.2 Target URI p. 79

6.2.5.3.3 Standard Methods p. 79

6.2.6 Data Model p. 80

6.2.6.1 General p. 80

6.2.6.2 Structured data types p. 82

6.2.6.2.1 Introduction p. 82

6.2.6.2.2 Type: DataStorage p. 82

6.2.6.2.3 Type: ReservReqData p. 82

6.2.6.2.4 Type: ReservRespData p. 82

6.2.6.2.5 Type: DataStoragePatch p. 83

6.2.6.2.6 Type: AccessCtrlPolicy p. 83

6.2.6.2.7 Type: DataMngtSubsc p. 83

6.2.6.2.8 Type: DataMngtNotif p. 84

6.2.6.2.9 Type: DataAccessStats p. 84

6.2.6.2.10 Type: DataMngtStats p. 85

6.2.6.2.11 Type: DataDelSubsc p. 85

6.2.6.2.12 Type: DataDelSubscPatch p. 85

6.2.6.2.13 Type: DataDelNotif p. 86

6.2.6.2.14 Type: DataDelReq p. 86

6.2.6.2.15 Type: DelConnEstabReq p. 86

6.2.6.2.16 Type: DelConnEstabResp p. 87

6.2.6.3 Simple data types and enumerations p. 87

6.2.6.3.1 Introduction p. 87

6.2.6.3.2 Simple data types p. 87

6.2.6.3.3 Enumeration: EntityName p. 87

6.2.6.3.4 Enumeration: DataAccessRight p. 87

6.2.6.3.5 Enumeration: DataMngtEvent p. 88

6.2.6.4 Data types describing alternative data types or combinations of data types p. 88

6.2.6.4.1 Type: DataStorageReq p. 88

6.2.6.5 Binary data p. 88

6.2.6.5.1 Binary Data Types p. 88

6.2.7 Error Handling p. 88

6.2.7.1 General p. 88

6.2.7.2 Protocol Errors p. 88

6.2.7.3 Application Errors p. 88

6.2.8 Feature negotiation p. 89

6.2.9 Security p. 89

6.3 SDD_DDContext Service API p. 90

6.3.1 Introduction p. 90

6.3.2 Usage of HTTP p. 90

6.3.3 Resources p. 90

6.3.3.1 Overview p. 90

6.3.3.2 Resource: DD Contexts p. 91

6.3.3.2.1 Description p. 91

6.3.3.2.2 Resource Definition p. 91

6.3.3.2.3 Resource Standard Methods p. 91

6.3.3.2.3.1 POST p. 91

6.3.3.2.3.2 GET p. 92

6.3.3.2.4 Resource Custom Operations p. 94

6.3.4 Custom Operations without associated resources p. 94

6.3.5 Notifications p. 94

6.3.6 Data Model p. 94

6.3.6.1 General p. 94

6.3.6.2 Structured data types p. 95

6.3.6.2.1 Introduction p. 95

6.3.6.2.2 Type: DdContext p. 95

6.3.6.2.3 Type: TranspLayerContext p. 95

6.3.6.2.4 Type: DdContextPushReq p. 95

6.3.6.2.5 Type: DdContextResp p. 96

6.3.6.2.6 Type: SddUuContext p. 96

6.3.6.2.7 Type: SddSContext p. 97

6.3.6.3 Simple data types and enumerations p. 97

6.3.6.3.1 Introduction p. 97

6.3.6.3.2 Simple data types p. 97

6.3.6.4 Data types describing alternative data types or combinations of data types p. 97

6.3.6.5 Binary data p. 97

6.3.6.5.1 Binary Data Types p. 97

6.3.7 Error Handling p. 98

6.3.7.1 General p. 98

6.3.7.2 Protocol Errors p. 98

6.3.7.3 Application Errors p. 98

6.3.8 Feature negotiation p. 98

6.3.9 Security p. 98

6.4 SDD_TransmissionQualityMeasurement Service API p. 99

6.4.1 Introduction p. 99

6.4.2 Usage of HTTP p. 99

6.4.3 Resources p. 99

6.4.3.1 Overview p. 99

6.4.3.2 Resource: Transmission Quality Measurement Subscriptions p. 100

6.4.3.2.1 Description p. 100

6.4.3.2.2 Resource Definition p. 100

6.4.3.2.3 Resource Standard Methods p. 100

6.4.3.2.3.1 POST p. 100

6.4.3.2.4 Resource Custom Operations p. 101

6.4.3.3 Resource: Individual Transmission Quality Measurement Subscription p. 101

6.4.3.3.1 Description p. 101

6.4.3.3.2 Resource Definition p. 101

6.4.3.3.3 Resource Standard Methods p. 102

6.4.3.3.3.1 GET p. 102

6.4.3.3.3.2 PUT p. 103

6.4.3.3.3.3 PATCH p. 104

6.4.3.3.3.4 DELETE p. 105

6.4.3.3.4 Resource Custom Operations p. 106

6.4.3.4 Resource: Historical Transmission Quality Measurement Reports p. 106

6.4.3.4.1 Description p. 106

6.4.3.4.2 Resource Definition p. 106

6.4.3.4.3 Resource Standard Methods p. 107

6.4.3.4.3.1 GET p. 107

6.4.3.4.4 Resource Custom Operations p. 108

6.4.4 Custom Operations without associated resources p. 108

6.4.5 Notifications p. 108

6.4.5.1 General p. 108

6.4.5.2 Transmission Quality Measurement Notification p. 109

6.4.5.2.1 Description p. 109

6.4.5.2.2 Target URI p. 109

6.4.5.2.3 Standard Methods p. 109

6.4.5.2.3.1 POST p. 109

6.4.6 Data Model p. 110

6.4.6.1 General p. 110

6.4.6.2 Structured data types p. 111

6.4.6.2.1 Introduction p. 111

6.4.6.2.2 Type: TransQualMeasSubsc p. 112

6.4.6.2.3 Type: TransQualMeasReq p. 113

6.4.6.2.4 Type: TransQualMeasSubscPatch p. 113

6.4.6.2.5 Type: TransQualMeasNotif p. 114

6.4.6.2.6 Type: TransQualMeasReport p. 114

6.4.6.2.7 Type: TransQualMeasCriteria p. 115

6.4.6.2.8 Type: TransQualMeasData p. 116

6.4.6.2.9 Type: HistTransQualMeasReports p. 119

6.4.6.2.10 Type: TransQualMeasCriteriaSet p. 119

6.4.6.3 Simple data types and enumerations p. 119

6.4.6.3.1 Introduction p. 119

6.4.6.3.2 Simple data types p. 119

6.4.6.3.3 Enumeration: MeasurementId p. 119

6.4.6.3.4 Enumeration: RepGranularity p. 120

6.4.6.4 Data types describing alternative data types or combinations of data types p. 120

6.4.6.5 Binary data p. 120

6.4.6.5.1 Binary Data Types p. 120

6.4.7 Error Handling p. 120

6.4.7.1 General p. 120

6.4.7.2 Protocol Errors p. 120

6.4.7.3 Application Errors p. 120

6.4.8 Feature negotiation p. 121

6.4.9 Security p. 121

6.5 SDD_PolicyConfiguration Service API p. 122

6.5.1 Introduction p. 122

6.5.2 Usage of HTTP p. 122

6.5.3 Resources p. 122

6.5.3.1 Overview p. 122

6.5.3.2 Resource: Policy Configurations p. 123

6.5.3.2.1 Description p. 123

6.5.3.2.2 Resource Definition p. 123

6.5.3.2.3 Resource Standard Methods p. 123

6.5.3.2.3.1 POST p. 123

6.5.3.2.4 Resource Custom Operations p. 124

6.5.3.3 Resource: Individual Policy Configuration p. 124

6.5.3.3.1 Description p. 124

6.5.3.3.2 Resource Definition p. 124

6.5.3.3.3 Resource Standard Methods p. 124

6.5.3.3.3.1 GET p. 124

6.5.3.3.3.2 PUT p. 125

6.5.3.3.3.3 PATCH p. 126

6.5.3.3.3.4 DELETE p. 128

6.5.3.3.4 Resource Custom Operations p. 128

6.5.4 Custom Operations without associated resources p. 129

6.5.5 Notifications p. 129

6.5.6 Data Model p. 129

6.5.6.1 General p. 129

6.5.6.2 Structured data types p. 129

6.5.6.2.1 Introduction p. 129

6.5.6.2.2 Type: PolicyConfig p. 130

6.5.6.2.3 Type: PolicyConfigPatch p. 130

6.5.6.2.4 Type: SealddPolicy p. 130

6.5.6.2.5 Type: QualGuarPolicy p. 131

6.5.6.2.6 Type: QualGuarThresh p. 131

6.5.6.3 Simple data types and enumerations p. 131

6.5.6.3.1 Introduction p. 131

6.5.6.3.2 Simple data types p. 131

6.5.6.3.3 Enumeration: BdwCtrlPolicy p. 131

6.5.6.4 Data types describing alternative data types or combinations of data types p. 132

6.5.6.5 Binary data p. 132

6.5.6.5.1 Binary Data Types p. 132

6.5.7 Error Handling p. 132

6.5.7.1 General p. 132

6.5.7.2 Protocol Errors p. 132

6.5.7.3 Application Errors p. 132

6.5.8 Feature negotiation p. 132

6.5.9 Security p. 133

7 Using Common API Framework p. 134