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.549  Word version:  18.6.0

Top   Top   Up   Prev   Next
1…   5…   7…   8… 
7 SEAL API Definitions  7.1 Location management APIs  7.2 Group management APIs  7.3 Configuration management APIs  7.4 Network resource management APIs  7.5 Event APIs  7.6 Key management APIs  7.7 Network Slice Capability Enablement APIs  7.8 Identity management APIs  7.9 Data Delivery APIs  7.10 Application data analytics enablement service configuration APIs 

 

7  SEAL API Definitions  p. 90

7.1  Location management APIs  p. 90

7.1.1  SS_LocationReporting API  p. 90

7.1.1.1  API URI  p. 90

7.1.1.2  Resources  p. 90

7.1.1.2.1  Overview  p. 90
7.1.1.2.2  Resource: SEAL Location Reporting Configurations  p. 91
7.1.1.2.2.1  Description  p. 91
7.1.1.2.2.2  Resource Definition  p. 91
7.1.1.2.2.3  Resource Standard Methods  p. 92
7.1.1.2.2.3.1  POST  p. 92
7.1.1.2.2.4  Resource Custom Operations  p. 92
7.1.1.2.3  Resource: Individual SEAL Location Reporting Configuration  p. 92
7.1.1.2.3.1  Description  p. 92
7.1.1.2.3.2  Resource Definition  p. 92
7.1.1.2.3.3  Resource Standard Methods  p. 93
7.1.1.2.3.3.1  GET  p. 93
7.1.1.2.3.3.2  PUT  p. 94
7.1.1.2.3.3.3  DELETE  p. 95
7.1.1.2.3.3.4  PATCH   p. 96
7.1.1.2.3.4  Resource Custom Operations  p. 96

7.1.1.3  Notifications  p. 97

7.1.1.3.1  General |R18|  p. 97
7.1.1.3.2  Location Trigger Event Notification |R18|  p. 97
7.1.1.3.2.1  Description  p. 97
7.1.1.3.2.2  Notification definition  p. 97

7.1.1.4  Data Model  p. 98

7.1.1.4.1  General  p. 98
7.1.1.4.2  Structured data types  p. 100
7.1.1.4.2.1  Introduction  p. 100
7.1.1.4.2.2  Type: LocationReportConfiguration  p. 100
7.1.1.4.2.3  Type: LocationReportConfigurationPatch   p. 101
7.1.1.4.2.4  Type: TriggeringCriteria   p. 101
7.1.1.4.2.5  LocationReport   p. 101
7.1.1.4.3  Simple data types and enumerations  p. 102
7.1.1.4.3.1  Introduction   p. 102
7.1.1.4.3.2  Simple data types   p. 102
7.1.1.4.3.3  Enumeration: InsideOutsideInd   p. 102
7.1.1.4.3.4  Enumeration: LocChangeCond   p. 102

7.1.1.5  Error Handling  p. 102

7.1.1.5.1  General |R17|  p. 102
7.1.1.5.2  Protocol Errors |R17|  p. 103
7.1.1.5.3  Application Errors |R17|  p. 103

7.1.1.6  Feature negotiation  p. 103

7.1.2  SS_LocationAreaInfoRetrieval API |R17|  p. 103

7.1.2.1  API URI  p. 103

7.1.2.2  Resources  p. 103

7.1.2.2.1  Overview  p. 103
7.1.2.2.2  Resource: Location Information  p. 104
7.1.2.2.2.1  Description  p. 104
7.1.2.2.2.2  Resource Definition  p. 104
7.1.2.2.2.3  Resource Standard Methods  p. 104
7.1.2.2.2.3.1  GET  p. 104
7.1.2.2.2.4  Resource Custom Operations  p. 105

7.1.2.3  Notifications  p. 105

7.1.2.4  Data Model  p. 106

7.1.2.4.1  General  p. 106
7.1.2.4.2  Structured Data Types  p. 106
7.1.2.4.3  Simple data types and enumerations  p. 106

7.1.2.5  Error Handling  p. 106

7.1.2.5.1  General  p. 106
7.1.2.5.2  Protocol Errors  p. 106
7.1.2.5.3  Application Errors  p. 106

7.1.2.6  Feature Negotiation  p. 107

7.1.3  SS_VALServiceAreaConfiguration API |R18|  p. 107

7.1.3.1  API URI  p. 107

7.1.3.1A  Usage of HTTP  p. 107

7.1.3.2  Resources  p. 107

7.1.3.2.1  Overview  p. 107
7.1.3.2.2  Resource: VAL Service Areas  p. 109
7.1.3.2.2.1  Description  p. 109
7.1.3.2.2.2  Resource Definition  p. 109
7.1.3.2.2.3  Resource Standard Methods  p. 109
7.1.3.2.2.3.1  GET  p. 109
7.1.3.2.2.4  Resource Custom Operations  p. 110
7.1.3.2.2.4.1  Overview  p. 110
7.1.3.2.2.4.2  Operation: Configure  p. 110
7.1.3.2.2.4.3  Operation: Update  p. 111
7.1.3.2.2.4.4  Operation: Delete  p. 112
7.1.3.2.3  Resource: VAL Service Area Change Subscriptions  p. 113
7.1.3.2.3.1  Description  p. 113
7.1.3.2.3.2  Resource Definition  p. 113
7.1.3.2.3.3  Resource Standard Methods  p. 113
7.1.3.2.3.3.1  POST  p. 113
7.1.3.2.3.4  Resource Custom Operations  p. 115
7.1.3.2.4  Resource: Individual VAL Service Area Change Subscription  p. 115
7.1.3.2.4.1  Description  p. 115
7.1.3.2.4.2  Resource Definition  p. 115
7.1.3.2.4.3  Resource Standard Methods  p. 115
7.1.3.2.4.3.1  GET  p. 115
7.1.3.2.4.3.2  PUT  p. 116
7.1.3.2.4.3.3  PATCH  p. 117
7.1.3.2.4.3.4  DELETE  p. 118
7.1.3.3.2  Individual Unicast Monitoring Notification  p. 120
7.1.3.3.2.1  Description  p. 120
7.1.3.3.2.2  Notification definition  p. 120

7.1.3.4  Data Model  p. 121

