Tech-invite 3GPPspace IETF RFCs SIP

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

Content for TS 29.520 Word version: 18.0.0

1… 4… 5…

5.1 Nnwdaf_EventsSubscription Service API 5.2 Nnwdaf_AnalyticsInfo Service API 5.3 Nnwdaf_DataManagement Service API 5.4 Nnwdaf_MLModelProvision Service API

5 API Definitions p. 62

5.1 Nnwdaf_EventsSubscription Service API p. 62

5.1.1 Introduction p. 62

5.1.2 Usage of HTTP p. 63

5.1.2.1 General p. 63

5.1.2.2 HTTP standard headers p. 63

5.1.2.2.1 General p. 63

5.1.2.2.2 Content type p. 63

5.1.2.3 HTTP custom headers p. 63

5.1.3 Resources p. 63

5.1.3.1 Resource Structure p. 63

5.1.3.2 Resource: NWDAF Events Subscriptions p. 64

5.1.3.2.1 Description p. 64

5.1.3.2.2 Resource definition p. 64

5.1.3.2.3 Resource Standard Methods p. 65

5.1.3.2.3.1 POST p. 65

5.1.3.2.4 Resource Custom Operations p. 65

5.1.3.3 Resource: Individual NWDAF Event Subscription p. 66

5.1.3.3.1 Description p. 66

5.1.3.3.2 Resource definition p. 66

5.1.3.3.3 Resource Standard Methods p. 66

5.1.3.3.3.1 DELETE p. 66

5.1.3.3.3.2 PUT p. 67

5.1.3.3.4 Resource Custom Operations p. 68

5.1.3.4 Resource: NWDAF Event Subscription Transfers |R17| p. 68

5.1.3.4.1 Description p. 68

5.1.3.4.2 Resource definition p. 69

5.1.3.4.3 Resource Standard Methods p. 69

5.1.3.4.3.1 POST p. 69

5.1.3.4.4 Resource Custom Operations p. 70

5.1.3.5 Resource: Individual NWDAF Event Subscription Transfer |R17| p. 70

5.1.3.5.1 Description p. 70

5.1.3.5.2 Resource definition p. 70

5.1.3.5.3 Resource Standard Methods p. 70

5.1.3.5.3.1 DELETE p. 70

5.1.3.5.3.2 PUT p. 71

5.1.3.5.4 Resource Custom Operations p. 72

5.1.4 Custom Operations without associated resources p. 72

5.1.5 Notifications p. 72

5.1.5.1 General p. 72

5.1.5.2 Event Notification p. 73

5.1.5.2.1 Description p. 73

5.1.5.2.2 Operation Definition p. 73

5.1.6 Data Model p. 74

5.1.6.1 General p. 74

5.1.6.2 Structured data types p. 81

5.1.6.2.1 Introduction p. 81

5.1.6.2.2 Type NnwdafEventsSubscription p. 82

5.1.6.2.3 Type EventSubscription p. 84

5.1.6.2.4 Type NnwdafEventsSubscriptionNotification p. 88

5.1.6.2.5 Type EventNotification p. 89

5.1.6.2.6 Type SliceLoadLevelInformation p. 91

5.1.6.2.7 Type EventReportingRequirement |R16| p. 92

5.1.6.2.8 Type TargetUeInformation |R16| p. 94

5.1.6.2.9 Void

5.1.6.2.10 Type UeMobility |R16| p. 95

5.1.6.2.11 Type LocationInfo |R16| p. 95

5.1.6.2.12 Void

5.1.6.2.13 Type UeCommunication |R16| p. 96

5.1.6.2.14 Type TrafficCharacterization |R16| p. 98

5.1.6.2.15 Type AbnormalBehaviour |R16| p. 99

5.1.6.2.16 Type Exception |R16| p. 99

5.1.6.2.17 Type UserDataCongestionInfo |R16| p. 100

5.1.6.2.18 Type CongestionInfo |R16| p. 100

5.1.6.2.19 Type QosSustainabilityInfo |R16| p. 101

5.1.6.2.20 Type QosRequirement |R16| p. 102

5.1.6.2.21 Type RetainabilityThreshold |R16| p. 102

5.1.6.2.22 Type NetworkPerfRequirement |R16| p. 102

5.1.6.2.23 Type NetworkPerfInfo |R16| p. 103

5.1.6.2.24 Type ServiceExperienceInfo |R16| p. 104

5.1.6.2.25 Type BwRequirement |R16| p. 106

5.1.6.2.26 Type AdditionalMeasurement |R16| p. 106

5.1.6.2.27 Type IpEthFlowDescription |R16| p. 107

