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/NodebResponse'
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'
60 $ref: '#/components/schemas/AddEnbRequest'
64 description: Successful operation
68 $ref: '#/components/schemas/NodebResponse'
70 description: Invalid input
72 application/problem+json:
74 $ref: '#/components/schemas/ErrorResponse'
76 description: Internal error
78 application/problem+json:
80 $ref: '#/components/schemas/ErrorResponse'
82 '/nodeb/enb/{ranName}':
87 operationId: DeleteEnb
92 description: Name of RAN to delete
97 description: Successful operation
101 $ref: '#/components/schemas/NodebResponse'
103 description: The specified RAN is not ENB
107 $ref: '#/components/schemas/ErrorResponse'
109 description: A RAN with the specified name was not found
111 application/problem+json:
113 $ref: '#/components/schemas/ErrorResponse'
115 description: Internal Error
117 application/problem+json:
119 $ref: '#/components/schemas/ErrorResponse'
124 operationId: UpdateEnb
129 description: Name of ENB ran to update
136 $ref: '#/components/schemas/UpdateEnbRequest'
140 description: Successful operation
144 $ref: '#/components/schemas/NodebResponse'
146 description: Invalid input
148 application/problem+json:
150 $ref: '#/components/schemas/ErrorResponse'
152 description: Internal error
154 application/problem+json:
156 $ref: '#/components/schemas/ErrorResponse'
157 '/nodeb/gnb/{ranName}':
159 summary: Update gNB Cells
162 operationId: UpdateGnb
167 description: Name of GNB RAN to update
174 $ref: '#/components/schemas/UpdateGnbRequest'
178 description: Successful operation
182 $ref: '#/components/schemas/NodebResponse'
184 description: Invalid input
186 application/problem+json:
188 $ref: '#/components/schemas/ErrorResponse'
190 description: Internal error
192 application/problem+json:
194 $ref: '#/components/schemas/ErrorResponse'
199 summary: Close all connections to the RANs
202 description: 'Operation succeeded internally, outbound calls failed'
206 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
208 description: Successful operation
210 description: Internal Error
212 application/problem+json:
214 $ref: '#/components/schemas/ErrorResponse'
219 summary: Get RANs identities list
220 operationId: getNodebIdList
223 description: Successful operation
229 $ref: '#/components/schemas/NodebIdentity'
231 description: Internal Error
233 application/problem+json:
235 $ref: '#/components/schemas/ErrorResponse'
238 summary: Update e2mgr configuration
241 operationId: SetConfiguration
246 $ref: '#/components/schemas/SetConfiguration'
250 description: Successful operation
254 $ref: '#/components/schemas/SetConfiguration'
256 description: Invalid input
258 application/problem+json:
260 $ref: '#/components/schemas/ErrorResponse'
262 description: Internal error
264 application/problem+json:
266 $ref: '#/components/schemas/ErrorResponse'
271 summary: E2 Manager Service Health Check
279 summary: Gets a list of all E2T Instances address and their associated RANs
282 description: Successful operation
288 $ref: '#/components/schemas/E2tIdentity'
290 description: Internal Error
292 application/problem+json:
294 $ref: '#/components/schemas/ErrorResponse'
303 $ref: '#/components/schemas/ServedNrCells'
304 additionalProperties: false
311 $ref: '#/components/schemas/Enb'
312 additionalProperties: false
320 additionalProperties: false
344 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
345 state, 404 - resource not found, 500 - RNIB error, 501 - internal
346 problem, 502 - RMR error, 503 - Routing Manager Unavailable
349 description: Human readable text
350 RedButtonPartialSuccessResponseModel:
357 description: Partial success reason
374 ranFunctionDefinition:
406 dlTransmissionBandwidth:
412 ulTransmissionBandwidth:
418 additionalProperties: false
422 additionalSpecialSubframeExtensionInfo:
424 additionalSpecialSubframePatternsExtension:
436 additionalProperties: false
438 additionalSpecialSubframeInfo:
440 additionalSpecialSubframePatterns:
452 additionalProperties: false
466 specialSubframePatterns:
470 additionalProperties: false
476 transmissionBandwidth:
480 additionalProperties: false
482 additionalProperties: false
490 freqBandIndicatorPriority:
494 mbmsServiceAreaIdentities:
501 radioframeAllocationOffset:
503 radioframeAllocationPeriod:
509 subframeAllocationType:
513 additionalProperties: false
531 additionalProperties: false
534 numberOfAntennaPorts:
544 prachConfigurationIndex:
546 prachFrequencyOffset:
550 zeroCorrelationZoneConfiguration:
555 additionalCellInformation:
556 $ref: '#/components/schemas/AdditionalCellInformation'
567 $ref: '#/components/schemas/ServedNrCells'
570 $ref: '#/components/schemas/RanFunction'
576 - servedNrCellInformation
601 additionalProperties: false
612 sulTransmissionBandwidth:
622 additionalProperties: false
624 additionalProperties: false
626 additionalProperties: false
639 additionalProperties: false
650 sulTransmissionBandwidth:
660 additionalProperties: false
662 additionalProperties: false
664 additionalProperties: false
666 additionalProperties: false
681 additionalProperties: false
692 sulTransmissionBandwidth:
702 additionalProperties: false
704 additionalProperties: false
706 additionalProperties: false
708 additionalProperties: false
710 additionalProperties: false
724 additionalProperties: false
727 servedNrCellInformation:
752 additionalProperties: false
763 sulTransmissionBandwidth:
773 additionalProperties: false
775 additionalProperties: false
777 additionalProperties: false
779 dlTransmissionBandwidth:
789 additionalProperties: false
802 additionalProperties: false
813 sulTransmissionBandwidth:
823 additionalProperties: false
825 additionalProperties: false
827 additionalProperties: false
829 ulTransmissionBandwidth:
839 additionalProperties: false
841 additionalProperties: false
856 additionalProperties: false
867 sulTransmissionBandwidth:
877 additionalProperties: false
879 additionalProperties: false
881 additionalProperties: false
883 transmissionBandwidth:
893 additionalProperties: false
895 additionalProperties: false
897 additionalProperties: false
913 additionalCellInformation:
914 $ref: '#/components/schemas/AdditionalCellInformation'
915 additionalProperties: false
917 additionalProperties: false
922 criticalityDiagnostics:
924 informationElementCriticalityDiagnostics:
937 additionalProperties: false
942 procedureCriticality:
950 additionalProperties: false
972 additionalProperties: false
994 $ref: '#/components/schemas/Enb'
995 additionalProperties: false
996 AdditionalCellInformation:
1004 antennaAzimuthDirection:
1022 $ref: '#/components/schemas/Enb'
1035 $ref: '#/components/schemas/Gnb'
1047 $ref: '#/components/schemas/SetupFailure'
1050 additionalProperties: false