7.1.3.4.1  General  p. 121
7.1.3.4.2  Structured data types  p. 122
7.1.3.4.2.1  Introduction  p. 122
7.1.3.4.2.2  Type: ValServiceArea  p. 122
7.1.3.4.2.3  Type: ValServiceAreaReq  p. 122
7.1.3.4.2.4  Type: ValServiceAreaData  p. 122
7.1.3.4.2.5  Type: ValServiceAreaResp  p. 122
7.1.3.4.2.6  Type: ValServiceAreaSubsc  p. 123
7.1.3.4.2.7  Type: ValServiceAreaEventType  p. 123
7.1.3.4.2.8  Type: ValServiceAreaNotif  p. 123
7.1.3.4.2.9  Type: ValServiceAreaEventInfo  p. 123
7.1.3.4.2.10  Type: ValServiceAreaSubscPatch  p. 124
7.1.3.4.3  Simple data types and enumerations  p. 124
7.1.3.4.3.1  Introduction  p. 124
7.1.3.4.3.2  Simple data types  p. 124
7.1.3.4.3.3  Enumeration: ValServiceAreaEvent  p. 124

7.1.3.5  Error Handling  p. 124

7.1.3.5.1  General  p. 124
7.1.3.5.2  Protocol Errors  p. 124
7.1.3.5.3  Application Errors  p. 124

7.1.3.6  Feature negotiation  p. 125

7.2  Group management APIs  p. 125

7.2.1  SS_GroupManagement API  p. 125

7.2.1.1  API URI  p. 125

7.2.1.2  Resources  p. 125

7.2.1.2.1  Overview  p. 125
7.2.1.2.2  Resource: VAL Group Documents  p. 126
7.2.1.2.2.1  Description  p. 126
7.2.1.2.2.2  Resource Definition  p. 126
7.2.1.2.2.3  Resource Standard Methods  p. 126
7.2.1.2.2.3.1  POST  p. 126
7.2.1.2.2.3.2  GET  p. 127
7.2.1.2.2.4  Resource Custom Operations  p. 128
7.2.1.2.3  Resource: Individual VAL Group Document  p. 128
7.2.1.2.3.1  Description  p. 128
7.2.1.2.3.2  Resource Definition  p. 128
7.2.1.2.3.3  Resource Standard Methods  p. 129
7.2.1.2.3.3.1  GET  p. 129
7.2.1.2.3.3.2  PUT  p. 130
7.2.1.2.3.3.3  DELETE  p. 131
7.2.1.2.3.3.4  PATCH   p. 132
7.2.1.2.3.4  Resource Custom Operations  p. 132

7.2.1.3  Notifications  p. 133

7.2.1.4  Data Model  p. 133

7.2.1.4.1  General  p. 133
7.2.1.4.2  Structured data types  p. 134
7.2.1.4.2.1  Introduction  p. 134
7.2.1.4.2.2  Type: VALGroupDocument  p. 134
7.2.1.4.2.3  Type: VALGroupDocumentPatch   p. 135
7.2.1.4.3  Simple data types and enumerations  p. 135

7.2.1.5  Error Handling  p. 135

7.2.1.5.1  General |R17|  p. 135
7.2.1.5.2  Protocol Errors |R17|  p. 135
7.2.1.5.3  Application Errors |R17|  p. 135

7.2.1.6  Feature negotiation  p. 136

7.3  Configuration management APIs  p. 136

7.3.1  SS_UserProfileRetrieval API  p. 136

7.3.1.1  API URI  p. 136

7.3.1.2  Resources  p. 136

7.3.1.2.1  Overview  p. 136
7.3.1.2.2  Resource: VAL Services  p. 137
7.3.1.2.2.1  Description  p. 137
7.3.1.2.2.2  Resource Definition  p. 137
7.3.1.2.2.3  Resource Standard Methods  p. 137
7.3.1.2.2.3.1  GET  p. 137
7.3.1.2.2.4  Resource Custom Operations  p. 138

7.3.1.3  Notifications  p. 138

7.3.1.4  Data Model  p. 138

7.3.1.4.1  General  p. 138
7.3.1.4.2  Structured data types  p. 139
7.3.1.4.2.1  Introduction  p. 139
7.3.1.4.2.2  Type: ProfileDoc  p. 139
7.3.1.4.2.3  Type: ValTargetUe  p. 139
7.3.1.4.3  Simple data types and enumerations  p. 139

7.3.1.5  Error Handling  p. 139

7.3.1.5.1  General |R17|  p. 139
7.3.1.5.2  Protocol Errors |R17|  p. 139
7.3.1.5.3  Application Errors |R17|  p. 140

7.3.1.6  Feature negotiation  p. 140

7.3.2  SS_VALServiceData API |R18|  p. 140

7.3.2.1  API URI  p. 140

7.3.2.1A  Usage of HTTP  p. 140

7.3.2.2  Resources  p. 140

7.3.2.2.1  Overview  p. 140
7.3.2.2.2  Resource: VAL Service Data Sets  p. 141
7.3.2.2.2.1  Description  p. 141
7.3.2.2.2.2  Resource Definition  p. 141
7.3.2.2.2.3  Resource Standard Methods  p. 141
7.3.2.2.2.3.1  GET  p. 141
7.3.2.2.2.4  Resource Custom Operations  p. 142

7.3.2.3  Custom Operations without associated resources  p. 142

7.3.2.4  Notifications  p. 142

7.3.2.5  Data Model  p. 143

7.3.2.5.1  General  p. 143
7.3.2.5.2  Structured data types  p. 143
7.3.2.5.2.1  Introduction  p. 143
7.3.2.5.2.2  Type: ValServDataResp  p. 143
7.3.2.5.2.3  Type: ValServiceData  p. 144
7.3.2.5.3  Simple data types and enumerations  p. 144
7.3.2.5.3.1  Introduction  p. 144
7.3.2.5.3.2  Simple data types  p. 144
7.3.2.5.4  Data types describing alternative data types or combinations of data types  p. 144
7.3.2.5.5  Binary data  p. 144
7.3.2.5.5.1  Binary Data Types  p. 144

7.3.2.6  Error Handling  p. 144

