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:  18.4.0

Top   Top   Up   Prev   None
1…   4… 
4 Services offered by the NEF  4.1 Introduction  4.2 Nnef_EventExposure Service  4.3 Nnef_EASDeployment Service  4.4 Nnef_TrafficInfluenceData Service  4.5 Nnef_ECSAddress Service  4.6 Nnef_DNAIMapping Service  4.7 Nnef_UEId Service  5 API Definitions  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  A OpenAPI specification  $ Change history 

 

4  Services offered by the NEF  p. 14

4.1  Introduction  p. 14

4.2  Nnef_EventExposure Service  p. 14

4.2.1  Service Description  p. 14

4.2.1.1  Overview  p. 14

4.2.1.2  Service Architecture  p. 15

4.2.1.3  Network Functions  p. 16

4.2.1.3.1  Network Exposure Function (NEF)  p. 16
4.2.1.3.2  NF Service Consumers  p. 16

4.2.2  Service Operations  p. 17

4.2.2.1  Introduction  p. 17

4.2.2.2  Nnef_EventExposure_Subscribe service operation  p. 17

4.2.2.2.1  General  p. 17
4.2.2.2.2  Creating a new subscription  p. 18
4.2.2.2.3  Modifying an existing subscription  p. 20

4.2.2.3  Nnef_EventExposure_Unsubscribe service operation  p. 21

4.2.2.3.1  General  p. 21
4.2.2.3.2  Unsubscription from event notifications  p. 21

4.2.2.4  Nnef_EventExposure_Notify service operation  p. 22

4.2.2.4.1  General  p. 22
4.2.2.4.2  Notification about subscribed events  p. 22

4.3  Nnef_EASDeployment Service |R17|  p. 24

4.3.1  Service Description  p. 24

4.3.1.1  Overview  p. 24

4.3.1.2  Service Architecture  p. 24

4.3.1.3  Network Functions  p. 25

4.3.1.3.1  Network Exposure Function (NEF)  p. 25
4.3.1.3.2  NF Service Consumers  p. 25

4.3.2  Service Operations  p. 25

4.3.2.1  Introduction  p. 25

4.3.2.2  Nnef_EASDeployment_Subscribe service operation  p. 26

4.3.2.2.1  General  p. 26
4.3.2.2.2  Creating a new subscription  p. 26

4.3.2.3  Nnef_EASDeployment_Unsubscribe service operation  p. 26

4.3.2.3.1  General  p. 26
4.3.2.3.2  Unsubscription of notification of changes of EAS Deployment Information  p. 27

4.3.2.4  Nnef_EASDeployment_Notify service operation  p. 27

4.3.2.4.1  General  p. 27
4.3.2.4.2  Notification of changes of EAS Deployment Information  p. 27

4.4  Nnef_TrafficInfluenceData Service |R18|  p. 27

4.4.1  Service Description  p. 27

4.4.1.1  Overview  p. 27

4.4.1.2  Service Architecture  p. 27

4.4.1.3  Network Functions  p. 28

4.4.1.3.1  Network Exposure Function (NEF)  p. 28
4.4.1.3.2  NF Service Consumers  p. 28

4.4.2  Service Operations  p. 28

4.4.2.1  Introduction  p. 28

4.4.2.2  Nnef_TrafficInfluenceData_Subscribe service operation  p. 29

4.4.2.2.1  General  p. 29
4.4.2.2.2  Creating a new subscription  p. 29
4.4.2.2.3  Modifying an existing subscription  p. 30

4.4.2.3  Nnef_TrafficInfluenceData_Unsubscribe service operation  p. 31

4.4.2.3.1  General  p. 31
4.4.2.3.2  Unsubscription of notification of Traffic Influence Data  p. 31

4.4.2.4  Nnef_TrafficInfluenceData_Notify service operation  p. 31

4.4.2.4.1  General  p. 31
4.4.2.4.2  Notification of changes of Traffic Influence Data  p. 31

4.5  Nnef_ECSAddress Service |R18|  p. 32

4.5.1  Service Description  p. 32

4.5.1.1  Overview  p. 32

4.5.1.2  Service Architecture  p. 32

4.5.1.3  Network Functions  p. 33

