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.591 Word version: 19.0.0

1… 4… 4.3… 4.4… 4.5… 4.6… 4.7… 5…

5.1 Nnef_EventExposure Service API 5.2 Nnef_EASDeployment Service API 5.3 Nnef_TrafficInfluenceData Service API 5.4 Nnef_ECSAddress Service API 5.5 Nnef_DNAIMapping Service API 5.6 Nnef_UEId Service API

5 API Definitions p. 44

5.1 Nnef_EventExposure Service API p. 44

5.1.1 Introduction p. 44

5.1.2 Usage of HTTP p. 45

5.1.2.1 General p. 45

5.1.2.2 HTTP standard headers p. 45

5.1.2.2.1 General p. 45

5.1.2.2.2 Content type p. 45

5.1.2.3 HTTP custom headers p. 45

5.1.3 Resources p. 45

5.1.3.1 Overview p. 45

5.1.3.2 Resource: Network Exposure Event Subscriptions p. 46

5.1.3.2.1 Description p. 46

5.1.3.2.2 Resource Definition p. 46

5.1.3.2.3 Resource Standard Methods p. 47

5.1.3.2.3.1 POST p. 47

5.1.3.3 Resource: Individual Network Exposure Event Subscription p. 47

5.1.3.3.1 Description p. 47

5.1.3.3.2 Resource Definition p. 47

5.1.3.3.3 Resource Standard Methods p. 48

5.1.3.3.3.1 GET p. 48

5.1.3.3.3.2 PUT p. 49

5.1.3.3.3.3 DELETE p. 50

5.1.4 Custom Operations without associated resources p. 51

5.1.5 Notifications p. 51

5.1.5.1 General p. 51

5.1.5.2 Network Exposure Event Notification p. 52

5.1.5.2.1 Description p. 52

5.1.5.2.2 Target URI p. 52

5.1.5.2.3 Standard Methods p. 52

5.1.5.2.3.1 POST p. 52

5.1.6 Data Model p. 53

5.1.6.1 General p. 53

5.1.6.2 Structured data types p. 57

5.1.6.2.1 Introduction p. 57

5.1.6.2.2 Type: NefEventExposureSubsc p. 57

5.1.6.2.3 Type: NefEventExposureNotif p. 58

5.1.6.2.4 Type: NefEventNotification p. 59

5.1.6.2.5 Type NefEventSubs p. 62

5.1.6.2.6 Type UeCommunicationInfo p. 62

5.1.6.2.7 Type NefEventFilter p. 63

5.1.6.2.8 Type TargetUeIdentification p. 64

5.1.6.2.9 Type: ServiceExperienceInfo p. 64

5.1.6.2.10 Type: UeMobilityInfo p. 65

5.1.6.2.11 Type: UeTrajectoryInfo p. 65

5.1.6.2.12 Type PerformanceDataInfo |R17| p. 65

5.1.6.2.13 Type GNSSAssistDataInfo |R18| p. 66

5.1.6.2.14 Void

5.1.6.2.15 Type GNSSServArea |R18| p. 66

5.1.6.3 Simple data types and enumerations p. 66

5.1.6.3.1 Introduction p. 66

5.1.6.3.2 Simple data types p. 66

5.1.6.3.3 Enumeration: NefEvent p. 66

5.1.7 Error Handling p. 67

5.1.7.1 General p. 67

5.1.7.2 Protocol Errors p. 67

5.1.7.3 Application Errors p. 67

5.1.8 Feature negotiation p. 68

5.1.9 Security p. 69

5.2 Nnef_EASDeployment Service API |R17| p. 69

5.2.1 Introduction p. 69

5.2.2 Usage of HTTP p. 70

5.2.2.1 General p. 70

5.2.2.2 HTTP standard headers p. 70

5.2.2.2.1 General p. 70

5.2.2.2.2 Content type p. 70

5.2.2.3 HTTP custom headers p. 70

5.2.3 Resources p. 70

5.2.3.1 Overview p. 70

5.2.3.2 Resource: EAS Deployment Event Subscriptions p. 71

5.2.3.2.1 Description p. 71

5.2.3.2.2 Resource Definition p. 71

5.2.3.2.3 Resource Standard Methods p. 71

5.2.3.2.3.1 POST p. 71

5.2.3.3 Resource: Individual EAS Deployment Event Subscription p. 72

5.2.3.3.1 Description p. 72

5.2.3.3.2 Resource Definition p. 72

5.2.3.3.3 Resource Standard Methods p. 72

5.2.3.3.3.1 GET p. 72

5.2.3.3.3.2 PUT p. 73

5.2.3.3.3.3 DELETE p. 74

5.2.4 Custom Operations without associated resources p. 75

5.2.5 Notifications p. 75

5.2.5.1 General p. 75

5.2.5.2 EAS Deployment Event Notification p. 75

5.2.5.2.1 Description p. 75

5.2.5.2.2 Target URI p. 75