7.3.2.6.1  General  p. 144
7.3.2.6.2  Protocol Errors  p. 144
7.3.2.6.3  Application Errors  p. 145

7.3.2.7  Feature negotiation  p. 145

7.4  Network resource management APIs  p. 145

7.4.1  SS_NetworkResourceAdaptation API  p. 145

7.4.1.1  API URI  p. 145

7.4.1.1A  Usage of HTTP |R18|  p. 145

7.4.1.2  Resources  p. 145

7.4.1.2.1  Overview  p. 145
7.4.1.2.2  Resource: Multicast Subscriptions  p. 150
7.4.1.2.2.1  Description  p. 150
7.4.1.2.2.2  Resource Definition  p. 150
7.4.1.2.2.3  Resource Standard Methods  p. 150
7.4.1.2.2.3.1  POST  p. 150
7.4.1.2.2.4  Resource Custom Operations  p. 151
7.4.1.2.3  Resource: Individual Multicast Subscription  p. 151
7.4.1.2.3.1  Description  p. 151
7.4.1.2.3.2  Resource Definition  p. 151
7.4.1.2.3.3  Resource Standard Methods  p. 151
7.4.1.2.3.3.1  GET  p. 151
7.4.1.2.3.3.2  DELETE  p. 152
7.4.1.2.3.4  Resource Custom Operations  p. 153
7.4.1.2.4  Resource: Unicast Subscriptions  p. 153
7.4.1.2.4.1  Description  p. 153
7.4.1.2.4.2  Resource Definition  p. 153
7.4.1.2.4.3  Resource Standard Methods  p. 154
7.4.1.2.4.3.1  POST  p. 154
7.4.1.2.4.4  Resource Custom Operations  p. 154
7.4.1.2.5  Resource: Individual Unicast Subscription  p. 154
7.4.1.2.5.1  Description  p. 154
7.4.1.2.5.2  Resource Definition  p. 154
7.4.1.2.5.3  Resource Standard Methods  p. 155
7.4.1.2.5.3.1  GET  p. 155
7.4.1.2.5.3.2  DELETE  p. 155
7.4.1.2.5.4  Resource Custom Operations  p. 156
7.4.1.2.6  Resource: TSC Stream Availability |R17|  p. 156
7.4.1.2.6.1  Description  p. 156
7.4.1.2.6.2  Resource Definition  p. 156
7.4.1.2.6.3  Resource Standard Methods  p. 157
7.4.1.2.6.3.1  GET  p. 157
7.4.1.2.6.4  Resource Custom Operations  p. 158
7.4.1.2.7  Resource: TSC streams |R17|  p. 158
7.4.1.2.7.1  Description  p. 158
7.4.1.2.7.2  Resource Definition  p. 158
7.4.1.2.7.3  Resource Standard Methods  p. 158
7.4.1.2.7.3.1  GET  p. 158
7.4.1.2.7.4  Resource Custom Operations  p. 159
7.4.1.2.8  Resource: Individual TSC Stream |R17|  p. 159
7.4.1.2.8.1  Description  p. 159
7.4.1.2.8.2  Resource Definition  p. 159
7.4.1.2.8.3  Resource Standard Methods  p. 160
7.4.1.2.8.3.1  GET  p. 160
7.4.1.2.8.3.2  PUT  p. 160
7.4.1.2.8.3.3  DELETE  p. 161
7.4.1.2.9  Resource: MBS Resources |R18|  p. 162
7.4.1.2.9.1  Description  p. 162
7.4.1.2.9.2  Resource Definition  p. 162
7.4.1.2.9.3  Resource Standard Methods  p. 162
7.4.1.2.9.3.1  POST  p. 162
7.4.1.2.9.4  Resource Custom Operations  p. 163
7.4.1.2.10  Resource: Individual MBS Resource |R18|  p. 163
7.4.1.2.10.1  Description  p. 163
7.4.1.2.10.2  Resource Definition  p. 163
7.4.1.2.10.3  Resource Standard Methods  p. 164
7.4.1.2.10.3.1  GET  p. 164
7.4.1.2.10.3.2  PUT  p. 165
7.4.1.2.10.3.3  PATCH  p. 166
7.4.1.2.10.3.4  DELETE  p. 167
7.4.1.2.10.4  Resource Custom Operations  p. 168
7.4.1.2.10.4.1  Overview  p. 168
7.4.1.2.10.4.2  Operation: Activate  p. 168
7.4.1.2.10.4.3  Operation: Deactivate  p. 169
7.4.1.2.11  Resource: BDT Policy Configurations |R18|  p. 170
7.4.1.2.11.1  Description  p. 170
7.4.1.2.11.2  Resource definition  p. 170
7.4.1.2.11.3  Resource methods  p. 170
7.4.1.2.11.3.1  POST  p. 170
7.4.1.2.12  Resource: Individual BDT Policy Configuration |R18|  p. 171
7.4.1.2.12.1  Description  p. 171
7.4.1.2.12.2  Resource definition  p. 171
7.4.1.2.12.3  Resource methods  p. 172
7.4.1.2.12.3.1  GET  p. 172
7.4.1.2.12.3.2  PUT  p. 172
7.4.1.2.12.3.3  PATCH  p. 173
7.4.1.2.12.3.4  DELETE  p. 174
7.4.1.2.12.4  Resource Custom Operations  p. 175
7.4.1.2.13  Resource: Unified Traffic Pattern Subscriptions |R18|  p. 175
7.4.1.2.13.1  Description  p. 175
7.4.1.2.13.2  Resource definition  p. 175
7.4.1.2.13.3  Resource methods  p. 176
7.4.1.2.13.3.1  POST  p. 176
7.4.1.2.14  Resource: Individual Unified Traffic Pattern Subscription |R18|  p. 176
7.4.1.2.14.1  Description  p. 176
7.4.1.2.14.2  Resource definition  p. 177
7.4.1.2.14.3  Resource methods  p. 177
7.4.1.2.14.3.1  GET  p. 177
7.4.1.2.14.3.2  PUT  p. 178
7.4.1.2.14.3.3  PATCH  p. 179
7.4.1.2.14.3.4  DELETE  p. 180
7.4.1.2.14.4  Resource Custom Operations  p. 181