4.5.1.3.1  Network Exposure Function (NEF)  p. 33
4.5.1.3.2  NF Service Consumers  p. 33

4.5.2  Service Operations  p. 33

4.5.2.1  Introduction  p. 33

4.5.2.2  Nnef_ECSAddress_Subscribe service operation  p. 34

4.5.2.2.1  General  p. 34
4.5.2.2.2  Creating a new subscription  p. 34
4.5.2.2.3  Modifying an existing subscription  p. 35

4.5.2.3  Nnef_ECSAddress_Unsubscribe service operation  p. 36

4.5.2.3.1  General  p. 36
4.5.2.3.2  Unsubscription of notification of ECS Address Configuration Information  p. 36

4.5.2.4  Nnef_ECSAddress_Notify service operation  p. 36

4.5.2.4.1  General  p. 36
4.5.2.4.2  Notification of changes of ECS Address Configuration Information  p. 36

4.6  Nnef_DNAIMapping Service |R18|  p. 37

4.6.1  Service Description  p. 37

4.6.1.1  Overview  p. 37

4.6.1.2  Service Architecture  p. 37

4.6.1.3  Network Functions  p. 38

4.6.1.3.1  Network Exposure Function (NEF)  p. 38
4.6.1.3.2  NF Service Consumers  p. 38

4.6.2  Service Operations  p. 38

4.6.2.1  Introduction  p. 38

4.6.2.2  Nnef_DNAIMapping_Subscribe service operation  p. 39

4.6.2.2.1  General  p. 39
4.6.2.2.2  Creating a new subscription for notification of DNAI Mapping Information  p. 39

4.6.2.3  Nnef_DNAIMapping_Unsubscribe service operation  p. 40

4.6.2.3.1  General  p. 40
4.6.2.3.2  Unsubscription of notification of DNAI Mapping Information  p. 40

4.6.2.4  Nnef_DNAIMapping_Notify service operation  p. 40

4.6.2.4.1  General  p. 40
4.6.2.4.2  Notification of changes of DNAI Mapping Information  p. 40

4.7  Nnef_UEId Service |R18|  p. 41

4.7.1  Service Description  p. 41

4.7.1.1  Overview  p. 41

4.7.1.2  Service Architecture  p. 41

4.7.1.3  Network Functions  p. 42

4.7.1.3.1  Network Exposure Function (NEF)  p. 42
4.7.1.3.2  NF Service Consumers  p. 42

4.7.2  Service Operations  p. 42

4.7.2.1  Introduction  p. 42

4.7.2.2  Nnef_UEId_Fetch service operation  p. 43

4.7.2.2.1  General  p. 43
4.7.2.2.2  Fetch internal UE ID for roaming UE  p. 43

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. 44

5.1.2.1  General  p. 44

5.1.2.2  HTTP standard headers  p. 44

5.1.2.2.1  General  p. 44
5.1.2.2.2  Content type  p. 44

5.1.2.3  HTTP custom headers  p. 44

5.1.3  Resources  p. 45

5.1.3.1  Overview  p. 45

5.1.3.2  Resource: Network Exposure Event Subscriptions  p. 45

5.1.3.2.1  Description  p. 45
5.1.3.2.2  Resource Definition  p. 45
5.1.3.2.3  Resource Standard Methods  p. 46
5.1.3.2.3.1  POST  p. 46

5.1.3.3  Resource: Individual Network Exposure Event Subscription  p. 46

5.1.3.3.1  Description  p. 46
5.1.3.3.2  Resource Definition  p. 46
5.1.3.3.3  Resource Standard Methods  p. 47
5.1.3.3.3.1  GET  p. 47
5.1.3.3.3.2  PUT  p. 48
5.1.3.3.3.3  DELETE  p. 49

5.1.4  Custom Operations without associated resources  p. 50

5.1.5  Notifications  p. 50

5.1.5.1  General  p. 50

5.1.5.2  Network Exposure Event Notification  p. 51

5.1.5.2.1  Description  p. 51
5.1.5.2.2  Target URI  p. 51
5.1.5.2.3  Standard Methods  p. 51
5.1.5.2.3.1  POST  p. 51

5.1.6  Data Model  p. 52

5.1.6.1  General  p. 52

5.1.6.2  Structured data types  p. 56

