Content for TS 29.558 Word version: 18.4.0
8 Edge Enabler Server API Definitions
8.1 Eees_EASRegistration API
8.2 Eees_UELocation API
8.3 Eees_UEIdentifier API
8.4 Eees_AppClientInformation API
8.5 Eees_SessionWithQoS API
8.6 Eees_ACRManagementEvent API
8.7 Eees_EECContextRelocation API
8.8 Eees_EELManagedACR API
8.9 Eees_ACRStatusUpdate API
8.10 Eees_ACRParameterInformation API
8.11 Eees_CommonEASAnnouncement API
8A CAS API Definitions
8A.1 Ecas_SelectedEES API
8 Edge Enabler Server API Definitions p. 60
8.1 Eees_EASRegistration API p. 60
8.1.1 Introduction p. 60
8.1.2 Resources p. 61
8.1.2.1 Overview p. 61
8.1.2.2 Resource: EAS Registrations p. 62
8.1.2.2.1 Description p. 62
8.1.2.2.2 Resource Definition p. 62
8.1.2.2.3 Resource Standard Methods p. 62
8.1.2.2.3.1 POST p. 62
8.1.2.2.4 Resource Custom Operations p. 63
8.1.2.3 Resource: Individual EAS Registration p. 63
8.1.3 Custom Operations without associated resources p. 67
8.1.4 Notifications p. 67
8.1.5 Data Model p. 67
8.1.5.1 General p. 67
8.1.5.2 Structured data types p. 69
8.1.5.2.1 Introduction p. 69
8.1.5.2.2 Type: EASRegistration p. 69
8.1.5.2.3 Type: EASProfile p. 70
8.1.5.2.4 Type: EASServiceKPI p. 72
8.1.5.2.5 Type: EndPoint p. 73
8.1.5.2.6 Type: EASRegistrationPatch p. 73
8.1.5.2.7 Type: TransContSuppDetails |R18| p. 73
8.1.5.2.8 Type: EASBundleInfo |R18| p. 73
8.1.5.2.9 Type: EASBdlReqs |R18| p. 74
8.1.5.2.10 Type: CoordinatedAcrReqs |R18| p. 74
8.1.5.3 Simple data types and enumerations p. 74
8.1.5.3.1 Introduction p. 74
8.1.5.3.2 Simple data types p. 74
8.1.5.3.3 Enumeration: PermissionLevel p. 75
8.1.5.3.4 Enumeration: EASCategory p. 75
8.1.5.3.5 Enumeration: TransportProtocol |R18| p. 75
8.1.5.3.6 Enumeration: BdlType |R18| p. 75
8.1.5.3.7 Enumeration: Affinity |R18| p. 76
8.1.5.3.8 Enumeration: FailureAction |R18| p. 76
8.1.6 Error Handling p. 76
8.1.7 Feature negotiation p. 76
8.2 Eees_UELocation API p. 76
8.2.1 Introduction p. 76
8.2.2 Resources p. 77
8.2.2.1 Overview p. 77
8.2.2.2 Resource: Location Information Subscriptions p. 78
8.2.2.2.1 Description p. 78
8.2.2.2.2 Resource Definition p. 78
8.2.2.2.3 Resource Standard Methods p. 78
8.2.2.2.3.1 POST p. 78
8.2.2.2.4 Resource Custom Operations p. 79
8.2.2.3 Resource: Individual Location Information Subscription p. 79
8.2.3 Custom Operations without associated resources p. 83
8.2.3.1 Overview p. 83
8.2.3.2 Operation: Fetch p. 84
8.2.3.2.1 Description p. 84
8.2.3.2.2 Operation Definition p. 84
8.2.4 Notifications p. 85
8.2.4.1 General p. 85
8.2.4.2 Location Information Notification p. 86
8.2.4.2.1 Description p. 86
8.2.4.2.2 Target URI p. 86
8.2.4.2.3 Standard Methods p. 86
8.2.4.2.3.1 POST p. 86
8.2.4.3 User Consent Revocation Notification p. 87
8.2.5 Data Model p. 88
8.2.5.1 General p. 88
8.2.5.2 Structured data types p. 90
8.2.5.2.1 Introduction p. 90
8.2.5.2.2 Type: LocationSubscription p. 90
8.2.5.2.3 Type: LocationSubscriptionPatch p. 92
8.2.5.2.4 Type: LocationNotification p. 92
8.2.5.2.5 Type: LocationEvent p. 92
8.2.5.2.6 Type: LocationRequest p. 93
8.2.5.2.7 Type: LocationResponse p. 93
8.2.5.2.8 Type: ConsentRevocNotif p. 93
8.2.5.2.9 Type: ConsentRevoked p. 94
8.2.5.3 Simple data types and enumerations p. 94
8.2.6 Error Handling p. 94
8.2.7 Feature negotiation p. 94
8.3 Eees_UEIdentifier API p. 95
8.3.1 Introduction p. 95
8.3.2 Resources p. 95
8.3.3 Custom Operations without associated resources p. 95
8.3.3.1 Overview p. 95
8.3.3.2 Operation: Fetch p. 96
8.3.3.2.1 Description p. 96
8.3.3.2.2 Operation Definition p. 96
8.3.3.3 Operation: Get |R18| p. 97
8.3.3.3.1 Description p. 97
8.3.3.3.2 Operation Definition p. 97
8.3.4 Notifications p. 98
8.3.5 Data Model p. 98
8.3.5.1 General p. 98
8.3.5.2 Structured data types p. 99
8.3.5.2.1 Introduction p. 99
8.3.5.2.2 Type: UserInformation p. 99
8.3.5.2.3 Type: UserInfo |R18| p. 100
8.3.5.2.4 Type: UeIdInfo |R18| p. 100
8.3.5.2.5 Type: UeId |R18| p. 101
8.3.5.3 Simple data types and enumerations p. 101
8.3.6 Error Handling p. 101
8.3.7 Feature negotiation p. 101
8.4 Eees_AppClientInformation API p. 102
8.4.1 Introduction p. 102
8.4.2 Resources p. 102
8.4.2.1 Overview p. 102
8.4.2.2 Resource: Application Client Information Subscriptions p. 103
8.4.2.2.1 Description p. 103
8.4.2.2.2 Resource Definition p. 103
8.4.2.2.3 Resource Standard Methods p. 103
8.4.2.2.3.1 POST p. 103
8.4.2.2.4 Resource Custom Operations p. 104
8.4.2.3 Resource: Individual Application Client Information Subscription p. 104
8.4.2.3.1 Description p. 104
8.4.2.3.2 Resource Definition p. 104
8.4.2.3.3 Resource Standard Methods p. 104
8.4.2.3.4 Resource Custom Operations p. 108
8.4.3 Custom Operations without associated resources p. 108
8.4.4 Notifications p. 109
8.4.4.1 General p. 109
8.4.4.2 AC Information Notification p. 109
8.4.4.2.1 Description p. 109
8.4.4.2.2 Target URI p. 109
8.4.4.2.3 Standard Methods p. 109
8.4.4.2.3.1 POST p. 109
8.4.5 Data Model p. 110
8.4.5.1 General p. 110
8.4.5.2 Structured data types p. 112
8.4.5.2.1 Introduction p. 112
8.4.5.2.2 Type: ACInfoSubscription p. 112
8.4.5.2.3 Type: ACInfoSubscriptionPatch p. 112
8.4.5.2.4 Type: ACFilters p. 113
8.4.5.2.5 Type: ACInfoNotification p. 113
8.4.5.2.6 Type: ACInformation p. 113
8.4.5.3 Simple data types and enumerations p. 114
8.4.6 Error Handling p. 114
8.4.7 Feature negotiation p. 114
8.5 Eees_SessionWithQoS API p. 114
8.5.1 Introduction p. 114
8.5.2 Resources p. 115
8.5.2.1 Overview p. 115
8.5.2.2 Resource: Sessions with QoS p. 116
8.5.2.2.1 Description p. 116
8.5.2.2.2 Resource Definition p. 116
8.5.2.2.3 Resource Standard Methods p. 116
8.5.2.2.3.1 POST p. 116
8.5.2.2.3.2 GET p. 117
8.5.2.2.4 Resource Custom Operations p. 118
8.5.2.3 Resource: Individual Session with QoS p. 118
8.5.2.3.1 Description p. 118
8.5.2.3.2 Resource Definition p. 118
8.5.2.3.3 Resource Standard Methods p. 118
8.5.2.3.4 Resource Custom Operations p. 122
8.5.3 Custom Operations without associated resources p. 122
8.5.4 Notifications p. 123
8.5.4.1 General p. 123
8.5.4.2 User Plane Event Notification p. 123
8.5.4.2.1 Description p. 123
8.5.4.2.2 TargetURI p. 123
8.5.4.2.3 Standard Methods p. 123
8.5.4.2.3.1 POST p. 123
8.5.5 Data Model p. 124
8.5.5.1 General p. 124
8.5.5.2 Structured data types p. 126
8.5.5.2.1 Introduction p. 126
8.5.5.2.2 Type: SessionWithQoS p. 126
8.5.5.2.3 Type: SessionWithQoSPatch p. 129
8.5.5.2.4 Type: UserPlaneEventNotification p. 129
8.5.5.3 Simple data types and enumerations p. 129
8.5.6 Error Handling p. 130
8.5.6.1 General |R18| p. 130
8.5.6.2 Protocol Errors |R18| p. 130
8.5.6.3 Application Errors |R18| p. 130
8.5.7 Feature negotiation p. 130
8.6 Eees_ACRManagementEvent API p. 130
8.6.1 Introduction p. 130
8.6.2 Resources p. 131
8.6.2.1 Overview p. 131
8.6.2.2 Resource: ACR Management Events Subscriptions p. 132
8.6.2.2.1 Description p. 132
8.6.2.2.2 Resource Definition p. 132
8.6.2.2.3 Resource Standard Methods p. 132
8.6.2.2.3.1 POST p. 132
8.6.2.2.3.2 GET p. 133
8.6.2.2.4 Resource Custom Operations p. 134
8.6.2.3 Resource: Individual ACR Management Events Subscription p. 134
8.6.2.3.1 Description p. 134
8.6.2.3.2 Resource Definition p. 134
8.6.2.3.3 Resource Standard Methods p. 134
8.6.2.3.4 Resource Custom Operations p. 138
8.6.3 Custom Operations without associated resources p. 138
8.6.4 Notifications p. 139
8.6.4.1 General p. 139
8.6.4.2 ACR Management Events Notification p. 139
8.6.4.2.1 Description p. 139
8.6.4.2.2 Notification definition p. 139
8.6.4.3 User Plane Path Change Availability Notification p. 140
8.6.5 Data Model p. 141
8.6.5.1 General p. 141
8.6.5.2 Structured data types p. 144
8.6.5.2.1 Introduction p. 144
8.6.5.2.2 Type: AcrMgntEventsSubscription p. 144
8.6.5.2.3 Type: AcrMgntEventSubsc p. 146
8.6.5.2.4 Type: AcrMgntEventsSubscriptionPatch p. 148
8.6.5.2.5 Type: AcrMgntEventsNotification p. 148
8.6.5.2.6 Type: AcrMgntEventReport p. 149
8.6.5.2.7 Type: FailureAcrMgntEventInfo p. 151
8.6.5.2.8 Type: TargetUeIdentification p. 151
8.6.5.2.9 Type: UpPathChangeInfo p. 152
8.6.5.2.10 Type: IndUeIdentification p. 152
8.6.5.2.11 Type: AvailabilityNotif p. 152
8.6.5.2.12 Type: SelectedACRScenarios |R18| p. 153
8.6.5.2.13 Type: ACRParameters |R18| p. 153
8.6.5.2.14 Type: TrafficFilterInfo |R18| p. 153
8.6.5.2.15 Type: EasAckInformation |R18| p. 154
8.6.5.2.16 Type: EasInBundleInfo |R18| p. 154
8.6.5.3 Simple data types and enumerations p. 154
8.6.5.3.1 Introduction p. 154
8.6.5.3.2 Simple data types p. 154
8.6.5.3.3 Enumeration: AcrMgntEvent p. 154
8.6.5.3.4 Enumeration: AcrMgntEventFilter p. 155
8.6.5.3.5 Enumeration: ActStatus p. 155
8.6.5.3.6 Enumeration: AcrMgntEventFailureCode p. 155
8.6.5.3.7 Enumeration: AvailabilityStatus p. 155
8.6.5.3.8 Enumeration: ResultCode |R18| p. 155
8.6.6 Error Handling p. 156
8.6.6.1 General |R18| p. 156
8.6.6.2 Protocol Errors |R18| p. 156
8.6.6.3 Application Errors |R18| p. 156
8.6.7 Feature negotiation p. 156
8.7 Eees_EECContextRelocation API p. 156
8.7.1 API URI p. 156
8.7.2 Resources p. 157
8.7.2.1 Overview p. 157
8.7.2.2 Resource: Collection of EEC Contexts p. 157
8.7.2.2.1 Description p. 157
8.7.2.2.2 Resource Definition p. 157
8.7.2.2.3 Resource Standard Methods p. 158
8.7.2.2.3.1 GET p. 158
8.7.2.2.3.2 POST p. 158
8.7.2.2.4 Resource Custom Operations p. 159
8.7.3 Custom Operations without associated resources p. 159
8.7.4 Notifications p. 159
8.7.5 Data Model p. 159
8.7.5.1 General p. 159
8.7.5.2 Structured data types p. 160
8.7.5.2.1 Introduction p. 160
8.7.5.2.2 Type: SessionContexts p. 160
8.7.5.2.3 Type: IndividualSessionContext p. 160
8.7.5.2.4 Type: EECContextPush p. 161
8.7.5.2.5 Type: EECContext p. 161
8.7.5.2.6 Type: EECContextPushRes p. 162
8.7.5.2.7 Type: ImplicitRegDetails p. 162
8.7.5.2.8 Type: EECSrvContinuitySupport |R18| p. 162
8.7.5.3 Simple data types and enumerations p. 162
8.7.6 Error Handling p. 162
8.7.7 Feature negotiation p. 163
8.8 Eees_EELManagedACR API p. 163
8.8.1 Introduction p. 163
8.8.2 Usage of HTTP p. 163
8.8.3 Resources p. 163
8.8.3.1 Overview p. 163
8.8.3.2 Resource: ACT Status Subscriptions p. 164
8.8.3.2.1 Description p. 164
8.8.3.2.2 Resource Definition p. 164
8.8.3.2.3 Resource Standard Methods p. 164
8.8.3.2.3.1 GET p. 165
8.8.3.2.3.2 POST p. 165
8.8.3.2.4 Resource Custom Operations p. 166
8.8.3.3 Resource: Individual ACT Status Subscription p. 166
8.8.3.3.1 Description p. 166
8.8.3.3.2 Resource Definition p. 166
8.8.3.3.3 Resource Standard Methods p. 166
8.8.3.3.3.1 GET p. 167
8.8.3.3.4 Resource Custom Operations p. 167
8.8.4 Custom Operations without associated resources p. 168
8.8.4.1 Overview p. 168
8.8.4.2 Operation: RequestEELManagedACR p. 168
8.8.4.2.1 Description p. 168
8.8.4.2.2 Operation Definition p. 168
8.8.5 Notifications p. 169
8.8.5.1 General p. 169
8.8.5.2 ACT Status Notification p. 169
8.8.5.2.1 Description p. 169
8.8.5.2.2 Target URI p. 169
8.8.5.2.3 Standard Methods p. 170
8.8.5.2.3.1 POST p. 170
8.8.6 Data Model p. 170
8.8.6.1 General p. 170
8.8.6.2 Structured data types p. 171
8.8.6.2.1 Introduction p. 171
8.8.6.2.2 Type: EELACRReq p. 171
8.8.6.2.3 Type: EELACRResp p. 172
8.8.6.2.4 Type: ACTStatusSubsc p. 172
8.8.6.2.5 Type: ACTStatusNotif p. 172
8.8.6.3 Simple data types and enumerations p. 172
8.8.6.3.1 Introduction p. 172
8.8.6.3.2 Simple data types p. 172
8.8.6.4 Data types describing alternative data types or combinations of data types p. 173
8.8.6.5 Binary data p. 173
8.8.6.5.1 Binary Data Types p. 173
8.8.7 Error Handling p. 173
8.8.8 Feature negotiation p. 173
8.9 Eees_ACRStatusUpdate API p. 173
8.9.1 Introduction p. 173
8.9.2 Usage of HTTP p. 174
8.9.3 Resources p. 174
8.9.4 Custom Operations without associated resources p. 174
8.9.4.1 Overview p. 174
8.9.4.2 Operation: RequestACRUpdate p. 175
8.9.4.2.1 Description p. 175
8.9.4.2.2 Operation Definition p. 175
8.9.5 Notifications p. 175
8.9.6 Data Model p. 176
8.9.6.1 General p. 176
8.9.6.2 Structured data types p. 176
8.9.6.2.1 Introduction p. 176
8.9.6.2.2 Type: ACRUpdateData p. 177
8.9.6.2.3 Type: ACRDataStatus p. 177
8.9.6.2.4 Type: ACTResultInfo p. 178
8.9.6.3 Simple data types and enumerations p. 178
8.9.6.3.1 Introduction p. 178
8.9.6.3.2 Simple data types p. 178
8.9.6.3.3 Enumeration: ACTResult p. 178
8.9.6.3.4 Enumeration: E3SubscsStatus p. 178
8.9.6.3.5 Enumeration: ACTFailureCause p. 179
8.9.6.4 Data types describing alternative data types or combinations of data types p. 179
8.9.6.5 Binary data p. 179
8.9.6.5.1 Binary Data Types p. 179
8.9.7 Error Handling p. 179
8.9.8 Feature negotiation p. 179
8.10 Eees_ACRParameterInformation API |R18| p. 180
8.10.1 Introduction p. 180
8.10.2 Usage of HTTP p. 180
8.10.3 Resources p. 180
8.10.4 Custom Operations without associated resources p. 180
8.10.4.1 Overview p. 180
8.10.4.2 Operation: Request p. 181
8.10.4.2.1 Description p. 181
8.10.4.2.2 Operation Definition p. 181
8.10.5 Notifications p. 182
8.10.6 Data Model p. 182
8.10.6.1 General p. 182
8.10.6.2 Structured data types p. 182
8.10.6.2.1 Introduction p. 182
8.10.6.2.2 Type: ACRParamsInfo p. 182
8.10.6.3 Simple data types and enumerations p. 183
8.10.6.3.1 Introduction p. 183
8.10.6.3.2 Simple data types p. 183
8.10.6.4 Data types describing alternative data types or combinations of data types p. 183
8.10.6.5 Binary data p. 183
8.10.6.5.1 Binary Data Types p. 183
8.10.7 Error Handling p. 183
8.10.8 Feature negotiation p. 184
8.11 Eees_CommonEASAnnouncement API |R18| p. 184
8.11.1 Introduction p. 184
8.11.2 Usage of HTTP p. 184
8.11.3 Resources p. 184
8.11.4 Custom Operations without associated resources p. 184
8.11.4.1 Overview p. 184
8.11.4.2 Operation: Declare p. 185
8.11.4.2.1 Description p. 185
8.11.4.2.2 Operation Definition p. 185
8.11.5 Notifications p. 186
8.11.6 Data Model p. 186
8.11.6.1 General p. 186
8.11.6.2 Structured data types p. 187
8.11.6.2.1 Introduction p. 187
8.11.6.2.2 Type: CommonEASInfo p. 187
8.11.6.3 Simple data types and enumerations p. 187
8.11.6.3.1 Introduction p. 187
8.11.6.3.2 Simple data types p. 187
8.11.6.4 Data types describing alternative data types or combinations of data types p. 187
8.11.6.5 Binary data p. 187
8.11.6.5.1 Binary Data Types p. 187
8.11.7 Error Handling p. 188
8.11.8 Feature negotiation p. 188
8A CAS API Definitions |R18| p. 188
8A.1 Ecas_SelectedEES API p. 188
8A.1.1 Introduction p. 188
8A.1.2 Usage of HTTP p. 189
8A.1.3 Resources p. 189
8A.1.4 Custom Operations without associated resources p. 189
8A.1.4.1 Overview p. 189
8A.1.4.2 Operation: Declare p. 189
8A.1.4.2.1 Description p. 189
8A.1.4.2.2 Operation Definition p. 189
8A.1.5 Notifications p. 190
8A.1.6 Data Model p. 190
8A.1.6.1 General p. 190
8A.1.6.2 Structured data types p. 191
8A.1.6.2.1 Introduction p. 191
8A.1.6.2.2 Type: SelEESDecInfo p. 191
8A.1.6.3 Simple data types and enumerations p. 191
8A.1.7 Error Handling p. 191
8A.1.8 Feature negotiation p. 192
