3 title: E2 Manager Service
4 description: E2 Manager Service APIs
7 - url: 'http://{apiRoot}/v1'
10 default: 'localhost:3800'
16 summary: Get RAN by name
22 description: Name of RAN to return
27 description: Successful operation
31 $ref: '#/components/schemas/GetNodebResponse'
33 description: The specified RAN name is invalid
37 $ref: '#/components/schemas/ErrorResponse'
39 description: A RAN with the specified name was not found
41 application/problem+json:
43 $ref: '#/components/schemas/ErrorResponse'
45 description: Internal Error
47 application/problem+json:
49 $ref: '#/components/schemas/ErrorResponse'
50 '/nodeb/{ranName}/update':
55 operationId: UpdateGnb
60 description: Name of GNB RAN to update
67 $ref: '#/components/schemas/UpdateGnbRequest'
71 description: Successful operation
75 $ref: '#/components/schemas/UpdateGnbResponse'
77 description: Invalid input
79 application/problem+json:
81 $ref: '#/components/schemas/ErrorResponse'
83 description: Internal error
85 application/problem+json:
87 $ref: '#/components/schemas/ErrorResponse'
93 summary: Close all connections to the RANs
96 description: 'Operation succeeded internally, outbound calls failed'
100 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
102 description: Successful operation
104 description: Internal Error
106 application/problem+json:
108 $ref: '#/components/schemas/ErrorResponse'
113 summary: Get RANs identities list
114 operationId: getNodebIdList
117 description: Successful operation
123 $ref: '#/components/schemas/NodebIdentity'
125 description: Internal Error
127 application/problem+json:
129 $ref: '#/components/schemas/ErrorResponse'
134 summary: E2 Manager Service Health Check
142 summary: Gets a list of all E2T Instances address and their associated RANs
145 description: Successful operation
151 $ref: '#/components/schemas/E2tIdentity'
153 description: Internal Error
155 application/problem+json:
157 $ref: '#/components/schemas/ErrorResponse'
168 - servedNrCellInformation
193 additionalProperties: false
204 sulTransmissionBandwidth:
214 additionalProperties: false
216 additionalProperties: false
218 additionalProperties: false
231 additionalProperties: false
242 sulTransmissionBandwidth:
252 additionalProperties: false
254 additionalProperties: false
256 additionalProperties: false
258 additionalProperties: false
273 additionalProperties: false
284 sulTransmissionBandwidth:
294 additionalProperties: false
296 additionalProperties: false
298 additionalProperties: false
300 additionalProperties: false
302 additionalProperties: false
316 additionalProperties: false
319 servedNrCellInformation:
344 additionalProperties: false
355 sulTransmissionBandwidth:
365 additionalProperties: false
367 additionalProperties: false
369 additionalProperties: false
371 dlTransmissionBandwidth:
381 additionalProperties: false
394 additionalProperties: false
405 sulTransmissionBandwidth:
415 additionalProperties: false
417 additionalProperties: false
419 additionalProperties: false
421 ulTransmissionBandwidth:
431 additionalProperties: false
433 additionalProperties: false
448 additionalProperties: false
459 sulTransmissionBandwidth:
469 additionalProperties: false
471 additionalProperties: false
473 additionalProperties: false
475 transmissionBandwidth:
485 additionalProperties: false
487 additionalProperties: false
489 additionalProperties: false
505 additionalProperties: false
507 additionalProperties: false
510 additionalProperties: false
527 additionalProperties: false
552 additionalProperties: false
563 sulTransmissionBandwidth:
573 additionalProperties: false
575 additionalProperties: false
577 additionalProperties: false
590 additionalProperties: false
601 sulTransmissionBandwidth:
611 additionalProperties: false
613 additionalProperties: false
615 additionalProperties: false
617 additionalProperties: false
632 additionalProperties: false
643 sulTransmissionBandwidth:
653 additionalProperties: false
655 additionalProperties: false
657 additionalProperties: false
659 additionalProperties: false
661 additionalProperties: false
675 additionalProperties: false
678 servedNrCellInformation:
697 additionalProperties: false
708 sulTransmissionBandwidth:
718 additionalProperties: false
720 additionalProperties: false
722 additionalProperties: false
724 dlTransmissionBandwidth:
734 additionalProperties: false
747 additionalProperties: false
758 sulTransmissionBandwidth:
768 additionalProperties: false
770 additionalProperties: false
772 additionalProperties: false
774 ulTransmissionBandwidth:
784 additionalProperties: false
786 additionalProperties: false
801 additionalProperties: false
812 sulTransmissionBandwidth:
822 additionalProperties: false
824 additionalProperties: false
826 additionalProperties: false
828 transmissionBandwidth:
838 additionalProperties: false
840 additionalProperties: false
842 additionalProperties: false
858 additionalProperties: false
860 additionalProperties: false
868 ranFunctionDefinition:
872 additionalProperties: false
875 additionalProperties: false
889 criticalityDiagnostics:
891 informationElementCriticalityDiagnostics:
904 additionalProperties: false
909 procedureCriticality:
917 additionalProperties: false
939 additionalProperties: false
941 additionalProperties: false
988 dlTransmissionBandwidth:
994 ulTransmissionBandwidth:
1000 additionalProperties: false
1004 additionalSpecialSubframeExtensionInfo:
1006 additionalSpecialSubframePatternsExtension:
1018 additionalProperties: false
1020 additionalSpecialSubframeInfo:
1022 additionalSpecialSubframePatterns:
1034 additionalProperties: false
1038 specialSubframeInfo:
1048 specialSubframePatterns:
1052 additionalProperties: false
1058 transmissionBandwidth:
1062 additionalProperties: false
1064 additionalProperties: false
1072 freqBandIndicatorPriority:
1076 mbmsServiceAreaIdentities:
1083 radioframeAllocationOffset:
1085 radioframeAllocationPeriod:
1091 subframeAllocationType:
1095 additionalProperties: false
1113 additionalProperties: false
1116 numberOfAntennaPorts:
1126 prachConfigurationIndex:
1128 prachFrequencyOffset:
1132 zeroCorrelationZoneConfiguration:
1134 additionalProperties: false
1138 additionalProperties: false
1141 additionalProperties: false
1153 additionalProperties: false
1178 additionalProperties: false
1189 sulTransmissionBandwidth:
1199 additionalProperties: false
1201 additionalProperties: false
1203 additionalProperties: false
1216 additionalProperties: false
1227 sulTransmissionBandwidth:
1237 additionalProperties: false
1239 additionalProperties: false
1241 additionalProperties: false
1243 additionalProperties: false
1258 additionalProperties: false
1269 sulTransmissionBandwidth:
1279 additionalProperties: false
1281 additionalProperties: false
1283 additionalProperties: false
1285 additionalProperties: false
1287 additionalProperties: false
1301 additionalProperties: false
1304 servedNrCellInformation:
1323 additionalProperties: false
1334 sulTransmissionBandwidth:
1344 additionalProperties: false
1346 additionalProperties: false
1348 additionalProperties: false
1350 dlTransmissionBandwidth:
1360 additionalProperties: false
1373 additionalProperties: false
1384 sulTransmissionBandwidth:
1394 additionalProperties: false
1396 additionalProperties: false
1398 additionalProperties: false
1400 ulTransmissionBandwidth:
1410 additionalProperties: false
1412 additionalProperties: false
1427 additionalProperties: false
1438 sulTransmissionBandwidth:
1448 additionalProperties: false
1450 additionalProperties: false
1452 additionalProperties: false
1454 transmissionBandwidth:
1464 additionalProperties: false
1466 additionalProperties: false
1468 additionalProperties: false
1484 additionalProperties: false
1486 additionalProperties: false
1494 ranFunctionDefinition:
1496 ranFunctionRevision:
1498 additionalProperties: false
1501 additionalProperties: false
1515 criticalityDiagnostics:
1517 informationElementCriticalityDiagnostics:
1530 additionalProperties: false
1535 procedureCriticality:
1543 additionalProperties: false
1561 transportLayerCause:
1565 additionalProperties: false
1567 additionalProperties: false
1578 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
1579 state, 404 - resource not found, 500 - RNIB error, 501 - internal
1580 problem, 502 - RMR error, 503 - Routing Manager Unavailable
1583 description: Human readable text
1584 RedButtonPartialSuccessResponseModel:
1591 description: Partial success reason
1612 description: '500 - RNIB error, 501 - internal problem'
1615 description: Human readable text