5.1.6.2.1  Introduction  p. 56
5.1.6.2.2  Type: NefEventExposureSubsc  p. 56
5.1.6.2.3  Type: NefEventExposureNotif  p. 57
5.1.6.2.4  Type: NefEventNotification  p. 57
5.1.6.2.5  Type NefEventSubs  p. 60
5.1.6.2.6  Type UeCommunicationInfo  p. 60
5.1.6.2.7  Type NefEventFilter  p. 61
5.1.6.2.8  Type TargetUeIdentification  p. 62
5.1.6.2.9  Type: ServiceExperienceInfo  p. 62
5.1.6.2.10  Type: UeMobilityInfo  p. 63
5.1.6.2.11  Type: UeTrajectoryInfo  p. 63
5.1.6.2.12  Type PerformanceDataInfo |R17|  p. 63
5.1.6.2.13  Type GNSSAssistDataInfo |R18|  p. 64
5.1.6.2.14  Void

5.1.6.3  Simple data types and enumerations  p. 64

5.1.6.3.1  Introduction  p. 64
5.1.6.3.2  Simple data types  p. 64
5.1.6.3.3  Enumeration: NefEvent  p. 64

5.1.7  Error Handling  p. 65

5.1.7.1  General  p. 65

5.1.7.2  Protocol Errors  p. 65

5.1.7.3  Application Errors  p. 65

5.1.8  Feature negotiation  p. 66

5.1.9  Security  p. 67

5.2  Nnef_EASDeployment Service API |R17|  p. 67

5.2.1  Introduction  p. 67

5.2.2  Usage of HTTP  p. 68

5.2.2.1  General  p. 68

5.2.2.2  HTTP standard headers  p. 68

5.2.2.2.1  General  p. 68
5.2.2.2.2  Content type  p. 68

5.2.2.3  HTTP custom headers  p. 68

5.2.3  Resources  p. 68

5.2.3.1  Overview  p. 68

5.2.3.2  Resource: EAS Deployment Event Subscriptions  p. 69

5.2.3.2.1  Description  p. 69
5.2.3.2.2  Resource Definition  p. 69
5.2.3.2.3  Resource Standard Methods  p. 69
5.2.3.2.3.1  POST  p. 69

5.2.3.3  Resource: Individual EAS Deployment Event Subscription  p. 70

5.2.3.3.1  Description  p. 70
5.2.3.3.2  Resource Definition  p. 70
5.2.3.3.3  Resource Standard Methods  p. 70
5.2.3.3.3.1  GET  p. 70
5.2.3.3.3.2  PUT  p. 71
5.2.3.3.3.3  DELETE  p. 71

5.2.4  Custom Operations without associated resources  p. 72

5.2.5  Notifications  p. 72

5.2.5.1  General  p. 72

5.2.5.2  EAS Deployment Event Notification  p. 73

5.2.5.2.1  Description  p. 73
5.2.5.2.2  Target URI  p. 73
5.2.5.2.3  Standard Methods  p. 73
5.2.5.2.3.1  POST  p. 73

5.2.6  Data Model  p. 74

5.2.6.1  General  p. 74

5.2.6.2  Structured data types  p. 75

5.2.6.2.1  Introduction  p. 75
5.2.6.2.2  Type: EasDeploySubData  p. 75
5.2.6.2.3  Type: EasDeployInfoNotif  p. 76
5.2.6.2.4  Type: EasDepNotification  p. 76
5.2.6.2.5  Type: EasDeployInfoData  p. 76

5.2.6.3  Simple data types and enumerations  p. 76

5.2.6.3.1  Introduction  p. 76
5.2.6.3.2  Simple data types  p. 77
5.2.6.3.3  Enumeration: EasEvent  p. 77

5.2.7  Error Handling  p. 77

5.2.7.1  General  p. 77

5.2.7.2  Protocol Errors  p. 77

5.2.7.3  Application Errors  p. 77

5.2.8  Feature negotiation  p. 77

5.2.9  Security  p. 78

5.3  Nnef_TrafficInfluenceData Service API |R18|  p. 78

5.3.1  Introduction  p. 78

5.3.2  Usage of HTTP  p. 78

5.3.2.1  General  p. 78

5.3.2.2  HTTP standard headers  p. 78

