Newer
Older
"contact": {
"url": "https://forge.etsi.org/rep/mec/gs012-rnis-api"
},
"title": "ETSI GS MEC 012 - Radio Network Information API",
"version": "2.1.1",
"description": "The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.",
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
"description": "ETSI GS MEC 012 Radio Network Information API, V2.1.1",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/02.01.01_60/gs_mec012v020101p.pdf"
"url": "https://localhost/rni/v2"
}
],
"tags": [
{
"name": "rni"
"summary": "Retrieve information on Radio Access Bearers",
"description": "Queries information about the Radio Access Bearers",
"operationId": "rab_infoGET",
"$ref": "#/components/parameters/Query.UeIpv4Address"
"$ref": "#/components/parameters/Query.UeIpv6Address"
"$ref": "#/components/parameters/Query.NatedIpAddress"
"$ref": "#/components/parameters/Query.ErabMbrDl"
"$ref": "#/components/parameters/Query.ErabMbrUl"
"$ref": "#/components/parameters/Query.ErabGbrDl"
"$ref": "#/components/parameters/Query.ErabGbrUl"
}
],
"responses": {
"200": {
"description": "Successful response to rab_info request",
"summary": "Retrieve information on the underlying Mobile Network that the MEC application is associated to",
"description": "Queries information about the Mobile Network",
"operationId": "plmn_infoGET",
"$ref": "#/components/parameters/Query.AppInsIdArr"
}
],
"responses": {
"200": {
"description": "Successful response to plmn_info request",
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlmnInfo"
}
}
}
}
},
"400": {
"summary": "Retrieve S1-U bearer information related to specific UE(s)",
"description": "Queries information about the S1 bearer(s)",
"operationId": "s1_bearer_infoGET",
"$ref": "#/components/parameters/Query.TempUeId"
"$ref": "#/components/parameters/Query.UeIpv4Address"
"$ref": "#/components/parameters/Query.UeIpv6Address"
"$ref": "#/components/parameters/Query.NatedIpAddress"
"$ref": "#/components/parameters/Query.ErabIdArr"
}
],
"responses": {
"200": {
"description": "Successful response to s1_bearer_info request",
"content": {
"application/json": {
"schema": {
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
],
"summary": "Retrieve information on layer 2 measurements",
"description": "Queries information about the layer 2 measurements.",
"operationId": "layer2_meas_infoGET",
"parameters": [
{
"$ref": "#/components/parameters/Query.AppInsId"
},
{
"$ref": "#/components/parameters/Query.CellId"
},
{
"$ref": "#/components/parameters/Query.UeIpv4Address"
},
{
"$ref": "#/components/parameters/Query.UeIpv6Address"
},
{
"$ref": "#/components/parameters/Query.NatedIpAddress"
},
{
"$ref": "#/components/parameters/Query.GtpTeid"
},
{
"$ref": "#/components/parameters/Query.DlGbrPrbUsageCell"
},
{
"$ref": "#/components/parameters/Query.UlGbrPrbUsageCell"
},
{
"$ref": "#/components/parameters/Query.DlNonGbrPrbUsageCell"
},
{
"$ref": "#/components/parameters/Query.UlNonGbrPrbUsageCell"
},
{
"$ref": "#/components/parameters/Query.DlTotalPrbUsageCell"
},
{
"$ref": "#/components/parameters/Query.UlTotalPrbUsageCell"
},
{
"$ref": "#/components/parameters/Query.ReceivedDedicatedPreamblesCell"
},
{
"$ref": "#/components/parameters/Query.ReceivedRandomPreamblesLowRangeCell"
},
{
"$ref": "#/components/parameters/Query.ReceivedRandomPreamblesHighRangeCell"
},
{
"$ref": "#/components/parameters/Query.NumberOfActiveUeDlGbrCell"
},
{
"$ref": "#/components/parameters/Query.NumberOfActiveUeUlGbrCell"
},
{
"$ref": "#/components/parameters/Query.NumberOfActiveUeDlNonGbrCell"
},
{
"$ref": "#/components/parameters/Query.NumberOfActiveUeUlNonGbrCell"
},
{
"$ref": "#/components/parameters/Query.DlGbrPdrCell"
},
{
"$ref": "#/components/parameters/Query.UlGbrPdrCell"
},
{
"$ref": "#/components/parameters/Query.DlNonGbrPdrCell"
},
{
"$ref": "#/components/parameters/Query.UlNonGbrPdrCell"
},
{
"$ref": "#/components/parameters/Query.DlGbrDelayUe"
},
{
"$ref": "#/components/parameters/Query.UlGbrDelayUe"
},
{
"$ref": "#/components/parameters/Query.DlNonGbrDelayUe"
},
{
"$ref": "#/components/parameters/Query.UlNonGbrDelayUe"
},
{
"$ref": "#/components/parameters/Query.DlGbrPdrUe"
},
{
"$ref": "#/components/parameters/Query.UlGbrPdrUe"
},
{
"$ref": "#/components/parameters/Query.DlNonGbrPdrUe"
},
{
"$ref": "#/components/parameters/Query.UlNonGbrPdrUe"
},
{
"$ref": "#/components/parameters/Query.DlGbrThroughputUe"
},
{
"$ref": "#/components/parameters/Query.UlGbrThroughputUe"
},
{
"$ref": "#/components/parameters/Query.DlNonGbrThroughputUe"
},
{
"$ref": "#/components/parameters/Query.UlNonGbrThroughputUe"
},
{
"$ref": "#/components/parameters/Query.DlGbrDataVolumeUe"
},
{
"$ref": "#/components/parameters/Query.UlGbrDataVolumeUe"
},
{
"$ref": "#/components/parameters/Query.DlNonGbrDataVolumeUe"
},
{
"$ref": "#/components/parameters/Query.UlNonGbrDataVolumeUe"
}
"description": "Successful response to layer2 measurements info request",
"content": {
"$ref": "#/components/responses/406"
},
"414": {
"$ref": "#/components/responses/414"
],
"summary": "Retrieve information on subscriptions for notifications",
"description": "Queries information on subscriptions for notifications",
"operationId": "subscriptionLinkList_subscriptionsGET",
"parameters": [
{
"$ref": "#/components/parameters/Query.SubscriptionType"
}
"description": "Response body contains the list of links to requestors subscriptions.",
"content": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions"
}
},
"subscription": [
{
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
}
},
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"subscriptionType": "CellChangeSubscription"
}
]
"summary": "Create a new subscription",
"description": "Creates a new subscription to Radio Network Information notifications",
"operationId": "subscriptionsPOST",
"requestBody": {
"description": "Subscription to be created",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
},
"example": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
"description": "Successful subscription",
"content": {
"$ref": "#/components/schemas/InlineSubscription"
},
"example": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
}
}
}
}
},
"400": {
"$ref": "#/components/responses/429"
}
},
"callbacks": {
"notification": {
"{$request.body#/notificationSubscription.callbackReference}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": "Notification from RNIS, content based on subscription type",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineNotification"
},
"example": {
"notificationType": "CellChangeNotification",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
],
"hoStatus": 1,
"srcEcgi": {
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
"tempUeId": {
"mmec": 1,
"mtmsi": 69967622812
},
"timeStamp": {
"seconds": 1977836800,
"nanoseconds": 0
},
"trgEcgi": {
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "FEDCBAA"
}
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
}
"summary": "Retrieve information on current specific subscription",
"description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsGET",
}
],
"responses": {
"200": {
"description": "Subscription information regarding subscription notifications",
"content": {
"$ref": "#/components/schemas/InlineSubscription"
},
"example": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
}
}
}
}
},
"400": {
},
"x-swagger-router-controller": "subscriptions"
"summary": "Modify an existing subscription",
"description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsPUT",
"requestBody": {
"description": "Subscription to be modified",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InlineSubscription"
},
"example": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
}
},
"parameters": [
{
"$ref": "#/components/parameters/Path.subscrId"
}
],
"responses": {
"200": {
"description": "Successful subscription to response to subscription notifications",
"content": {
"application/json": {
"schema": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"_links": {
"self": {
"href": "http://meAppServer.example.com/rni/v2/subscriptions/sub123"
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
},
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"type": 1,
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
1,
2
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
},
"x-swagger-router-controller": "subscriptions"
"summary": "Cancel an existing subscription",
"description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "subscriptionsDELETE",
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"components": {
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
}
}
},
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"content": {
"414": {
"description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
"content": {
}
}
},
"415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": {
}
}
},
"422": {
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"content": {
},
"example": {
"application/problem+json": {
"type": "https://meAppServer.example.com/rni/v2/probs/too-many targets",
"title": "Too many targets",
"status": "422",
"detail": "The target area for the request is considered too large",
"instance": "/meAppClient.example.com/77777/msgs/abc"
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
}
}
}
},
"parameters": {
"Path.subscrId": {
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id, specifically the \"Self-referring URI\" returned in the subscription request",
"required": true,
"schema": {
"type": "string",
"format": "uri"
},
"x-exportParamName": "SubscriptionId"
},
"Query.AppInsId": {