7.4.1.2A  Custom Operations without associated resources |R18|  p. 182

7.4.1.2A.1  Overview  p. 182
7.4.1.2A.2  Operation: RelTransRequest  p. 182
7.4.1.2A.2.1  Description  p. 182
7.4.1.2A.2.2  Operation Definition  p. 182

7.4.1.3  Notifications  p. 183

7.4.1.3.1  General  p. 183
7.4.1.3.2  Notify_UP_Delivery_Mode  p. 184
7.4.1.3.2.1  Description  p. 184
7.4.1.3.2.2  Notification definition  p. 184
7.4.1.3.3  BDT_Negotiation_Notification |R18|  p. 185
7.4.1.3.3.1  Description  p. 185
7.4.1.3.3.2  Notification definition  p. 185
7.4.1.3.4  Unified_Traffic_Pattern_Notification |R18|  p. 186
7.4.1.3.4.1  Description  p. 186
7.4.1.3.4.2  Notification definition  p. 186

7.4.1.4  Data Model  p. 187

7.4.1.4.1  General  p. 187
7.4.1.4.2  Structured data types  p. 190
7.4.1.4.2.1  Introduction  p. 190
7.4.1.4.2.2  Type: MulticastSubscription  p. 190
7.4.1.4.2.3  Type: UnicastSubscription  p. 191
7.4.1.4.2.4  Type: UserPlaneNotification  p. 191
7.4.1.4.2.5  Type: NrmEventNotification  p. 192
7.4.1.4.2.6  Type: TscStreamData   p. 192
7.4.1.4.2.7  Type: TrafficSpecInformation   p. 192
7.4.1.4.2.8  Type: TscStreamAvailability   p. 193
7.4.1.4.2.9  Type: StreamSpecification   p. 193
7.4.1.4.2.10  Type: TrafficSpecification   p. 193
7.4.1.4.2.11  Type: MBSResourceReq   p. 193
7.4.1.4.2.12  Type: MBSResource   p. 194
7.4.1.4.2.13  Type: MBSResourceRespInfo   p. 195
7.4.1.4.2.14  Type: MBSResourceResp   p. 195
7.4.1.4.2.15  Type: MBSResourcePatch   p. 196
7.4.1.4.2.16  Type: MbsResAct   p. 196
7.4.1.4.2.17  Type: MbsResDeact   p. 196
7.4.1.4.2.18  Type: BdtPolConfig   p. 197
7.4.1.4.2.19  Type: GeoArea   p. 197
7.4.1.4.2.20  Type: BdtNotification   p. 198
7.4.1.4.2.21  Type: BdtPolConfigPatch   p. 198
7.4.1.4.2.22  Type: PolicyGuidance   p. 198
7.4.1.4.2.23  Type: UnfTrafficSubc   p. 199
7.4.1.4.2.24  Type: UnfTrafficSubcPatch   p. 199
7.4.1.4.2.25  Type: ManagementSubc   p. 199
7.4.1.4.2.26  Type: TrafficPatternConfig   p. 200
7.4.1.4.2.27  Type: UnfTrafficUpdNotif   p. 200
7.4.1.4.2.28  Type: RelTransReq   p. 201
7.4.1.4.2.29  Type: AppTraffDesc   p. 201
7.4.1.4.2.30  Type: ValUeAddrInfo   p. 201
7.4.1.4.3  Simple data types and enumerations  p. 201
7.4.1.4.3.0  Introduction   p. 201
7.4.1.4.3.0A  Simple data types   p. 201
7.4.1.4.3.1  Enumeration: ServiceAnnoucementMode  p. 202
7.4.1.4.3.2  Enumeration: DeliveryMode  p. 202
7.4.1.4.3.4  Enumeration: NetSysIndicator   p. 202
7.4.1.4.3.5  Enumeration: NrmEvent   p. 202
7.4.1.4.3.6  Enumeration: PolicyType   p. 202
7.4.1.4.3.7  Enumeration: TrafficPatternIndication   p. 203

7.4.1.5  Error Handling  p. 203

7.4.1.5.1  General |R17|  p. 203
7.4.1.5.2  Protocol Errors |R17|  p. 203
7.4.1.5.3  Application Errors |R17|  p. 203

7.4.1.6  Feature negotiation  p. 204

7.4.2  SS_NetworkResourceMonitoring API |R17|  p. 204

7.4.2.1  API URI  p. 204

7.4.2.2  Resources  p. 204

7.4.2.2.1  Overview  p. 204
7.4.2.2.2  Resource: Unicast Monitoring Subscriptions  p. 205
7.4.2.2.2.1  Description  p. 205
7.4.2.2.2.2  Resource Definition  p. 205
7.4.2.2.2.3  Resource Standard Methods  p. 205
7.4.2.2.2.3.1  POST  p. 205
7.4.2.2.2.4  Resource Custom Operations  p. 206
7.4.2.2.3  Resource: Individual Unicast Monitoring Subscription  p. 206
7.4.2.2.3.1  Description  p. 206
7.4.2.2.3.2  Resource Definition  p. 206
7.4.2.2.3.3  Resource Standard Methods  p. 206
7.4.2.2.3.3.1  DELETE  p. 206
7.4.2.2.3.3.2  GET  p. 207
7.4.2.2.3.3.3  PUT   p. 208
7.4.2.2.3.3.4  PATCH   p. 209
7.4.2.3.2  Individual Unicast Monitoring Notification  p. 210
7.4.2.3.2.1  Description  p. 210
7.4.2.3.2.2  Notification definition  p. 210

7.4.2.4  Data Model  p. 211

7.4.2.4.1  General  p. 211
7.4.2.4.2  Structured data types  p. 213
7.4.2.4.2.1  Introduction  p. 213
7.4.2.4.2.2  Type: MonitoringReport  p. 213
7.4.2.4.2.3  Type: MeasurementData  p. 213
7.4.2.4.2.4  Type: MeasurementPeriod  p. 213
7.4.2.4.2.5  Type: ReportingRequirements  p. 214
7.4.2.4.2.6  Type: MeasurementRequirements  p. 215
7.4.2.4.2.7  Type: MonitoringSubscription  p. 215
7.4.2.4.2.8  Void
7.4.2.4.2.9  Type: FailureReport  p. 216
7.4.2.4.2.10  Type: ReportingThreshold  p. 216
7.4.2.4.2.11  Type: MonitoringSubscriptionPatch   p. 216
7.4.2.4.3  Simple data types and enumerations  p. 217
7.4.2.4.3.1  Enumeration: MeasurementDataType  p. 217
7.4.2.4.3.2  Enumeration: TerminationMode  p. 217
7.4.2.4.3.3  Enumeration: FailureReason  p. 217
7.4.2.4.3.4  Enumeration: ThresholdHandlingMode  p. 217

