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
342 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
343 state, 404 - resource not found, 500 - RNIB error, 501 - internal
344 problem, 502 - RMR error, 503 - Routing Manager Unavailable
347 description: Human readable text
348 RedButtonPartialSuccessResponseModel:
355 description: Partial success reason
372 ranFunctionDefinition:
404 dlTransmissionBandwidth:
410 ulTransmissionBandwidth:
416 additionalProperties: false
420 additionalSpecialSubframeExtensionInfo:
422 additionalSpecialSubframePatternsExtension:
434 additionalProperties: false
436 additionalSpecialSubframeInfo:
438 additionalSpecialSubframePatterns:
450 additionalProperties: false
464 specialSubframePatterns:
468 additionalProperties: false
474 transmissionBandwidth:
478 additionalProperties: false
480 additionalProperties: false
488 freqBandIndicatorPriority:
492 mbmsServiceAreaIdentities:
499 radioframeAllocationOffset:
501 radioframeAllocationPeriod:
507 subframeAllocationType:
511 additionalProperties: false
529 additionalProperties: false
532 numberOfAntennaPorts:
542 prachConfigurationIndex:
544 prachFrequencyOffset:
548 zeroCorrelationZoneConfiguration:
553 additionalCellInformation:
554 $ref: '#/components/schemas/AdditionalCellInformation'
565 $ref: '#/components/schemas/ServedNrCells'
568 $ref: '#/components/schemas/RanFunction'
574 - servedNrCellInformation
599 additionalProperties: false
610 sulTransmissionBandwidth:
620 additionalProperties: false
622 additionalProperties: false
624 additionalProperties: false
637 additionalProperties: false
648 sulTransmissionBandwidth:
658 additionalProperties: false
660 additionalProperties: false
662 additionalProperties: false
664 additionalProperties: false
679 additionalProperties: false
690 sulTransmissionBandwidth:
700 additionalProperties: false
702 additionalProperties: false
704 additionalProperties: false
706 additionalProperties: false
708 additionalProperties: false
722 additionalProperties: false
725 servedNrCellInformation:
750 additionalProperties: false
761 sulTransmissionBandwidth:
771 additionalProperties: false
773 additionalProperties: false
775 additionalProperties: false
777 dlTransmissionBandwidth:
787 additionalProperties: false
800 additionalProperties: false
811 sulTransmissionBandwidth:
821 additionalProperties: false
823 additionalProperties: false
825 additionalProperties: false
827 ulTransmissionBandwidth:
837 additionalProperties: false
839 additionalProperties: false
854 additionalProperties: false
865 sulTransmissionBandwidth:
875 additionalProperties: false
877 additionalProperties: false
879 additionalProperties: false
881 transmissionBandwidth:
891 additionalProperties: false
893 additionalProperties: false
895 additionalProperties: false
911 additionalCellInformation:
912 $ref: '#/components/schemas/AdditionalCellInformation'
913 additionalProperties: false
915 additionalProperties: false
920 criticalityDiagnostics:
922 informationElementCriticalityDiagnostics:
935 additionalProperties: false
940 procedureCriticality:
948 additionalProperties: false
970 additionalProperties: false
992 $ref: '#/components/schemas/Enb'
993 additionalProperties: false
994 AdditionalCellInformation:
1002 antennaAzimuthDirection:
1020 $ref: '#/components/schemas/Enb'
1033 $ref: '#/components/schemas/Gnb'
1045 $ref: '#/components/schemas/SetupFailure'
1048 additionalProperties: false