5.3.2.2.1  General  p. 78
5.3.2.2.2  Content type  p. 79

5.3.2.3  HTTP custom headers  p. 79

5.3.3  Resources  p. 79

5.3.3.1  Overview  p. 79

5.3.3.2  Resource: Traffic Influence Data Subscriptions  p. 80

5.3.3.2.1  Description  p. 80
5.3.3.2.2  Resource Definition  p. 80
5.3.3.2.3  Resource Standard Methods  p. 80
5.3.3.2.3.1  POST  p. 80

5.3.3.3  Resource: Individual Traffic Influence Data Subscription  p. 81

5.3.3.3.1  Description  p. 81
5.3.3.3.2  Resource Definition  p. 81
5.3.3.3.3  Resource Standard Methods  p. 81
5.3.3.3.3.1  GET  p. 81
5.3.3.3.3.2  PUT  p. 82
5.3.3.3.3.3  DELETE  p. 83

5.3.4  Custom Operations without associated resources  p. 84

5.3.5  Notifications  p. 84

5.3.5.1  General  p. 84

5.3.5.2  Traffic Influence Data Notification  p. 85

5.3.5.3.1  Description  p. 85
5.3.5.3.2  Target URI  p. 85
5.3.5.3.3  Standard Methods  p. 85
5.3.5.3.3.1  POST  p. 85

5.3.6  Data Model  p. 86

5.3.6.1  General  p. 86

5.3.6.2  Structured data types  p. 87

5.3.6.2.1  Introduction  p. 87
5.3.6.2.2  Type: TrafficInfluDataSub  p. 87
5.3.6.2.3  Type: TrafficInfluDataNotify  p. 88

5.3.6.3  Simple data types and enumerations  p. 88

5.3.6.3.1  Introduction  p. 88
5.3.6.3.2  Simple data types  p. 88

5.3.7  Error Handling  p. 88

5.3.7.1  General  p. 88

5.3.7.2  Protocol Errors  p. 88

5.3.7.3  Application Errors  p. 88

5.3.8  Feature negotiation  p. 89

5.3.9  Security  p. 89

5.4  Nnef_ECSAddress Service API |R18|  p. 89

5.4.1  Introduction  p. 89

5.4.2  Usage of HTTP  p. 89

5.4.2.1  General  p. 89

5.4.2.2  HTTP standard headers  p. 90

5.4.2.2.1  General  p. 90
5.4.2.2.2  Content type  p. 90

5.4.2.3  HTTP custom headers  p. 90

5.4.3  Resources  p. 90

5.4.3.1  Overview  p. 90

5.4.3.2  Resource: ECS Address Configuration Information Subscriptions  p. 91

5.4.3.2.1  Description  p. 91
5.4.3.2.2  Resource Definition  p. 91
5.4.3.2.3  Resource Standard Methods  p. 91
5.4.3.2.3.1  POST  p. 91

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

5.4.3.3.1  Description  p. 92
5.4.3.3.2  Resource Definition  p. 92
5.4.3.3.3  Resource Standard Methods  p. 92
5.4.3.3.3.1  GET  p. 92
5.4.3.3.3.2  PUT  p. 93
5.4.3.3.3.3  DELETE  p. 94

5.4.4  Custom Operations without associated resources  p. 95

5.4.5  Notifications  p. 95

5.4.5.1  General  p. 95

5.4.5.2  ECS Address Configuration Information Notification  p. 96

5.4.5.4.1  Description  p. 96
5.4.5.4.2  Target URI  p. 96
5.4.5.4.3  Standard Methods  p. 96
5.4.5.4.3.1  POST  p. 96

5.4.6  Data Model  p. 97

5.4.6.1  General  p. 97

5.4.6.2  Structured data types  p. 98

5.4.6.2.1  Introduction  p. 98
5.4.6.2.2  Type: EcsAddrCfgInfoSub  p. 98
5.4.6.2.3  Type: EcsAddrCfgInfoNotification  p. 98

5.4.6.3  Simple data types and enumerations  p. 99

5.4.6.3.1  Introduction  p. 99
5.4.6.3.2  Simple data types  p. 99

5.4.7  Error Handling  p. 99

5.4.7.1  General  p. 99

5.4.7.2  Protocol Errors  p. 99