7.4.2.5  Error Handling  p. 218

7.4.2.5.1  General  p. 218
7.4.2.5.2  Protocol Errors  p. 218
7.4.2.5.3  Application Errors  p. 218

7.4.2.6  Feature negotiation  p. 218

7.5  Event APIs  p. 218

7.5.1  SS_Events API  p. 218

7.5.1.1  API URI  p. 218

7.5.1.2  Resources  p. 219

7.5.1.2.1  Overview  p. 219
7.5.1.2.2  Resource: SEAL Events Subscriptions  p. 219
7.5.1.2.2.1  Description  p. 219
7.5.1.2.2.2  Resource Definition  p. 219
7.5.1.2.2.3  Resource Standard Methods  p. 220
7.5.1.2.2.3.1  POST  p. 220
7.5.1.2.2.4  Resource Custom Operations  p. 220
7.5.1.2.3  Resource: Individual SEAL Events Subscription  p. 220
7.5.1.2.3.1  Description  p. 220
7.5.1.2.3.2  Resource Definition  p. 220
7.5.1.2.3.3  Resource Standard Methods  p. 221
7.5.1.2.3.3.1  DELETE  p. 221
7.5.1.2.3.3.2  PATCH   p. 222
7.5.1.2.3.3.3  PUT   p. 222
7.5.1.2.3.4  Resource Custom Operations  p. 223

7.5.1.3  Notifications  p. 223

7.5.1.3.1  General  p. 223
7.5.1.3.2  SEAL Event Notification  p. 224
7.5.1.3.2.1  Description  p. 224
7.5.1.3.2.2  Notification definition  p. 224

7.5.1.4  Data Model  p. 225

7.5.1.4.1  General  p. 225
7.5.1.4.2  Structured data types  p. 228
7.5.1.4.2.1  Introduction  p. 228
7.5.1.4.2.2  SEALEventSubscription  p. 228
7.5.1.4.2.3  SEALEventNotification  p. 229
7.5.1.4.2.4  EventSubscription  p. 230
7.5.1.4.2.5  SEALEventDetail  p. 231
7.5.1.4.2.6  VALGroupFilter  p. 232
7.5.1.4.2.7  IdentityFilter  p. 232
7.5.1.4.2.8  LMInformation  p. 232
7.5.1.4.2.9  MessageFilter   p. 233
7.5.1.4.2.10  MonitorFilter   p. 233
7.5.1.4.2.11  MonitorEvents   p. 233
7.5.1.4.2.12  MonitorEventsReport   p. 234
7.5.1.4.2.13  ValidityConditions   p. 234
7.5.1.4.2.14  MonitorLocationInterestFilter   p. 234
7.5.1.4.2.15  LocationDevMonReport   p. 234
7.5.1.4.2.16  TempGroupInfo   p. 235
7.5.1.4.2.17  MonLocAreaInterestFltr   p. 235
7.5.1.4.2.18  LocationInfoCriteria   p. 235
7.5.1.4.2.19  ReferenceUEDetail   p. 235
7.5.1.4.2.20  LocationAreaMonReport   p. 236
7.5.1.4.2.21  MoveInOutUEDetails   p. 236
7.5.1.4.2.22  SEALEventSubscriptionPatch   p. 236
7.5.1.4.2.23  PartialEventSubscFailRep   p. 237
7.5.1.4.3  Simple data types and enumerations  p. 237
7.5.1.4.3.1  Introduction  p. 237
7.5.1.4.3.2  Simple data types  p. 237
7.5.1.4.3.3  Enumeration: SEALEvent  p. 238
7.5.1.4.3.4  Enumeration: LocDevNotification   p. 238
7.5.1.4.3.5  Enumeration: MonLocTriggerEvent   p. 238

7.5.1.5  Error Handling  p. 239

7.5.1.5.1  General |R17|  p. 239
7.5.1.5.2  Protocol Errors |R17|  p. 239
7.5.1.5.3  Application Errors |R17|  p. 239

7.5.1.6  Feature Negotiation  p. 239

7.6  Key management APIs  p. 240

7.6.1  SS_KeyInfoRetrieval API  p. 240

7.6.1.1  API URI  p. 240

7.6.1.2  Resources  p. 241

7.6.1.2.1  Overview  p. 241
7.6.1.2.2  Resource: Key Records  p. 241
7.6.1.2.2.1  Description  p. 241
7.6.1.2.2.2  Resource Definition  p. 241
7.6.1.2.2.3  Resource Standard Methods  p. 242
7.6.1.2.2.3.1  GET  p. 242
7.6.1.2.2.4  Resource Custom Operations  p. 243

7.6.1.3  Notifications  p. 243

7.6.1.4  Data Model  p. 243

7.6.1.4.1  General  p. 243
7.6.1.4.2  Structured Data Types  p. 243
7.6.1.4.2.1  Introduction  p. 243
7.6.1.4.2.2  ValKeyInfo  p. 243
7.6.1.4.3  Simple data types and enumerations  p. 244

7.6.1.5  Error Handling  p. 244

7.6.1.5.1  General |R17|  p. 244
7.6.1.5.2  Protocol Errors |R17|  p. 244
7.6.1.5.3  Application Errors |R17|  p. 244

7.6.1.6  Feature Negotiation  p. 244

7.6.2  SS_KMParametersProvisioning API |R18|  p. 244

7.6.2.1  Introduction  p. 244

7.6.2.2  Usage of HTTP  p. 245

7.6.2.3  Resources  p. 245

7.6.2.4  Custom operations without associated resources  p. 245