5.2.5.2.3 Standard Methods p. 75

5.2.5.2.3.1 POST p. 75

5.2.6 Data Model p. 76

5.2.6.1 General p. 76

5.2.6.2 Structured data types p. 77

5.2.6.2.1 Introduction p. 77

5.2.6.2.2 Type: EasDeploySubData p. 78

5.2.6.2.3 Type: EasDeployInfoNotif p. 78

5.2.6.2.4 Type: EasDepNotification p. 78

5.2.6.2.5 Type: EasDeployInfoData p. 79

5.2.6.3 Simple data types and enumerations p. 79

5.2.6.3.1 Introduction p. 79

5.2.6.3.2 Simple data types p. 79

5.2.6.3.3 Enumeration: EasEvent p. 79

5.2.7 Error Handling p. 80

5.2.7.1 General p. 80

5.2.7.2 Protocol Errors p. 80

5.2.7.3 Application Errors p. 80

5.2.8 Feature negotiation p. 80

5.2.9 Security p. 80

5.3 Nnef_TrafficInfluenceData Service API |R18| p. 80

5.3.1 Introduction p. 80

5.3.2 Usage of HTTP p. 81

5.3.2.1 General p. 81

5.3.2.2 HTTP standard headers p. 81

5.3.2.2.1 General p. 81

5.3.2.2.2 Content type p. 81

5.3.2.3 HTTP custom headers p. 81

5.3.3 Resources p. 81

5.3.3.1 Overview p. 81

5.3.3.2 Resource: Traffic Influence Data Subscriptions p. 82

5.3.3.2.1 Description p. 82

5.3.3.2.2 Resource Definition p. 82

5.3.3.2.3 Resource Standard Methods p. 83

5.3.3.2.3.1 POST p. 83

5.3.3.3 Resource: Individual Traffic Influence Data Subscription p. 83

5.3.3.3.1 Description p. 83

5.3.3.3.2 Resource Definition p. 83

5.3.3.3.3 Resource Standard Methods p. 84

5.3.3.3.3.1 GET p. 84

5.3.3.3.3.2 PUT p. 85

5.3.3.3.3.3 DELETE p. 86

5.3.4 Custom Operations without associated resources p. 87

5.3.5 Notifications p. 87

5.3.5.1 General p. 87

5.3.5.2 Traffic Influence Data Notification p. 87

5.3.5.3.1 Description p. 87

5.3.5.3.2 Target URI p. 87

5.3.5.3.3 Standard Methods p. 87

5.3.5.3.3.1 POST p. 87

5.3.6 Data Model p. 88

5.3.6.1 General p. 88

5.3.6.2 Structured data types p. 89

5.3.6.2.1 Introduction p. 89

5.3.6.2.2 Type: TrafficInfluDataSub p. 90

5.3.6.2.3 Type: TrafficInfluDataNotify p. 90

5.3.6.3 Simple data types and enumerations p. 90

5.3.6.3.1 Introduction p. 90

5.3.6.3.2 Simple data types p. 90

5.3.7 Error Handling p. 91

5.3.7.1 General p. 91

5.3.7.2 Protocol Errors p. 91

5.3.7.3 Application Errors p. 91

5.3.8 Feature negotiation p. 91

5.3.9 Security p. 91

5.4 Nnef_ECSAddress Service API |R18| p. 92

5.4.1 Introduction p. 92

5.4.2 Usage of HTTP p. 92

5.4.2.1 General p. 92

5.4.2.2 HTTP standard headers p. 92

5.4.2.2.1 General p. 92

5.4.2.2.2 Content type p. 92

5.4.2.3 HTTP custom headers p. 92

5.4.3 Resources p. 93

5.4.3.1 Overview p. 93

5.4.3.2 Resource: ECS Address Configuration Information Subscriptions p. 93

5.4.3.2.1 Description p. 93

5.4.3.2.2 Resource Definition p. 93

5.4.3.2.3 Resource Standard Methods p. 94

5.4.3.2.3.1 POST p. 94

5.4.3.3 Resource: Individual ECS Address Configuration Information Subscription p. 94

5.4.3.3.1 Description p. 94

5.4.3.3.2 Resource Definition p. 94

5.4.3.3.3 Resource Standard Methods p. 95

5.4.3.3.3.1 GET p. 95

5.4.3.3.3.2 PUT p. 96

5.4.3.3.3.3 DELETE p. 97

5.4.3.3.3.4 PATCH p. 98

5.4.4 Custom Operations without associated resources p. 99

5.4.5 Notifications p. 99

5.4.5.1 General p. 99

5.4.5.2 ECS Address Configuration Information Notification p. 100

5.4.5.4.1 Description p. 100

5.4.5.4.2 Target URI p. 100

5.4.5.4.3 Standard Methods p. 100

5.4.5.4.3.1 POST p. 100

5.4.6 Data Model p. 101