5.1.6.2.28 Type AddressList |R16| p. 107

5.1.6.2.29 Type CircumstanceDescription |R16| p. 107

5.1.6.2.30 Type ThresholdLevel |R16| p. 108

5.1.6.2.31 Type NfLoadLevelInformation |R16| p. 109

5.1.6.2.32 Type NfStatus |R16| p. 109

5.1.6.2.33 Type NsiIdInfo |R16| p. 110

5.1.6.2.34 Type NsiLoadLevelInfo |R16| p. 111

5.1.6.2.35 Type FailureEventInfo |R16| p. 112

5.1.6.2.36 Type AnalyticsMetadataIndication |R17| p. 112

5.1.6.2.37 Type AnalyticsMetadataInfo |R17| p. 113

5.1.6.2.38 Type NumberAverage |R17| p. 113

5.1.6.2.39 Type TopApplication |R17| p. 113

5.1.6.2.40 Type AnalyticsSubscriptionsTransfer |R17| p. 113

5.1.6.2.41 Type SubscriptionTransferInfo |R17| p. 114

5.1.6.2.42 Type ModelInfo |R17| p. 114

5.1.6.2.43 Type AnalyticsContextIdentifier |R17| p. 114

5.1.6.2.44 Type UeAnalyticsContextDescriptor |R17| p. 115

5.1.6.2.45 Type DnPerfInfo |R17| p. 115

5.1.6.2.46 Type DnPerf |R17| p. 116

5.1.6.2.47 Type PerfData |R17| p. 116

5.1.6.2.48 Type ResourceUsage |R17| p. 116

5.1.6.2.49 Type ConsumerNfInformation |R17| p. 117

5.1.6.2.50 Type DispersionRequirement |R17| p. 117

5.1.6.2.51 Type ClassCriterion |R17| p. 117

5.1.6.2.52 Type RankingCriterion |R17| p. 118

5.1.6.2.53 Type DispersionInfo |R17| p. 118

5.1.6.2.54 Type DispersionCollection |R17| p. 119

5.1.6.2.55 Type ApplicationVolume |R17| p. 120

5.1.6.2.56 Type RedundantTransmissionExpReq |R17| p. 120

5.1.6.2.57 Type RedundantTransmissionExpInfo |R17| p. 121

5.1.6.2.58 Type RedundantTransmissionExpPerTS |R17| p. 121

5.1.6.2.59 Type WlanPerformanceReq |R17| p. 122

5.1.6.2.60 Type WlanPerformanceInfo |R17| p. 122

5.1.6.2.61 Type WlanPerSsIdPerformanceInfo |R17| p. 122

5.1.6.2.62 Type WlanPerTsPerformanceInfo |R17| p. 123

5.1.6.2.63 Type TrafficInformation |R17| p. 123

5.1.6.2.64 Type AppListForUeComm |R17| p. 124

5.1.6.2.65 Type SessInactTimerForUeComm |R17| p. 124

5.1.6.2.66 Type DnPerformanceReq |R17| p. 124

5.1.6.2.67 Type: RatFreqInformation |R17| p. 125

5.1.6.2.68 Type PrevSubInfo |R17| p. 125

5.1.6.2.69 Type MLModelInfo |R17| p. 126

5.1.6.2.70 Type ObservedRedundantTransExp |R17| p. 127

5.1.6.3 Simple data types and enumerations p. 127

5.1.6.3.1 Introduction p. 127

5.1.6.3.2 Simple data types p. 127

5.1.6.3.3 Enumeration: NotificationMethod p. 128

5.1.6.3.4 Enumeration: NwdafEvent p. 128

5.1.6.3.5 Enumeration: Accuracy |R16| p. 129

5.1.6.3.6 Enumeration: ExceptionId |R16| p. 129

5.1.6.3.7 Enumeration: ExceptionTrend |R16| p. 129

5.1.6.3.8 Enumeration: CongestionType |R16| p. 129

5.1.6.3.9 Enumeration: TimeUnit |R16| p. 129

5.1.6.3.10 Enumeration: NetworkPerfType |R16| p. 130

5.1.6.3.11 Enumeration: ExpectedAnalyticsType |R16| p. 130

5.1.6.3.12 Enumeration: MatchingDirection |R16| p. 130

5.1.6.3.13 Enumeration: NwdafFailureCode |R16| p. 130

5.1.6.3.14 Enumeration: AnalyticsMetadata |R17| p. 131

5.1.6.3.15 Enumeration: DatasetStatisticalProperty |R17| p. 131

5.1.6.3.16 Enumeration: OutputStrategy |R17| p. 131

5.1.6.3.17 Enumeration: TransferRequestType |R17| p. 131