7.6.2.4.1  Overview  p. 245
7.6.2.4.2  Operation: Request  p. 245
7.6.2.4.2.1  Description  p. 245
7.6.2.4.2.2  Operation Definition  p. 245

7.6.2.5  Notifications  p. 246

7.6.2.6  Data Model  p. 246

7.6.2.6.1  General  p. 246
7.6.2.6.2  Structured data types  p. 247
7.6.2.6.2.1  Introduction  p. 247
7.6.2.6.2.2  Type: VALKeyPpReq  p. 247
7.6.2.6.2.3  Type: VALKeyPpResp  p. 248
7.6.2.6.3  Simple data types and enumerations  p. 248
7.6.2.6.3.1  Introduction  p. 248
7.6.2.6.3.2  Simple data types  p. 248
7.6.2.6.4  Data types describing alternative data types or combinations of data types  p. 248
7.6.2.6.5  Binary data  p. 248
7.6.2.6.5.1  Binary Data Types  p. 248

7.6.2.7  Error Handling  p. 249

7.6.2.7.1  General  p. 249
7.6.2.7.2  Protocol Errors  p. 249
7.6.2.7.3  Application Errors  p. 249

7.6.2.8  Feature negotiation  p. 249

7.7  Network Slice Capability Enablement APIs |R17|  p. 249

7.8  Identity management APIs |R18|  p. 249

7.8.1  SS_IdmParameterProvisioning API  p. 249

7.8.1.1  API URI  p. 249

7.8.1.2  Resources  p. 250

7.8.1.2.1  Overview  p. 250
7.8.1.2.2  Resource: VAL Services Configurations  p. 250
7.8.1.2.2.1  Description  p. 250
7.8.1.2.2.2  Resource Definition  p. 250
7.8.1.2.2.3  Resource Standard Methods  p. 251
7.8.1.2.2.3.1  POST  p. 251
7.8.1.2.2.3.2  GET  p. 251
7.8.1.2.2.4  Resource Custom Operations  p. 253
7.8.1.2.3  Resource: Individual VAL Services Configuration  p. 253
7.8.1.2.3.1  Description  p. 253
7.8.1.2.3.2  Resource Definition  p. 253
7.8.1.2.3.3  Resource Standard Methods  p. 253
7.8.1.2.3.3.1  GET  p. 253
7.8.1.2.3.3.2  PUT  p. 254
7.8.1.2.3.3.3  PATCH  p. 255
7.8.1.2.3.3.4  DELETE  p. 256
7.8.1.2.3.4  Resource Custom Operations  p. 257

7.8.1.3  Custom operations without associated resources  p. 257

7.8.1.4  Notifications  p. 257

7.8.1.5  Data Model  p. 258

7.8.1.5.1  General  p. 258
7.8.1.5.2  Structured data types  p. 258
7.8.1.5.2.1  Introduction  p. 258
7.8.1.5.2.2  Type: VALServicesConfig  p. 258
7.8.1.5.2.3  Type: VALServiceParams  p. 258
7.8.1.5.2.4  Type: VALServicesConfigPatch  p. 259
7.8.1.5.3  Simple data types and enumerations  p. 259
7.8.1.5.3.1  Introduction  p. 259
7.8.1.5.3.2  Simple data types  p. 259
7.8.1.5.4  Data types describing alternative data types or combinations of data types  p. 259
7.8.1.5.5  Binary data  p. 259
7.8.1.5.5.1  Binary Data Types  p. 259

7.8.1.6  Error Handling  p. 259

7.8.1.6.1  General  p. 259
7.8.1.6.2  Protocol Errors  p. 259
7.8.1.6.3  Application Errors  p. 259

7.8.1.7  Feature negotiation  p. 260

7.9  Data Delivery APIs |R18|  p. 260

7.10  Application data analytics enablement service configuration APIs |R18|  p. 260

7.10.1  SS_ADAE_VALPerformanceAnalytics API  p. 260

7.10.1.1  API URI  p. 260

7.10.1.2  Resources  p. 260

7.10.1.2.1  Overview  p. 260
7.10.1.2.2  Resource: Application performance event subscription  p. 261
7.10.1.2.2.1  Description  p. 261
7.10.1.2.2.2  Resource Definition  p. 261
7.10.1.2.2.3  Resource Standard Methods  p. 261
7.10.1.2.2.3.1  POST  p. 261
7.10.1.2.2.4  Resource Custom Operations  p. 262

7.10.1.3  Notifications  p. 264

7.10.1.3.2  Application performance event notification  p. 264
7.10.1.3.2.1  Description  p. 264
7.10.1.3.2.2  Notification definition  p. 265

7.10.1.4  Data Model  p. 266

7.10.1.4.1  General  p. 266
7.10.1.4.2  Structured data types  p. 267
7.10.1.4.2.1  Introduction  p. 267
7.10.1.4.2.2  Type: AppPerfSub  p. 267
7.10.1.4.2.3  Type: AppPerfNotif  p. 268
7.10.1.4.2.4  Type: ProdProfileInfo  p. 268
7.10.1.4.2.5  Type: ProducerCap  p. 269
7.10.1.4.3  Simple data types and enumerations  p. 269
7.10.1.4.3.1  Introduction  p. 269
7.10.1.4.3.2  Simple data types  p. 269
7.10.1.4.3.3  Enumeration: AnalyticsCategory  p. 269
7.10.1.4.3.4  Enumeration: ProducerType  p. 269
7.10.1.4.3.5  Enumeration: ProducerData  p. 270
7.10.1.4.3.6  Enumeration: ProducerRole  p. 270
7.10.1.4.3.7  Void

7.10.1.5  Error Handling  p. 270

7.10.1.5.1  General  p. 270
7.10.1.5.2  Protocol Errors  p. 270
7.10.1.5.3  Application Errors  p. 270

7.10.1.6  Feature Negotiation  p. 270

7.10.2  SS_ADAE_SlicePerformanceAnalytics API  p. 271

7.10.2.1  API URI  p. 271

7.10.2.2  Resources  p. 271

7.10.2.2.1  Overview  p. 271
7.10.2.2.2  Resource: Slice-specific application performance event subscription  p. 272
7.10.2.2.2.1  Description  p. 272
7.10.2.2.2.2  Resource Definition  p. 272
7.10.2.2.2.3  Resource Standard Methods  p. 272
7.10.2.2.2.3.1  POST  p. 272
7.10.2.2.2.4  Resource Custom Operations  p. 273