5.4.7.3  Application Errors  p. 99

5.4.8  Feature negotiation  p. 99

5.4.9  Security  p. 99

5.5  Nnef_DNAIMapping Service API |R18|  p. 100

5.5.1  Introduction  p. 100

5.5.2  Usage of HTTP  p. 100

5.5.2.1  General  p. 100

5.5.2.2  HTTP standard headers  p. 100

5.5.2.2.1  General  p. 100
5.5.2.2.2  Content type  p. 100

5.5.2.3  HTTP custom headers  p. 101

5.5.3  Resources  p. 101

5.5.3.1  Overview  p. 101

5.5.3.2  Resource: DNAI Mapping Subscriptions  p. 101

5.5.3.2.1  Description  p. 101
5.5.3.2.2  Resource Definition  p. 101
5.5.3.2.3  Resource Standard Methods  p. 102
5.5.3.2.3.1  POST  p. 102

5.5.3.3  Resource: Individual DNAI Mapping Subscription  p. 102

5.5.3.3.1  Description  p. 102
5.5.3.3.2  Resource Definition  p. 102
5.5.3.3.3  Resource Standard Methods  p. 103
5.5.3.3.3.1  GET  p. 103
5.5.3.3.3.2  DELETE  p. 104

5.5.4  Custom Operations without associated resources  p. 105

5.5.5  Notifications  p. 105

5.5.5.1  General  p. 105

5.5.5.2  DNAI Mapping Notification  p. 105

5.5.5.2.1  Description  p. 105
5.5.5.2.2  Target URI  p. 105
5.5.5.2.3  Standard Methods  p. 105
5.5.5.2.3.1  POST  p. 105

5.5.6  Data Model  p. 106

5.5.6.1  General  p. 106

5.5.6.2  Structured data types  p. 107

5.5.6.2.1  Introduction  p. 107

5.5.6.3  Simple data types and enumerations  p. 107

5.5.6.3.1  Introduction  p. 107
5.5.6.3.2  Simple data types  p. 107

5.5.7  Error Handling  p. 107

5.5.7.1  General  p. 107

5.5.7.2  Protocol Errors  p. 107

5.5.7.3  Application Errors  p. 108

5.5.8  Feature negotiation  p. 108

5.5.9  Security  p. 108

5.6  Nnef_UEId Service API |R18|  p. 108

5.6.1  Introduction  p. 108

5.6.2  Usage of HTTP  p. 108

5.6.2.1  General  p. 108

5.6.2.2  HTTP standard headers  p. 109

5.6.2.2.1  General  p. 109
5.6.2.2.2  Content type  p. 109

5.6.2.3  HTTP custom headers  p. 109

5.6.3  Resources  p. 109

5.6.4  Custom Operations without associated resources  p. 109

5.6.4.1  Overview  p. 109

5.6.4.2  Operation: Fetch  p. 110

5.6.4.2.1  Description  p. 110
5.6.4.2.2  Operation Definition  p. 110

5.6.5  Notifications  p. 111

5.6.6  Data Model  p. 111

5.6.6.1  General  p. 111

5.6.6.2  Structured data types  p. 111

5.6.6.2.1  Introduction  p. 111
5.6.6.2.2  Type: UeIdReq  p. 111
5.6.6.2.3  Type: UeIdInfo  p. 112

5.6.6.3  Simple data types and enumerations  p. 112

5.6.6.3.1  Introduction  p. 112
5.6.6.3.2  Simple data types  p. 112

5.6.7  Error Handling  p. 112

5.6.7.1  General  p. 112

5.6.7.2  Protocol Errors  p. 112

5.6.7.3  Application Errors  p. 112

5.6.8  Feature negotiation  p. 112

5.6.9  Security  p. 113

A (Normative)  OpenAPI specification  p. 114

A.1  General  p. 114

A.2  Nnef_EventExposure API  p. 114

A.3  Nnef_EASDeployment API |R17|  p. 123

A.4  Nnef_TrafficInfluenceData API |R18|  p. 127

A.5  Nnef_ECSAddress API |R18|  p. 132

A.6  Nnef_DNAIMapping API |R18|  p. 137

A.7  Nnef_UEId API |R18|  p. 139

$  Change history  p. 142

Up   Top