Newer
Older
title: ETSI GS MEC 012 - Radio Network Information API
description: The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI.
contact:
url: https://forge.etsi.org/rep/mec/gs012-rnis-api
version: '2.1.1'
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
externalDocs:
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
tags:
- name: rni
/queries/rab_info:
summary: 'Retrieve information on Radio Access Bearers'
description: Queries information about the Radio Access Bearers
operationId: rab_infoGET
parameters:
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
- name: app_ins_id
in: query
description: Application instance identifier
style: form
explode: true
schema:
type: string
- name: cell_id
in: query
description: Comma separated list of E-UTRAN Cell Identities
style: form
explode: true
schema:
type: array
items:
type: string
- name: ue_ipv4_address
in: query
description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: ue_ipv6_address
in: query
description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: nated_ip_address
in: query
description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: gtp_teid
in: query
description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: erab_id
in: query
description: E-RAB identifier
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: qci
in: query
description: QoS Class Identifier as defined in ETSI TS 123 401
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: erab_mbr_dl
in: query
description: Maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: erab_mbr_ul
in: query
description: Maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: erab_gbr_dl
in: query
description: Guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: erab_gbr_ul
in: query
description: Guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401
style: form
explode: true
schema:
type: integer
contentEncoding: int32
responses:
'200':
description: Successful response to rab_info request
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/queries/plmn_info:
summary: 'Queries information about the Mobile Network'
description: Queries information about the Mobile Network
operationId: plmn_infoGET
parameters:
- name: app_ins_id
in: query
description: Comma separated list of Application instance identifiers
required: true
style: form
explode: true
schema:
type: array
items:
type: string
description: Successful response to plmn_info request
description: ''
contentMediaType: application/json
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/queries/s1_bearer_info:
summary: Retrieve S1-U bearer information related to specific UE(s)'
description: Queries information about the S1 bearer(s)
operationId: s1_bearer_infoGET
parameters:
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
- name: temp_ue_id
in: query
description: Comma separated list of temporary identifiers allocated for the specific UE as defined in ETSI TS 136 413
style: form
explode: true
schema:
type: array
items:
type: string
- name: ue_ipv4_address
in: query
description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: ue_ipv6_address
in: query
description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: nated_ip_address
in: query
description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: gtp_teid
in: query
description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: cell_id
in: query
description: Comma separated list of E-UTRAN Cell Identities
style: form
explode: true
schema:
type: array
items:
type: string
- name: erab_id
in: query
description: Comma separated list of E-RAB identifiers
style: form
explode: true
schema:
type: array
items:
type: integer
contentEncoding: int32
responses:
'200':
description: Successful response to s1_bearer_info request
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
summary: 'Retrieve information on layer 2 measurements'
description: Queries information about the layer 2 measurements.
operationId: layer2_meas_infoGET
parameters:
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
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
- name: app_ins_id
in: query
description: Application instance identifier
style: form
explode: true
schema:
type: string
- name: cell_id
in: query
description: Comma separated list of E-UTRAN Cell Identities
style: form
explode: true
schema:
type: array
items:
type: string
- name: ue_ipv4_address
in: query
description: Comma separated list of IE IPv4 addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: ue_ipv6_address
in: query
description: Comma separated list of IE IPv6 addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: nated_ip_address
in: query
description: Comma separated list of IE NATed IP addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: gtp_teid
in: query
description: Comma separated list of GTP TEID addresses as defined for the type for AssociateId
style: form
explode: true
schema:
type: array
items:
type: string
- name: dl_gbr_prb_usage_cell
in: query
description: PRB usage for downlink GBR traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_gbr_prb_usage_cell
in: query
description: PRB usage for uplink GBR traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_nongbr_prb_usage_cell
in: query
description: PRB usage for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_nongbr_prb_usage_cell
in: query
description: PRB usage for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_total_prb_usage_cell
in: query
description: PRB usage for total downlink traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_total_prb_usage_cell
in: query
description: PRB usage for total uplink traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: received_dedicated_preambles_cell
in: query
description: Received dedicated preambles in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: received_randomly_selected_preambles_low_range_cell
in: query
description: Received randomly selected preambles in the low range in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: received_randomly_selected_preambles_high_range_cell
in: query
description: Received rendomly selected preambles in the high range in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: number_of_active_ue_dl_gbr_cell
in: query
description: Number of active UEs with downlink GBR traffic as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: number_of_active_ue_ul_gbr_cell
in: query
description: Number of active UEs with uplink GBR traffic as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: number_of_active_ue_dl_nongbr_cell
in: query
description: Number of active UEs with downlink non-GBR traffic as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: number_of_active_ue_ul_nongbr_cell
in: query
description: Number of active UEs with uplink non-GBR traffic as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_gbr_pdr_cell
in: query
description: Packet discard rate for downlink GBR traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_gbr_pdr_cell
in: query
description: Packet discard rate for uplink GBR traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_nongbr_pdr_cell
in: query
description: Packet discard rate for downlink non-GBR traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_nongbr_pdr_cell
in: query
description: Packet discard rate for uplink non-GBR traffic in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_gbr_delay_ue
in: query
description: Packet delay of downlink GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_gbr_delay_ue
in: query
description: Packet delay of uplink GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_nongbr_delay_ue
in: query
description: Packet delay of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_nongbr_delay_ue
in: query
description: Packet delay of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_gbr_pdr_ue
in: query
description: Packet discard rate of downlink GBR traffic of a UE in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_gbr_pdr_ue
in: query
description: Packet discard rate of uplink GBR traffic of a UE in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_nongbr_pdr_ue
in: query
description: Packet discard rate of downlink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_nongbr_pdr_ue
in: query
description: Packet discard rate of uplink non-GBR traffic of a UE in percentage as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_gbr_throughput_ue
in: query
description: Scheduled throughput of downlink GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_gbr_throughput_ue
in: query
description: Scheduled throughput of uplink GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_nongbr_throughput_ue
in: query
description: Scheduled throughput of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_nongbr_throughput_ue
in: query
description: Scheduled throughput of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_gbr_data_volume_ue
in: query
description: Data volume of downlink GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_gbr_data_volume_ue
in: query
description: Data volume of uplink GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: dl_nongbr_data_volume_ue
in: query
description: Data volume of downlink non-GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: ul_nongbr_data_volume_ue
in: query
description: Data volume of uplink non-GBR traffic of a UE as defined in ETSI TS 136 314
style: form
explode: true
schema:
type: integer
contentEncoding: int32
description: Successful response to layer2 measurements info request
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
summary: 'Queries information on subscriptions for notifications'
description: Queries information on subscriptions for notifications
operationId: subscriptionLinkList_subscriptionsGET
parameters:
- name: subscription_type
in: query
description: 'Filter on a specific subscription type. Permitted values: cell_change, rab_est, rab_mod, rab_rel, meas_rep_ue, nr_meas_rep_ue, timing_advance_ue, ca_reconf, s1_bearer.'
style: form
explode: true
schema:
type: string
description: Response body contains the list of links to requestors subscriptions.
headers: {}
examples:
example-ofsub-link-list:
value:
_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
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
summary: 'Creates a new subscription to Radio Network Information notifications'
description: Creates a new subscription to Radio Network Information notifications
requestBody:
description: Subscription to be created
content:
application/json:
schema:
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'
description: Subscription to be created
contentMediaType: application/json
examples:
example-cell-change-subscription:callbacks:
value:
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'
cellId: 'ACBDEFA'
hoStatus:
- 1
- 2
expiryDeadline:
seconds: 1977836800
nanoSeconds: 0
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'
contentMediaType: application/json
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
examples:
example-call-change-subscription:
value:
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
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
type: https://meAppServer.example.com/rni/v2/probs/too-many targets
title: Too many targets
detail: The target area for the request is considered too large
instance: /meAppClient.example.com/77777/msgs/abc
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
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'
examples:
message:
value:
notificationType: CellChangeNotification
associateId:
- type: 1
value: '10.100.0.1'
hoStatus: 1
srcEcgi:
plmn:
mnc: '01'
mcc: '001'
cellId: 'ACBDEFA'
tempUeId:
mmec: 1
mtmsi: 001011231231234
timeStamp:
seconds: 1977836800
nanoSeconds: 0
trgEcgi:
plmn:
mnc: '01'
mcc: '001'
cellId: 'FEDCBAA'
responses:
'204':
description: "No content"
deprecated: false
parameters: []
/subscriptions/{subscriptionId}:
summary: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)
- name: subscriptionId
in: path
description: Subscription Id, specifically the "Self-referring URI" returned in the subscription request
required: true
style: simple
schema:
type: string
description: Subscription information regarding subscription notifications
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'
contentMediaType: application/json
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
examples:
example-of-cell-change-subscription:
value:
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
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
summary: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)
parameters:
- name: subscriptionId
in: path
description: Subscription Id, specifically the "Self-referring URI" returned in the subscription request
required: true
style: simple
schema:
type: string
requestBody:
description: Subscription to be modified
content:
application/json:
schema:
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'
description: Subscription to be modified
contentMediaType: application/json
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
examples:
example-of-cell-change-subscription:
value:
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
responses:
'200':
description: Successful subscription to response to subscription notifications
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'
contentMediaType: application/json
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
examples:
example-of-cell-change-subscription:
value:
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
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
value:
type: https://meAppServer.example.com/rni/v2/probs/too-many-targets
detail: The target area for the request is considered too large
instance: /meAppClient.example.com/77777/msgs/abc
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
summary: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)
description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)
operationId: subscriptionsDELETE
parameters:
- name: subscriptionId
in: path
description: Subscription Id, specifically the "Self-referring URI" returned in the subscription request
required: true
style: simple
schema:
type: string
description: No Content
headers: {}
content: {}
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
components:
title: AssociateId
type: object
$ref: '#/components/schemas/Type'
description: Value for the identifier.
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
title: CaReconfNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- ecgi
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
carrierAggregationMeasInfo:
type: array
items:
$ref: '#/components/schemas/CarrierAggregationMeasInfo'
description: This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to M.
ecgi:
$ref: '#/components/schemas/Ecgi'
secondaryCellAdd:
type: array
items:
$ref: '#/components/schemas/SecondaryCellAdd'
description: ''
secondaryCellRemove:
type: array
items:
$ref: '#/components/schemas/SecondaryCellRemove'
description: ''
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: CaReconfSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- callbackReference
- filterCriteriaAssoc
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAssoc:
$ref: '#/components/schemas/FilterCriteriaAssoc'
title: CellChangeNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- hoStatus
- srcEcgi
- trgEcgi
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
hoStatus:
$ref: '#/components/schemas/HoStatus'
srcEcgi:
tempUeId:
$ref: '#/components/schemas/TempUeId'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
trgEcgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: >-
E-UTRAN Cell Global Identifier of the target cell.
NOTE: Cardinality N is valid only in case of statuses IN_PREPARATION, REJECTED and CANCELLED.
title: CellChangeSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- callbackReference
- filterCriteriaAssocHo
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumerto receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAssocHo:
$ref: '#/components/schemas/FilterCriteriaAssocHo'
Ecgi:
title: Ecgi
type: string
description: String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3].
ExpiryNotification:
title: ExpiryNotification
$ref: '#/components/schemas/Links2'
properties:
cellInfo:
type: array
items:
$ref: '#/components/schemas/CellInfo'
description: The per cell measurement information as defined below.
cellUEInfo:
items:
$ref: '#/components/schemas/CellUEInfo'
description: The per cell per UE layer 2 measurements information as defined below.
properties:
href:
type: string
description: URI referring to a resource
title: MeasQuantityResultsNr
type: object
description: Reference Signal Received Power as defined in ETSI TS 138 331 [i.13].
contentEncoding: int32
description: Reference Signal Received Quality as defined in ETSI TS 138 331 [i.13].
contentEncoding: int32
description: Reference Signal to Interference & Noise Ratio as defined in ETSI TS 138 331 [i.13].
contentEncoding: int32
title: MeasRepUeNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- ecgi
- rsrp
- rsrq
- trigger
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
carrierAggregationMeasInfo:
type: array
items:
$ref: '#/components/schemas/CarrierAggregationMeasInfo1'
description: This parameter can be repeated to contain information of all the carriers assign for Carrier Aggregation up to M.
ecgi:
$ref: '#/components/schemas/Ecgi'
eutranNeighbourCellMeasInfo:
type: array
items:
$ref: '#/components/schemas/EutranNeighbourCellMeasInfo'
description: This parameter can be repeated to contain information of all the neighbouring cells up to N.
heightUe:
type: integer
description: Indicates height of the UE in meters relative to the sea level as defined in ETSI TS 136.331 [i.7].
contentEncoding: int32
newRadioMeasInfo:
type: array
items:
$ref: '#/components/schemas/NewRadioMeasInfo'
description: 5G New Radio secondary serving cells measurement information.
newRadioMeasNeiInfo:
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
type: array
items:
$ref: '#/components/schemas/NewRadioMeasNeiInfo'
description: Measurement quantities concerning the 5G NR neighbours.
rsrp:
type: integer
description: Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrpEx:
type: integer
description: Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
rsrq:
type: integer
description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrqEx:
type: integer
description: Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
sinr:
type: integer
description: Reference Signal "Signal to Interference plus Noise Ratio", with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
timeStamp:
$ref: '#/components/schemas/TimeStamp'
trigger:
$ref: '#/components/schemas/Trigger'
MeasRepUeSubscription:
title: MeasRepUeSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- callbackReference
- filterCriteriaAssocTri
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAssocTri:
$ref: '#/components/schemas/FilterCriteriaAssocTri'
MeasTaNotification:
title: MeasTaNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- ecgi
- timingAdvance
type: object
properties:
associateId:
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
ecgi:
$ref: '#/components/schemas/Ecgi'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
timingAdvance:
type: integer
description: The timing advance as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
MeasTaSubscription:
title: MeasTaSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- callbackReference
- filterCriteriaAssoc
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaAssoc:
$ref: '#/components/schemas/FilterCriteriaAssoc'
NRcgi:
title: NRcgi
required:
- nrcellId
- plmn
type: object
description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
plmn:
$ref: '#/components/schemas/Plmn'
NrMeasRepUeNotification:
title: NrMeasRepUeNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- triggerNr
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
eutraNeighCellMeasInfo:
type: array
items:
$ref: '#/components/schemas/EutraNeighCellMeasInfo'
description: This parameter can be repeated to contain measurement information of all the neighbouring cells up to N. It shall not be included if nrNeighCellMeasInfo is included.
nrNeighCellMeasInfo:
type: array
items:
$ref: '#/components/schemas/NrNeighCellMeasInfo'
description: This parameter can be repeated to contain measurement information of all the neighbouring cells up to N. It shall not be included if eutraNeighCellMeasInfo is included.
servCellMeasInfo:
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
type: array
items:
$ref: '#/components/schemas/ServCellMeasInfo'
description: This parameter can be repeated to contain information of all the serving cells up to N.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
triggerNr:
$ref: '#/components/schemas/TriggerNr'
NrMeasRepUeSubscription:
title: NrMeasRepUeSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- callbackReference
- filterCriteriaNrMrs
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaNrMrs:
$ref: '#/components/schemas/FilterCriteriaNrMrs'
Plmn:
title: Plmn
description: The Mobile Country Code part of PLMN Identity as defined in ETSI TS 136 413 [i.3].
mnc:
description: The Mobile Network Code part of PLMN Identity as defined in ETSI TS 136 413 [i.3].
PlmnInfo:
title: PlmnInfo
type: string
description: Unique identifier for the MEC application instance.
plmn:
items:
$ref: '#/components/schemas/Plmn'
description: Public Land Mobile Network Identity.
title: ProblemDetails
type: object
description: A human-readable explanation specific to this occurrence of the problem
description: A URI reference that identifies the specific occurrence of the problem
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
description: A short, human-readable summary of the problem type
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title: RabEstNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- ecgi
- erabId
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to bind the event for a specific UE or flow.
ecgi:
$ref: '#/components/schemas/Ecgi'
erabId:
type: integer
description: The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].
contentEncoding: int32
erabQosParameters:
$ref: '#/components/schemas/ErabQosParameters'
tempUeId:
$ref: '#/components/schemas/TempUeId'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: RabEstSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- callbackReference
- filterCriteriaQci
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaQci:
$ref: '#/components/schemas/FilterCriteriaQci'
RabInfo:
title: RabInfo
type: object
properties:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
items:
$ref: '#/components/schemas/CellUserInfo'
description: The information on users per cell as defined below.
description: Unique identifier allocated by the service consumer for the RAB Information request.
title: RabModNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- ecgi
- erabId
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to bind the event for a specific UE or flow.
ecgi:
$ref: '#/components/schemas/Ecgi'
erabId:
type: integer
description: The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].
contentEncoding: int32
erabQosParameters:
$ref: '#/components/schemas/ErabQosParameters2'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: RabModSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- callbackReference
- filterCriteriaQci
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaQci:
$ref: '#/components/schemas/FilterCriteriaQci1'
title: RabRelNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- ecgi
- erabReleaseInfo
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to bind the event for a specific UE or flow as defined below.
ecgi:
$ref: '#/components/schemas/Ecgi'
erabReleaseInfo:
$ref: '#/components/schemas/ErabReleaseInfo'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: RabRelSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- callbackReference
- filterCriteriaQci
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumer to receive notifications on the subscribed RNIS information. This shall be included both in the request and in response.
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
filterCriteriaQci:
$ref: '#/components/schemas/FilterCriteriaQci1'
ResultsPerCsiRsIndex:
title: ResultsPerCsiRsIndex
type: object
properties:
csiRsIndex:
type: integer
title: ResultsPerCsiRsIndexList
type: object
$ref: '#/components/schemas/ResultsPerCsiRsIndex'
title: ResultsPerSsbIndex
required:
- ssbIndex
type: object
title: ResultsPerSsbIndexList
type: object
$ref: '#/components/schemas/ResultsPerSsbIndex'
title: RsIndexResults
required:
- resultsCsiRsIndexes
- resultsSsbIndexes
type: object
S1BearerInfo:
title: S1BearerInfo
$ref: '#/components/schemas/S1UeInfo'
description: Information on a specific UE as defined below.
title: S1BearerNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- required:
- s1Event
- s1UeInfo
type: object
properties:
s1Event:
type: integer
description: The subscribed event that triggered this notification in S1BearerSubscription.
contentEncoding: int32
s1UeInfo:
$ref: '#/components/schemas/S1UeInfo1'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: S1BearerSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- S1BearerSubscriptionCriteria
- callbackReference
- eventType
type: object
properties:
S1BearerSubscriptionCriteria:
$ref: '#/components/schemas/S1BearerSubscriptionCriteria'
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
description: URI selected by the service consumer, to receive notifications on the subscribed RNIS information. This shall be included in the request and response.
eventType:
type: array
items:
type: integer
contentEncoding: int32
description: 'Description of the subscribed event. The event is included both in the request and in the response. \nFor the eventType, the following values are currently defined: <p>0 = RESERVED. <p>1 = S1_BEARER_ESTABLISH. <p>2 = S1_BEARER_MODIFY. <p>3 = S1_BEARER_RELEASE.'
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
SubscriptionLinkList:
title: SubscriptionLinkList
$ref: '#/components/schemas/Links10'
TimeStamp:
title: TimeStamp
type: object
properties:
nanoSeconds:
type: integer
description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
contentEncoding: int32
description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
contentEncoding: int32
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
- 0
- 1
- 2
- 3
- 4
- 5
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 30
- 31
- 40
- 41
- 42
- 50
- 51
- 60
- 61
type: integer
description: As defined in Ref ETSI TS 136 331 [i.7] <p>0 = NOT_AVAILABLE <p>1 = PERIODICAL_REPORT_STRONGEST_CELLS <p>2 = PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON <p>3 = PERIODICAL_REPORT_CGI <p>4 = INTRA_PERIODICAL_REPORT_STRONGEST_CELLS <p>5 = INTRA_PERIODICAL_REPORT_CGI <p>10 = EVENT_A1 <p>11 = EVENT_A2 <p>12 = EVENT_A3 <p>13 = EVENT_A4 <p>14 = EVENT_A5 <p>15 = EVENT_A6 <p>20 = EVENT_B1 <p>21 = EVENT_B2 <p>20 = EVENT_B1-NR <p>21 = EVENT_B2-NR <p>30 = EVENT_C1 <p>31 = EVENT_C2 <p>40 = EVENT_W1 <p>41 = EVENT_W2 <p>42 = EVENT_W3 <p>50 = EVENT_V1 <p>51 = EVENT_V2 <p>60 = EVENT_H1 <p>61 = EVENT_H2
examples:
- 0
- 0
- 1
- 2
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 30
- 31
type: integer
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
description: The enumeration Trigger represents specified triggers for a 5G UE Measurement Report. Full details can be found in ETSI TS 138 331 [i.13]). <p>0 = NOT_AVAILABLE <p>1 = NR_PERIODICAL <p>2 = NR_CGI <p>10 = EVENT_A1 <p>11 = EVENT_A2 <p>12 = EVENT_A3 <p>13 = EVENT_A4 <p>14 = EVENT_A5 <p>15 = EVENT_A6 <p>20 = INTER_RAT_PERIODICAL <p>21 = INTER_RAT_CGI <p>30 = EVENT_B1 <p>31 = EVENT_B2
examples:
- 0
CarrierAggregationMeasInfo:
title: CarrierAggregationMeasInfo
type: object
properties:
cellIdNei:
type: string
description: String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3].
cellIdSrv:
type: string
description: String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3].
rsrpNei:
type: integer
description: Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrpSrv:
type: integer
description: Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrqNei:
type: integer
description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrqSrv:
type: integer
description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
CarrierAggregationMeasInfo1:
title: CarrierAggregationMeasInfo1
type: object
properties:
cellIdNei:
type: string
description: String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3].
cellIdSrv:
type: string
description: String representing the E-UTRAN Cell Identity. Encoded as a bit string (size (28)) as defined in ETSI TS 136 413 [i.3].
rsrpNei:
type: integer
description: Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrpNeiEx:
type: integer
description: Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
rsrpSrv:
type: integer
description: Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrpSrvEx:
type: integer
description: Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
rsrqNei:
type: integer
description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrqNeiEx:
type: integer
description: Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
rsrqSrv:
type: integer
description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrqSrvEx:
type: integer
description: Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
sinrNei:
type: integer
description: Reference Signal "Signal to Interference plus Noise Ratio", with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
sinrSrv:
type: integer
description: Reference Signal "Signal to Interference plus Noise Ratio", with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
CellInfo:
title: CellInfo
type: object
properties:
dl_gbr_pdr_cell:
type: integer
description: It indicates the packet discard rate in percentage of the downlink GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_gbr_prb_usage_cell:
type: integer
description: It indicates the PRB usage for downlink GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].
contentEncoding: int32
dl_nongbr_pdr_cell:
type: integer
description: It indicates the packet discard rate in percentage of the downlink non-GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_nongbr_prb_usage_cell:
type: integer
description: It indicates (in percentage) the PRB usage for downlink non-GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].
contentEncoding: int32
dl_total_prb_usage_cell:
type: integer
description: It indicates (in percentage) the PRB usage for total downlink traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].
contentEncoding: int32
ecgi:
$ref: '#/components/schemas/Ecgi'
number_of_active_ue_dl_gbr_cell:
type: integer
description: It indicates the number of active UEs with downlink GBR traffic, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
number_of_active_ue_dl_nongbr_cell:
type: integer
description: It indicates the number of active UEs with downlink non-GBR traffic, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
number_of_active_ue_ul_gbr_cell:
type: integer
description: It indicates the number of active UEs with uplink GBR traffic, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
number_of_active_ue_ul_nongbr_cell:
type: integer
description: It indicates the number of active UEs with uplink non-GBR traffic, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
received_dedicated_preambles_cell:
type: integer
description: It indicates (in percentage) the received dedicated preamples, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
received_randomly_selected_preambles_high_range_cell:
type: integer
description: It indicates (in percentage) the received randomly selected preambles in the high range, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
received_randomly_selected_preambles_low_range_cell:
type: integer
description: It indicates (in percentage) the received randomly selected preambles in the low range, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_gbr_pdr_cell:
type: integer
description: It indicates the packet discard rate in percentage of the uplink GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_gbr_prb_usage_cell:
type: integer
description: It indicates (in percentage) the PRB usage for uplink GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].
contentEncoding: int32
ul_nongbr_pdr_cell:
type: integer
description: It indicates the packet discard rate in percentage of the uplink non-GBR traffic in a cell, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_nongbr_prb_usage_cell:
type: integer
description: It indicates (in percentage) the PRB usage for uplink non-GBR traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].
contentEncoding: int32
ul_total_prb_usage_cell:
type: integer
description: It indicates (in percentage) the PRB usage for total uplink traffic, as defined in ETSI TS 136 314 [i.11] and ETSI TS 136 423 [i.12].
contentEncoding: int32
CellUEInfo:
title: CellUEInfo
type: object
properties:
associateId:
$ref: '#/components/schemas/AssociateId'
dl_gbr_data_volume_ue:
type: integer
description: It indicates the data volume of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_gbr_delay_ue:
type: integer
description: It indicates the packet delay of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_gbr_pdr_ue:
type: integer
description: It indicates the packet discard rate in percentage of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_gbr_throughput_ue:
type: integer
description: It indicates the scheduled throughput of the downlink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_nongbr_data_volume_ue:
type: integer
description: It indicates the data volume of the downlink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_nongbr_delay_ue:
type: integer
description: It indicates the packet delay of the downlink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_nongbr_pdr_ue:
type: integer
description: It indicates the packet discard rate in percentage of the downlink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
dl_nongbr_throughput_ue:
type: integer
description: It indicates the scheduled throughput of the downlink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ecgi:
$ref: '#/components/schemas/Ecgi'
ul_gbr_data_volume_ue:
type: integer
description: It indicates the data volume of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_gbr_delay_ue:
type: integer
description: It indicates the packet delay of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_gbr_pdr_ue:
type: integer
description: It indicates the packet discard rate in percentage of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_gbr_throughput_ue:
type: integer
description: It indicates the scheduled throughput of the uplink GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_nongbr_data_volume_ue:
type: integer
description: It indicates the data volume of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_nongbr_delay_ue:
type: integer
description: It indicates the packet delay of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_nongbr_pdr_ue:
type: integer
description: It indicates the packet discard rate in percentage of the uplink nonGBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
ul_nongbr_throughput_ue:
type: integer
description: It indicates the scheduled throughput of the uplink non-GBR traffic of a UE, as defined in ETSI TS 136 314 [i.11].
contentEncoding: int32
CellUserInfo:
title: CellUserInfo
type: object
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
ueInfo:
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
type: array
items:
$ref: '#/components/schemas/UeInfo'
description: Information on UEs in the specific cell as defined below.
EnbInfo:
title: EnbInfo
required:
- ipAddress
- tunnelId
type: object
properties:
ipAddress:
type: string
description: eNB transport layer address of this S1 bearer.
tunnelId:
type: string
description: eNB GTP-U TEID of this S1 bearer.
description: S1 bearer information on eNB side as defined below.
ErabInfo:
title: ErabInfo
type: object
properties:
erabId:
type: integer
description: The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].
contentEncoding: int32
erabQosParameters:
$ref: '#/components/schemas/ErabQosParameters'
ErabQosParameters:
title: ErabQosParameters
required:
- qci
type: object
properties:
qci:
type: integer
description: QoS Class Identifier as defined in ETSI TS 123 401 [i.4].
contentEncoding: int32
qosInformation:
$ref: '#/components/schemas/QosInformation'
description: QoS parameters for the E-RAB as defined below.
ErabQosParameters2:
title: ErabQosParameters2
required:
- qci
type: object
properties:
qci:
type: integer
description: QoS Class Identifier as defined in ETSI TS 123 401 [i.4].
contentEncoding: int32
qosInformation:
$ref: '#/components/schemas/QosInformation2'
description: The QoS parameters for the E-RAB as defined below.
ErabReleaseInfo:
title: ErabReleaseInfo
required:
- erabId
type: object
properties:
erabId:
type: integer
description: The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].
contentEncoding: int32
description: The release information for the E-RAB as defined below.
EutraNeighCellMeasInfo:
title: EutraNeighCellMeasInfo
type: object
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
rsrp:
type: integer
description: Reference Signal Received Power as defined in ETSI TS 138 331 [i.13].
contentEncoding: int32
rsrq:
type: integer
description: Reference Signal Received Quality as defined in ETSI TS 138 331 [i.13].
contentEncoding: int32
sinr:
type: integer
description: Reference Signal plus Interference Noise Ratio as defined in ETSI TS 138 331 [i.13].
contentEncoding: int32
EutranNeighbourCellMeasInfo:
title: EutranNeighbourCellMeasInfo
type: object
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
rsrp:
type: integer
description: Reference Signal Received Power as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrpEx:
type: integer
description: Extended Reference Signal Received Power, with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
rsrq:
type: integer
description: Reference Signal Received Quality as defined in ETSI TS 136 214 [i.5].
contentEncoding: int32
rsrqEx:
type: integer
description: Extended Reference Signal Received Quality, with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
sinr:
type: integer
description: Reference Signal "Signal to Interference plus Noise Ratio", with value mapping defined in ETSI TS 136 133 [i.16].
contentEncoding: int32
FilterCriteriaAssoc:
title: FilterCriteriaAssoc
type: object
properties:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
FilterCriteriaAssocHo:
title: FilterCriteriaAssocHo
type: object
properties:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
hoStatus:
type: array
items:
type: integer
contentEncoding: int32
description: 'In case hoStatus is not included in the subscription request, the default value 3 = COMPLETED shall be used and included in the response: <p>1 = IN_PREPARATION. <p>2 = IN_EXECUTION. <p>3 = COMPLETED. <p>4 = REJECTED. <p>5 = CANCELLED.'
description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
FilterCriteriaAssocTri:
title: FilterCriteriaAssocTri
type: object
properties:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
trigger:
type: array
items:
$ref: '#/components/schemas/Trigger'
description: Corresponds to a specific E-UTRAN UE Measurement Report trigger.
description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
FilterCriteriaNrMrs:
title: FilterCriteriaNrMrs
type: object
properties:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
nrcgi:
type: array
items:
$ref: '#/components/schemas/NRcgi'
description: NR Cell Global Identier.
triggerNr:
type: array
items:
$ref: '#/components/schemas/TriggerNr'
description: Corresponds to a specific 5G UE Measurement Report trigger.
description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
FilterCriteriaQci:
title: FilterCriteriaQci
required:
- qci
type: object
properties:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
qci:
type: integer
description: QoS Class Identifier as defined in ETSI TS 123 401 [i.4].
contentEncoding: int32
description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
FilterCriteriaQci1:
title: FilterCriteriaQci1
required:
- erabId
- qci
type: object
properties:
appInstanceId:
type: string
description: Unique identifier for the MEC application instance.
ecgi:
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
erabId:
type: integer
description: The attribute that uniquely identifies a Radio Access bearer for specific UE as defined in ETSI TS 136 413 [i.3].
contentEncoding: int32
qci:
type: integer
description: QoS Class Identifier as defined in ETSI TS 123 401 [i.4].
contentEncoding: int32
description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
HoStatus:
title: HoStatus
enum:
- 1
- 2
- 3
- 4
- 5
type: integer
description: 'Indicate the status of the UE handover procedure. Values are defined as following: <p>1 = IN_PREPARATION. <p>2 = IN_EXECUTION. <p>3 = COMPLETED. <p>4 = REJECTED. <p>5 = CANCELLED.'
examples:
- 1
InlineNotification:
title: InlineNotification
required:
- notificationType
type: object
properties:
notificationType:
type: string
discriminator:
propertyName: notificationType
mapping:
CaReconfNotification: CaReconfNotification
CellChangeNotification: CellChangeNotification
MeasRepUeNotification: MeasRepUeNotification
MeasTaNotification: MeasTaNotification
NrMeasRepUeNotification: NrMeasRepUeNotification
RabEstNotification: RabEstNotification
RabModNotification: RabModNotification
RabRelNotification: RabRelNotification
S1BearerNotification: S1BearerNotification
InlineSubscription:
title: InlineSubscription
required:
- subscriptionType
type: object
properties:
subscriptionType:
type: string
discriminator:
propertyName: subscriptionType
mapping:
CaReconfSubscription: CaReconfSubscription
CellChangeSubscription: CellChangeSubscription
MeasRepUeSubscription: MeasRepUeSubscription
MeasTaSubscription: MeasTaSubscription
NrMeasRepUeSubscription: NrMeasRepUeSubscription
RabEstSubscription: RabEstSubscription
RabModSubscription: RabModSubscription
RabRelSubscription: RabRelSubscription
S1BearerSubscription: S1BearerSubscription
Links:
title: Links
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
Links2:
title: Links2
required:
- self
type: object
properties:
self:
type: string
description: Self referring URI. This shall be included in the response from the RNIS. The URI shall be unique within the RNI API as it acts as an ID for the subscription.
description: List of hyperlinks related to the resource.
Links10:
title: Links10
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
subscription:
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
type: array
items:
$ref: '#/components/schemas/Subscription'
description: A link to a subscription.
description: List of hyperlinks related to the resource.
NCell:
title: NCell
type: object
properties:
measQuantityResultsCsiRsCell:
$ref: '#/components/schemas/MeasQuantityResultsNr'
measQuantityResultsSsbCell:
$ref: '#/components/schemas/MeasQuantityResultsNr'
rsIndexResults:
$ref: '#/components/schemas/RsIndexResults'
description: Measurement information relating to the best neighbour of this serving cell.
NewRadioMeasInfo:
title: NewRadioMeasInfo
type: object
properties:
nrBNCs:
$ref: '#/components/schemas/NrBNCs'
nrCarrierFreq:
type: integer
description: ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR carrier frequency, as defined in ETSI TS 138.101 [i.15].
contentEncoding: int32
nrSCs:
$ref: '#/components/schemas/NrSCs'
NewRadioMeasNeiInfo:
title: NewRadioMeasNeiInfo
type: object
properties:
nrNCellInfo:
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
type: array
items:
$ref: '#/components/schemas/NrNCellInfo'
description: 5G NR neighbour cell info.
nrNCellRsrp:
type: integer
description: Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
nrNCellRsrq:
type: integer
description: Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
nrNCellRssi:
type: integer
description: Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
rsIndexResults:
$ref: '#/components/schemas/RsIndexResults'
NrBNCellInfo:
title: NrBNCellInfo
type: object
properties:
nrBNCellGId:
type: string
description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
nrBNCellPlmn:
type: array
items:
$ref: '#/components/schemas/Plmn'
description: Public land mobile network identities
NrBNCs:
title: NrBNCs
required:
- nrBNCellInfo
type: object
properties:
nrBNCellInfo:
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
type: array
items:
$ref: '#/components/schemas/NrBNCellInfo'
description: Best neighbours of the secondary serving cell(s) info
nrBNCellRsrp:
type: integer
description: Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
nrBNCellRsrq:
type: integer
description: Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
nrBNCellRssi:
type: integer
description: Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
description: Measurement quantities concerning the best neighbours of the secondary serving cells
NrNCellInfo:
title: NrNCellInfo
type: object
properties:
nrNCellGId:
type: string
description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
nrNCellPlmn:
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
type: array
items:
$ref: '#/components/schemas/Plmn'
description: Public land mobile network identities.
NrNeighCellMeasInfo:
title: NrNeighCellMeasInfo
type: object
properties:
measQuantityResultsCsiRsCell:
$ref: '#/components/schemas/MeasQuantityResultsNr'
measQuantityResultsSsbCell:
$ref: '#/components/schemas/MeasQuantityResultsNr'
nrcgi:
type: string
description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
rsIndexResults:
$ref: '#/components/schemas/RsIndexResults'
NrSCellInfo:
title: NrSCellInfo
type: object
properties:
nrSCellGId:
type: string
description: String representing the NR Cell Identity. Encoded as a bit string (size (36)) as defined in ETSI TS 138 423 [i.17].
nrSCellPlmn:
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
type: array
items:
$ref: '#/components/schemas/Plmn'
description: Public land mobile network identities.
NrSCs:
title: NrSCs
required:
- nrSCellInfo
type: object
properties:
nrSCellInfo:
type: array
items:
$ref: '#/components/schemas/NrSCellInfo'
description: Secondary serving cell(s) info.
nrSCellRsrp:
type: integer
description: Reference Signal Received Power measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
nrSCellRsrq:
type: integer
description: Reference Signal Received Quality measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
nrSCellRssi:
type: integer
description: Reference signal SINR measurement according to mapping table in ETSI TS 138.133 [i.14].
contentEncoding: int32
description: Measurement quantities concerning the secondary serving cells.
QosInformation:
title: QosInformation
required:
- erabGbrDl
- erabGbrUl
- erabMbrDl
- erabMbrUl
type: object
properties:
erabGbrDl:
type: integer
description: This attribute indicates the guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
contentEncoding: int32
erabGbrUl:
type: integer
description: This attribute indicates the guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
contentEncoding: int32
erabMbrDl:
type: integer
description: This attribute indicates the maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
contentEncoding: int32
erabMbrUl:
type: integer
description: This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
contentEncoding: int32
description: The QoS information for the E-RAB.
QosInformation2:
title: QosInformation2
required:
- erabGbrDl
- erabGbrUl
- erabMbrDl
- erabMbrUl
type: object
properties:
erabGbrDl:
type: integer
description: This attribute indicates the guaranteed downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
contentEncoding: int32
erabGbrUl:
type: integer
description: This attribute indicates the guaranteed uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
contentEncoding: int32
erabMbrDl:
type: integer
description: This attribute indicates the maximum downlink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
contentEncoding: int32
erabMbrUl:
type: integer
description: This attribute indicates the maximum uplink E-RAB Bit Rate as defined in ETSI TS 123 401 [i.4] for this bearer.
contentEncoding: int32
description: The QoS Information for the E-RAB as defined below.
S1BearerInfoDetailed:
title: S1BearerInfoDetailed
type: object
required:
- erabId
- erabInfo
- sGwInfo
properties:
enbInfo:
$ref: '#/components/schemas/EnbInfo'
erabId:
type: integer
description: The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].
contentEncoding: int32
sGwInfo:
$ref: '#/components/schemas/SGwInfo'
S1BearerSubscriptionCriteria:
title: S1BearerSubscriptionCriteria
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the events for a specific UE or a flow.
ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
erabId:
type: array
items:
type: integer
contentEncoding: int32
description: The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].
description: As defined below.
S1UeInfo:
title: S1UeInfo
type: object
required:
- associateId
- ecgi
- s1BearerInfoDetailed
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 1 to N identifiers to associate the information for a specific UE or flow.
ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
s1BearerInfoDetailed:
type: array
items:
$ref: '#/components/schemas/S1BearerInfoDetailed'
description: S1 bearer information as defined below.
tempUeId:
$ref: '#/components/schemas/TempUeId'
S1UeInfo1:
title: S1UeInfo1
required:
- ecgi
- s1BearerInfo
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the information for a specific UE or flow.
ecgi:
type: array
items:
$ref: '#/components/schemas/Ecgi'
description: E-UTRAN Cell Global Identifier.
s1BearerInfo:
type: array
items:
$ref: '#/components/schemas/S1BearerInfo1'
description: S1 bearer information as defined below.
tempUeId:
$ref: '#/components/schemas/TempUeId'
description: Information on specific UE that matches the criteria in S1BearerSubscription as defined below.
S1BearerInfo1:
title: S1BearerInfo1
type: object
required:
- enbInfo
- erabId
- sGwInfo
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
properties:
enbInfo:
$ref: '#/components/schemas/EnbInfo'
erabId:
type: integer
description: The attribute that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413 [i.3].
contentEncoding: int32
sGwInfo:
$ref: '#/components/schemas/SGwInfo'
SCell:
title: SCell
type: object
properties:
measQuantityResultsCsiRsCell:
$ref: '#/components/schemas/MeasQuantityResultsNr'
measQuantityResultsSsbCell:
$ref: '#/components/schemas/MeasQuantityResultsNr'
rsIndexResults:
$ref: '#/components/schemas/RsIndexResults'
description: Measurement information relating to this serving cell.
SecondaryCellAdd:
title: SecondaryCellAdd
type: object
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
SecondaryCellRemove:
title: SecondaryCellRemove
type: object
properties:
ecgi:
$ref: '#/components/schemas/Ecgi'
ServCellMeasInfo:
title: ServCellMeasInfo
type: object
properties:
nCell:
$ref: '#/components/schemas/NCell'
nrcgi:
$ref: '#/components/schemas/NRcgi'
sCell:
$ref: '#/components/schemas/SCell'
SGwInfo:
title: SGwInfo
required:
- ipAddress
- tunnelId
type: object
properties:
ipAddress:
type: string
description: SGW transport layer address of this S1 bearer.
tunnelId:
type: string
description: SGW GTP-U TEID of this S1 bearer.
description: S1 bearer information on GW side as defined below.
Subscription:
title: Subscription
type: object
properties:
href:
type: string
description: The URI referring to the subscription.
subscriptionType:
type: string
description: Type of the subscription. The string shall be set according to the "subscriptionType" attribute of the associated subscription data type event defined in clause 6.3.
TempUeId:
title: TempUeId
required:
- mmec
- mtmsi
type: object
properties:
mmec:
type: string
description: MMEC as defined in ETSI TS 136 413 [i.3].
mtmsi:
type: string
description: M-TMSI as defined in ETSI TS 136 413 [i.3].
description: The temporary identifier allocated for the specific UE as defined below.
Type:
title: Type
enum:
- 0
- 1
- 2
- 3
- 4
type: integer
description: 'Numeric value (0-255) corresponding to specified type of identifier as following: <p>0 = reserved. <p>1 = UE_IPv4_ADDRESS. <p>2 = UE_IPV6_ADDRESS. <p>3 = NATED_IP_ADDRESS. <p>4 = GTP_TEID.'
examples:
- 0
UeInfo:
title: UeInfo
type: object
properties:
associateId:
type: array
items:
$ref: '#/components/schemas/AssociateId'
description: 0 to N identifiers to associate the event for a specific UE or flow.
erabInfo:
type: array
items:
$ref: '#/components/schemas/ErabInfo'
description: Information on E-RAB as defined below.
security:
- {}