7.10.2.3  Notifications  p. 275

7.10.2.3.2  Slice-specific application performance event notification  p. 275
7.10.2.3.2.1  Description  p. 275
7.10.2.3.2.2  Notification definition  p. 276

7.10.2.4  Data Model  p. 277

7.10.2.4.1  General  p. 277
7.10.2.4.2  Structured data types  p. 277
7.10.2.4.2.1  Introduction  p. 277
7.10.2.4.2.2  Type: SliceAppPerfSub  p. 278
7.10.2.4.2.3  Type: SliceAppPerfNotif  p. 278

7.10.2.5  Error Handling  p. 278

7.10.2.5.1  General  p. 278
7.10.2.5.2  Protocol Errors  p. 279
7.10.2.5.3  Application Errors  p. 279

7.10.2.6  Feature Negotiation  p. 279

7.10.3  SS_ADAE_Ue2UePerformanceAnalytics API  p. 279

7.10.3.1  API URI  p. 279

7.10.3.2  Resources  p. 279

7.10.3.2.1  Overview  p. 279
7.10.3.2.2  Resource: UE-to-UE session performance event subscription  p. 280
7.10.3.2.2.1  Description  p. 280
7.10.3.2.2.2  Resource Definition  p. 280
7.10.3.2.2.3  Resource Standard Methods  p. 280
7.10.3.2.2.3.1  POST  p. 280
7.10.3.2.2.4  Resource Custom Operations  p. 281
7.10.3.2.3  Resource: Individual UE-to-UE Session Performance Event Subscription  p. 281
7.10.3.2.3.1  Description  p. 281
7.10.3.2.3.2  Resource Definition  p. 281
7.10.3.2.3.3  Resource Standard Methods  p. 281
7.10.3.2.3.3.1  GET  p. 281
7.10.3.2.3.3.2  DELETE  p. 282

7.10.3.3  Notifications  p. 283

7.10.3.3.2  UE-to-UE session performance event notification  p. 283
7.10.3.3.2.1  Description  p. 283
7.10.3.3.2.2  Notification definition  p. 284

7.10.3.4  Data Model  p. 285

7.10.3.4.1  General  p. 285
7.10.3.4.2  Structured data types  p. 286
7.10.3.4.2.1  Introduction  p. 286
7.10.3.4.2.2  Type: U2UPerfSub  p. 287
7.10.3.4.2.3  Type: U2UPerfNotif  p. 287
7.10.3.4.2.4  Void
7.10.3.4.2.5  Type: U2UThreshold  p. 288
7.10.3.4.2.6  Type: U2UAnalyticsData  p. 288
7.10.3.4.2.7  Type: U2UPair  p. 288
7.10.3.4.3  Simple data types and enumerations  p. 288
7.10.3.4.3.1  Enumeration: U2UAnalytics  p. 288
7.10.3.4.3.2  Enumeration: U2UReportingGranularity  p. 289

7.10.3.5  Error Handling  p. 289

7.10.3.5.1  General  p. 289
7.10.3.5.2  Protocol Errors  p. 289
7.10.3.5.3  Application Errors  p. 289

7.10.3.6  Feature Negotiation  p. 289

7.10.4  SS_ADAE_LocationAccuracyAnalytics API  p. 289

7.10.4.1  API URI  p. 289

7.10.4.2  Resources  p. 290

7.10.4.2.1  Overview  p. 290
7.10.4.2.2  Resource: Location accuracy event subscription  p. 290
7.10.4.2.2.1  Description  p. 290
7.10.4.2.2.2  Resource Definition  p. 290
7.10.4.2.2.3  Resource Standard Methods  p. 291
7.10.4.2.2.3.1  POST  p. 291
7.10.4.2.2.4  Resource Custom Operations  p. 291

7.10.4.3  Notifications  p. 294

7.10.4.3.2  Location accuracy event notification  p. 294
7.10.4.3.2.1  Description  p. 294
7.10.4.3.2.2  Notification definition  p. 294

7.10.4.4  Data Model  p. 295

7.10.4.4.1  General  p. 295
7.10.4.4.2  Structured data types  p. 296
7.10.4.4.2.1  Introduction  p. 296
7.10.4.4.2.2  Type: LocAccurSub  p. 296
7.10.4.4.2.3  Type: LocAccurNotif  p. 297

7.10.4.5  Error Handling  p. 297

7.10.4.5.1  General  p. 297
7.10.4.5.2  Protocol Errors  p. 297
7.10.4.5.3  Application Errors  p. 297

7.10.4.6  Feature Negotiation  p. 297

7.10.5  SS_ADAE_ServiceApiAnalytics API  p. 297

7.10.5.1  API URI  p. 297

7.10.5.2  Resources  p. 298

7.10.5.2.1  Overview  p. 298
7.10.5.2.2  Resource: Service API event subscription  p. 298
7.10.5.2.2.1  Description  p. 298
7.10.5.2.2.2  Resource Definition  p. 298
7.10.5.2.2.3  Resource Standard Methods  p. 299
7.10.5.2.2.3.1  POST  p. 299
7.10.5.2.2.4  Resource Custom Operations  p. 299

7.10.5.3  Notifications  p. 302

7.10.5.3.2  Service API event notification  p. 302
7.10.5.3.2.1  Description  p. 302
7.10.5.3.2.2  Notification definition  p. 302

7.10.5.4  Data Model  p. 303

7.10.5.4.1  General  p. 303
7.10.5.4.2  Structured data types  p. 304
7.10.5.4.2.1  Introduction  p. 304
7.10.5.4.2.2  Type: SrvApiSub  p. 304
7.10.5.4.2.3  Type: SrvApiNotif  p. 305
7.10.5.4.3  Simple data types and enumerations  p. 305
7.10.5.4.3.1  Introduction  p. 305
7.10.5.4.3.2  Simple data types  p. 305

7.10.5.5  Error Handling  p. 305

7.10.5.5.1  General  p. 305
7.10.5.5.2  Protocol Errors  p. 305
7.10.5.5.3  Application Errors  p. 305