5.1.6.3.18 Enumeration: AnalyticsSubset |R17| p. 132

5.1.6.3.19 Enumeration: DispersionType |R17| p. 133

5.1.6.3.20 Enumeration: DispersionClass |R17| p. 134

5.1.6.3.21 Enumeration: DispersionOrderingCriterion |R17| p. 134

5.1.6.3.22 Enumeration: RedTransExpOrderingCriterion |R17| p. 134

5.1.6.3.23 Enumeration: WlanOrderingCriterion |R17| p. 134

5.1.6.3.24 Enumeration: ServiceExperienceType |R17| p. 135

5.1.6.3.25 Enumeration: DnPerfOrderingCriterion |R17| p. 135

5.1.6.3.26 Enumeration: TermCause |R18| p. 135

5.1.7 Error handling p. 135

5.1.7.1 General p. 135

5.1.7.2 Protocol Errors p. 135

5.1.7.3 Application Errors p. 135

5.1.8 Feature negotiation p. 136

5.1.9 Security p. 138

5.2 Nnwdaf_AnalyticsInfo Service API p. 138

5.2.1 Introduction p. 138

5.2.2 Usage of HTTP p. 138

5.2.2.1 General p. 138

5.2.2.2 HTTP standard headers p. 139

5.2.2.2.1 General p. 139

5.2.2.2.2 Content type p. 139

5.2.2.3 HTTP custom headers p. 139

5.2.3 Resources p. 139

5.2.3.1 Resource Structure p. 139

5.2.3.2 Resource: NWDAF Analytics p. 139

5.2.3.2.1 Description p. 139

5.2.3.2.2 Resource definition p. 140

5.2.3.2.3 Resource Standard Methods p. 140

5.2.3.2.3.1 GET p. 140

5.2.3.2.4 Resource Custom Operations p. 141

5.2.3.3 Resource: NWDAF Context |R17| p. 141

5.2.3.3.1 Description p. 141

5.2.3.3.2 Resource definition p. 141

5.2.3.3.3 Resource Standard Methods p. 141

5.2.3.3.3.1 GET p. 141

5.2.4 Custom Operations without associated resources p. 142

5.2.5 Notifications p. 142

5.2.6 Data Model p. 142

5.2.6.1 General p. 142

5.2.6.2 Structured data types p. 147

5.2.6.2.1 Introduction p. 147

5.2.6.2.2 Type AnalyticsData p. 148

5.2.6.2.3 Type EventFilter p. 150

5.2.6.2.4 Void

5.2.6.2.5 Type AdditionInfoAnalyticsInfoRequest |R17| p. 152

5.2.6.2.6 Type ContextData |R17| p. 153

5.2.6.2.7 Type ContextElement |R17| p. 153

5.2.6.2.8 Type ContextIdList |R17| p. 154

5.2.6.2.9 Type HistoricalData |R17| p. 154

5.2.6.2.10 Type SpecificAnalyticsSubscription |R17| p. 155

5.2.6.2.11 Type RequestedContext |R17| p. 155

5.2.6.2.12 Type SmcceInfo |R17| p. 155

5.2.6.2.13 Type SmcceUeList |R17| p. 156

5.2.6.2.14 Type SpecificDataSubscription |R17| p. 156

5.2.6.3 Simple data types and enumerations p. 156

5.2.6.3.1 Introduction p. 156

5.2.6.3.2 Simple data types p. 157

5.2.6.3.3 Enumeration: EventId p. 157

5.2.6.3.4 Enumeration: ContextType |R17| p. 158

5.2.6.3.5 Enumeration: AdrfDataType |R17| p. 158

5.2.6.4 Data types describing alternative data types or combinations of data types |R17| p. 158

5.2.6.4.1 Type ProblemDetailsAnalyticsInfoRequest p. 158

5.2.7 Error handling p. 158

5.2.7.1 General p. 158

5.2.7.2 Protocol Errors p. 158

5.2.7.3 Application Errors p. 159

5.2.8 Feature negotiation p. 159

5.2.9 Security p. 160

5.3 Nnwdaf_DataManagement Service API |R17| p. 161

5.3.1 Introduction p. 161

5.3.2 Usage of HTTP p. 161

5.3.2.1 General p. 161

5.3.2.2 HTTP standard headers p. 161

5.3.2.2.1 General p. 161

5.3.2.2.2 Content type p. 161

5.3.2.3 HTTP custom headers p. 162

5.3.3 Resources p. 162

5.3.3.1 Resource Structure p. 162

5.3.3.2 Resource: NWDAF Data Management Subscriptions p. 163

