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",
"schema": {
"type": "object",
"properties": {
"rabInfo": {
"$ref": "#/components/schemas/RabInfo"
}
}
}
}
}
},
"400": {
"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": {
"schema": {
"type": "object",
"properties": {
"plmnInfo": {
"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": {
"type": "object",
"required": [
"s1BearerInfo"
],
"properties": {
"s1BearerInfo": {
"$ref": "#/components/schemas/S1BearerInfo"
}
}
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
],
"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": {
"schema": {
"type": "object",
"required": [
"l2Meas"
],
"properties": {
"l2Meas": {
"$ref": "#/components/schemas/L2Meas"
}
}
}
}
}
},
"400": {
"$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": {
"schema": {
"type": "object",
"required": [
"subscriptionLinkList"
],
"properties": {
"subscriptionLinkList": {
"$ref": "#/components/schemas/SubscriptionLinkList"
}
}
},
"example": {
"subscriptionLinkList": {
"_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"
}
]
}
}
}
}
},
"400": {
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
"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": {
"type": "object",
"properties": {
"notificationSubscription": {
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
}
],
"discriminator": {
"propertyName": "subscriptionType"
}
}
},
"example": {
"notificationSubscription": {
"subscriptionType": "CellChangeSubscription",
"callbackReference": "http://my.callback.com/rni-cell-change/some-id",
"filterCriteriaAssocHo": {
"appInstanceId": "myApp",
"associateId": [
{
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
}
}
}
}
}
"description": "Successful subscription",
"content": {
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
"schema": {
"type": "object",
"properties": {
"notificationSubscription": {
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
}
],
"discriminator": {
"propertyName": "subscriptionType"
}
}
"example": {
"notificationSubscription": {
"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": [
{
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
}
}
}
}
}
}
},
"400": {
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
"$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": {
"type": "object",
"properties": {
"notification": {
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeNotification"
},
{
"$ref": "#/components/schemas/RabEstNotification"
},
{
"$ref": "#/components/schemas/RabModNotification"
},
{
"$ref": "#/components/schemas/RabRelNotification"
},
{
"$ref": "#/components/schemas/MeasRepUeNotification"
},
{
"$ref": "#/components/schemas/NrMeasRepUeNotification"
},
{
"$ref": "#/components/schemas/MeasTaNotification"
},
{
"$ref": "#/components/schemas/CaReconfNotification"
},
{
"$ref": "#/components/schemas/S1BearerNotification"
}
],
"discriminator": {
"propertyName": "notificationType"
}
}
},
"example": {
"notification": {
"notificationType": "CellChangeNotification",
"associateId": [
{
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
"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": {
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
"schema": {
"type": "object",
"required": [
"notificationSubscription"
],
"properties": {
"notificationSubscription": {
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
}
],
"discriminator": {
"propertyName": "subscriptionType"
}
}
"example": {
"notificationSubscription": {
"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": [
{
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
}
}
}
}
}
}
},
"400": {
},
"x-swagger-router-controller": "subscriptions"
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
"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": {
"type": "object",
"properties": {
"notificationSubscription": {
"oneOf": [
{
"$ref": "#/components/schemas/CellChangeSubscription"
},
{
"$ref": "#/components/schemas/RabEstSubscription"
},
{
"$ref": "#/components/schemas/RabModSubscription"
},
{
"$ref": "#/components/schemas/RabRelSubscription"
},
{
"$ref": "#/components/schemas/MeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/NrMeasRepUeSubscription"
},
{
"$ref": "#/components/schemas/MeasTaSubscription"
},
{
"$ref": "#/components/schemas/CaReconfSubscription"
},
{
"$ref": "#/components/schemas/S1BearerSubscription"
}
],
"discriminator": {
"propertyName": "subscriptionType"
}
}
},
"example": {
"notificationSubscription": {
"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": [
{
"value": "10.100.0.1"
}
],
"ecgi": [
{
"plmn": {
"mnc": "01",
"mcc": "001"
},
"cellId": "ACBDEFA"
}
],
"hoStatus": [
]
},
"expiryDeadline": {
"seconds": 1977836800,
"nanoseconds": 0
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/Path.subscrId"
}
],
"responses": {
"200": {
"description": "Successful subscription to response to subscription notifications",
"content": {
"application/json": {