7.10.5.6  Feature Negotiation  p. 305

7.10.6  SS_ADAE_SliceUsagePatternAnalytics API  p. 306

7.10.6.1  API URI  p. 306

7.10.6.2  Resources  p. 306

7.10.6.2.1  Overview  p. 306
7.10.6.2.2  Resource: Slice usage pattern event subscriptions  p. 307
7.10.6.2.2.1  Description  p. 307
7.10.6.2.2.2  Resource Definition  p. 307
7.10.6.2.2.3  Resource Standard Methods  p. 307
7.10.6.2.2.3.1  POST  p. 307
7.10.6.2.2.4  Resource Custom Operations  p. 308

7.10.6.3  Notifications  p. 310

7.10.6.3.2  Slice usage pattern event notification  p. 310
7.10.6.3.2.1  Description  p. 310
7.10.6.3.2.2  Notification definition  p. 310

7.10.6.4  Data Model  p. 311

7.10.6.4.1  General  p. 311
7.10.6.4.2  Structured data types  p. 312
7.10.6.4.2.1  Introduction  p. 312
7.10.6.4.2.2  Type: SUPSub  p. 313
7.10.6.4.2.3  Type: SUPNotif  p. 314
7.10.6.4.2.4  Void
7.10.6.4.2.5  Void
7.10.6.4.3  Simple data types and enumerations  p. 314
7.10.6.4.3.1  Introduction  p. 314
7.10.6.4.3.2  Simple data types  p. 314
7.10.6.4.3.3  Enumeration: NetworkSliceType  p. 314

7.10.6.5  Error Handling  p. 314

7.10.6.5.1  General  p. 314
7.10.6.5.2  Protocol Errors  p. 315
7.10.6.5.3  Application Errors  p. 315

7.10.6.6  Feature Negotiation  p. 315

7.10.7  SS_ADAE_EdgeLoadAnalytics API  p. 315

7.10.7.1  API URI  p. 315

7.10.7.2  Resources  p. 315

7.10.7.2.1  Overview  p. 315
7.10.7.2.2  Resource: Edge Load Event Subscription  p. 316
7.10.7.2.2.1  Description  p. 316
7.10.7.2.2.2  Resource Definition  p. 316
7.10.7.2.2.3  Resource Standard Methods  p. 317
7.10.7.2.2.3.1  POST  p. 317
7.10.7.2.2.4  Resource Custom Operations  p. 317
7.10.7.2.3  Resource: Individual Edge Load Event Subscription  p. 317
7.10.7.2.3.1  Description  p. 317
7.10.7.2.3.2  Resource Definition  p. 317
7.10.7.2.3.3  Resource Standard Methods  p. 318
7.10.7.2.3.3.1  GET  p. 318
7.10.7.2.3.3.2  DELETE  p. 319
7.10.7.2.3.4  Resource Custom Operations  p. 319

7.10.7.3  Notifications  p. 320

7.10.7.3.2  Edge load event notification  p. 320
7.10.7.3.2.1  Description  p. 320
7.10.7.3.2.2  Notification definition  p. 320

7.10.7.4  Data Model  p. 321

7.10.7.4.1  General  p. 321
7.10.7.4.2  Structured data types  p. 322
7.10.7.4.2.1  Introduction  p. 322
7.10.7.4.2.2  Type: EdgeSub  p. 323
7.10.7.4.2.3  Type: EdgeNotif  p. 323
7.10.7.4.2.4  Void
7.10.7.4.2.5  Void
7.10.7.4.2.6  Void

7.10.7.5  Error Handling  p. 324

7.10.7.5.1  General  p. 324
7.10.7.5.2  Protocol Errors  p. 324
7.10.7.5.3  Application Errors  p. 324

7.10.7.6  Feature Negotiation  p. 324

7.10.8  SS_AADRF_DataManagement API  p. 324

7.10.8.1  API URI  p. 324

7.10.8.2  Resources  p. 325

7.10.8.2.1  Overview  p. 325
7.10.8.2.2  Resource: A-ADRF Data Management Subscriptions  p. 325
7.10.8.2.2.1  Description  p. 325
7.10.8.2.2.2  Resource Definition  p. 325
7.10.8.2.2.3  Resource Standard Methods  p. 326
7.10.8.2.2.3.1  POST  p. 326
7.10.8.2.2.4  Resource Custom Operations  p. 326
7.10.8.2.3  Resource: Individual A-ADRF Data Management Subscription  p. 326
7.10.8.2.3.1  Description  p. 326
7.10.8.2.3.2  Resource definition  p. 326
7.10.8.2.3.3  Resource Standard Methods  p. 327
7.10.8.2.3.3.1  DELETE  p. 327
7.10.8.2.3.4  Resource Custom Operations  p. 328

7.10.8.3  Custom Operations without associated resources  p. 328

7.10.8.4  Notifications  p. 328

7.10.8.4.1  General  p. 328
7.10.8.4.2  Event Notification  p. 328
7.10.8.4.2.1  Description  p. 328
7.10.8.4.2.2  Notification definition  p. 328

7.10.8.5  Data Model  p. 329

7.10.8.5.1  General  p. 329
7.10.8.5.2  Structured data types  p. 331
7.10.8.5.2.1  Introduction  p. 331
7.10.8.5.2.2  Type: DataManageSub  p. 331
7.10.8.5.2.3  Type: EventSubscription  p. 331
7.10.8.5.2.4  Type: EdgeReq  p. 332
7.10.8.5.2.5  Type: ApiLogReq  p. 332
7.10.8.5.2.6  Type: DataManageNotification  p. 333
7.10.8.5.2.7  Type: ApiLogInfo  p. 334
7.10.8.5.2.8  Type: EdgeInfo  p. 334
7.10.8.5.3  Simple data types and enumerations  p. 334
7.10.8.5.3.1  Enumeration: AadrfEvent  p. 334
7.10.8.5.3.2  Enumeration: ExposureLevel  p. 335

7.10.8.6  Error Handling  p. 335

7.10.8.6.1  General  p. 335
7.10.8.6.2  Protocol Errors  p. 335
7.10.8.6.3  Application Errors  p. 335

7.10.8.7  Feature negotiation  p. 335

Up   Top   ToC