5.3.3.2.1 Description p. 163

5.3.3.2.2 Resource Definition p. 163

5.3.3.2.3 Resource Standard Methods p. 163

5.3.3.2.3.1 POST p. 163

5.3.3.2.4 Resource Custom Operations p. 164

5.3.3.3 Resource: Individual NWDAF Data Management Subscription p. 164

5.3.3.3.1 Description p. 164

5.3.3.3.2 Resource definition p. 164

5.3.3.3.3 Resource Standard Methods p. 164

5.3.3.3.3.1 PUT p. 164

c5.3.3.3.4 Resource Custom Operations |R18| p. 166

5.3.4 Custom Operations without associated resources p. 166

5.3.5 Notifications p. 166

5.3.5.1 General p. 166

5.3.5.2 Event Notification p. 167

5.3.5.2.1 Description p. 167

5.3.5.2.2 Operation Definition p. 167

5.3.5.3 Fetch Notification p. 168

5.3.5.3.1 Description p. 168

5.3.5.3.2 Target URI p. 168

5.3.5.3.3 Standard Methods p. 168

5.3.5.3.3.1 POST p. 168

5.3.6 Data Model p. 169

5.3.6.1 General p. 169

5.3.6.2 Structured data types p. 170

5.3.6.2.1 Introduction p. 170

5.3.6.2.2 Type NnwdafDataManagementSubsc p. 171

5.3.6.2.3 Type NnwdafDataManagementNotif p. 173

5.3.7 Error handling p. 173

5.3.7.1 General p. 173

5.3.7.2 Protocol Errors p. 173

5.3.7.3 Application Errors p. 173

5.3.8 Feature negotiation p. 174

5.3.9 Security p. 174

5.4 Nnwdaf_MLModelProvision Service API |R17| p. 174

5.4.1 Introduction p. 174

5.4.2 Usage of HTTP p. 175

5.4.2.1 General p. 175

5.4.2.2 HTTP standard headers p. 175

5.4.2.2.1 General p. 175

5.4.2.2.2 Content type p. 175

5.4.2.3 HTTP custom headers p. 175

5.4.3 Resources p. 175

5.4.3.1 Resource Structure p. 175

5.4.3.2 Resource: NWDAF ML Model Provision Subscriptions p. 176

5.4.3.2.1 Description p. 176

5.4.3.2.2 Resource definition p. 176

5.4.3.2.3 Resource Standard Methods p. 177

5.4.3.2.3.1 POST p. 177

5.4.3.2.4 Resource Custom Operations p. 177

5.4.3.3 Resource: Individual NWDAF ML Model Provision Subscription p. 177

5.4.3.3.1 Description p. 177

5.4.3.3.2 Resource definition p. 177

5.4.3.3.3 Resource Standard Methods p. 178

5.4.3.3.3.1 PUT p. 178

5.4.3.3.3.2 DELETE p. 179

5.4.3.3.4 Resource Custom Operations p. 180

5.4.4 Custom Operations without associated resources p. 180

5.4.5 Notifications p. 180

5.4.5.1 General p. 180

5.4.5.2 Event Notification p. 180

5.4.5.2.1 Description p. 180

5.4.5.2.2 Operation Definition p. 180

5.4.6 Data Model p. 181

5.4.6.1 General p. 181

5.4.6.2 Structured data types p. 182

5.4.6.2.1 Introduction p. 182

5.4.6.2.2 Type NwdafMLModelProvSubsc p. 183

5.4.6.2.3 Type MLEventSubscription p. 183

5.4.6.2.4 Void

5.4.6.2.5 Type NwdafMLModelProvNotif p. 184

5.4.6.2.6 Type MLEventNotif p. 184

5.4.6.2.7 Type FailureEventInfoForMLModel p. 184

5.4.6.2.8 Type MLModelAddr p. 184

5.4.6.3 Simple data types and enumerations p. 185

5.4.6.3.1 Introduction p. 185

5.4.6.3.2 Simple data types p. 185

5.4.6.3.3 Enumeration: FailureCode p. 185

5.4.7 Error handling p. 185

5.4.7.1 General p. 185

5.4.7.2 Protocol Errors p. 185

5.4.7.3 Application Errors p. 185

5.4.8 Feature negotiation p. 186

5.4.9 Security p. 186

A (Normative) OpenAPI specification p. 187

A.1 General p. 187

A.2 Nnwdaf_EventsSubscription API p. 187

A.3 Nnwdaf_AnalyticsInfo API p. 221

A.4 Nnwdaf_DataManagement API |R17| p. 231

A.5 Nnwdaf_MLModelProvision API |R17| p. 235

$ Change history p. 241