5.4.6.1 General p. 101

5.4.6.2 Structured data types p. 102

5.4.6.2.1 Introduction p. 102

5.4.6.2.2 Type: EcsAddrCfgInfoSub p. 102

5.4.6.2.3 Type: EcsAddrCfgInfoNotification p. 102

5.4.6.2.4 Type: EcsAddrCfgInfoSubPatch p. 103

5.4.6.3 Simple data types and enumerations p. 103

5.4.6.3.1 Introduction p. 103

5.4.6.3.2 Simple data types p. 103

5.4.7 Error Handling p. 103

5.4.7.1 General p. 103

5.4.7.2 Protocol Errors p. 103

5.4.7.3 Application Errors p. 103

5.4.8 Feature negotiation p. 104

5.4.9 Security p. 104

5.5 Nnef_DNAIMapping Service API |R18| p. 104

5.5.1 Introduction p. 104

5.5.2 Usage of HTTP p. 105

5.5.2.1 General p. 105

5.5.2.2 HTTP standard headers p. 105

5.5.2.2.1 General p. 105

5.5.2.2.2 Content type p. 105

5.5.2.3 HTTP custom headers p. 105

5.5.3 Resources p. 105

5.5.3.1 Overview p. 105

5.5.3.2 Resource: DNAI Mapping Subscriptions p. 106

5.5.3.2.1 Description p. 106

5.5.3.2.2 Resource Definition p. 106

5.5.3.2.3 Resource Standard Methods p. 106

5.5.3.2.3.1 POST p. 106

5.5.3.3 Resource: Individual DNAI Mapping Subscription p. 107

5.5.3.3.1 Description p. 107

5.5.3.3.2 Resource Definition p. 107

5.5.3.3.3 Resource Standard Methods p. 107

5.5.3.3.3.1 GET p. 107

5.5.3.3.3.2 DELETE p. 108

5.5.4 Custom Operations without associated resources p. 109

5.5.5 Notifications p. 109

5.5.5.1 General p. 109

5.5.5.2 DNAI Mapping Notification p. 110

5.5.5.2.1 Description p. 110

5.5.5.2.2 Target URI p. 110

5.5.5.2.3 Standard Methods p. 110

5.5.5.2.3.1 POST p. 110

5.5.6 Data Model p. 111

5.5.6.1 General p. 111

5.5.6.2 Structured data types p. 111

5.5.6.2.1 Introduction p. 111

5.5.6.3 Simple data types and enumerations p. 112

5.5.6.3.1 Introduction p. 112

5.5.6.3.2 Simple data types p. 112

5.5.7 Error Handling p. 112

5.5.7.1 General p. 112

5.5.7.2 Protocol Errors p. 112

5.5.7.3 Application Errors p. 112

5.5.8 Feature negotiation p. 112

5.5.9 Security p. 112

5.6 Nnef_UEId Service API |R18| p. 113

5.6.1 Introduction p. 113

5.6.2 Usage of HTTP p. 113

5.6.2.1 General p. 113

5.6.2.2 HTTP standard headers p. 113

5.6.2.2.1 General p. 113

5.6.2.2.2 Content type p. 113

5.6.2.3 HTTP custom headers p. 113

5.6.3 Resources p. 114

5.6.4 Custom Operations without associated resources p. 114

5.6.4.1 Overview p. 114

5.6.4.2 Operation: Fetch p. 114

5.6.4.2.1 Description p. 114

5.6.4.2.2 Operation Definition p. 114

5.6.4.3 Operation: UEIDMappingInfoRetrieval p. 115

5.6.4.3.1 Description p. 115

5.6.4.3.2 Operation Definition p. 115

5.6.5 Notifications p. 116

5.6.6 Data Model p. 116

5.6.6.1 General p. 116

5.6.6.2 Structured data types p. 117

5.6.6.2.1 Introduction p. 117

5.6.6.2.2 Type: UeIdReq p. 117

5.6.6.2.3 Type: UeIdInfo p. 117

5.6.6.2.4 Type: MapUeIdInfo p. 118

5.6.6.3 Simple data types and enumerations p. 118

5.6.6.3.1 Introduction p. 118

5.6.6.3.2 Simple data types p. 118

5.6.7 Error Handling p. 118

5.6.7.1 General p. 118

5.6.7.2 Protocol Errors p. 118

5.6.7.3 Application Errors p. 119

5.6.8 Feature negotiation p. 119

5.6.9 Security p. 119

A (Normative) OpenAPI specification p. 120

A.1 General p. 120

A.2 Nnef_EventExposure API p. 120

A.3 Nnef_EASDeployment API |R17| p. 129

A.4 Nnef_TrafficInfluenceData API |R18| p. 133

A.5 Nnef_ECSAddress API |R18| p. 138

A.6 Nnef_DNAIMapping API |R18| p. 143

A.7 Nnef_UEId API |R18| p. 146

$ Change history p. 149