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'
561 $ref: '#/components/schemas/ServedNrCells'
564 $ref: '#/components/schemas/RanFunction'
570 - servedNrCellInformation
595 additionalProperties: false
606 sulTransmissionBandwidth:
616 additionalProperties: false
618 additionalProperties: false
620 additionalProperties: false
633 additionalProperties: false
644 sulTransmissionBandwidth:
654 additionalProperties: false
656 additionalProperties: false
658 additionalProperties: false
660 additionalProperties: false
675 additionalProperties: false
686 sulTransmissionBandwidth:
696 additionalProperties: false
698 additionalProperties: false
700 additionalProperties: false
702 additionalProperties: false
704 additionalProperties: false
718 additionalProperties: false
721 servedNrCellInformation:
746 additionalProperties: false
757 sulTransmissionBandwidth:
767 additionalProperties: false
769 additionalProperties: false
771 additionalProperties: false
773 dlTransmissionBandwidth:
783 additionalProperties: false
796 additionalProperties: false
807 sulTransmissionBandwidth:
817 additionalProperties: false
819 additionalProperties: false
821 additionalProperties: false
823 ulTransmissionBandwidth:
833 additionalProperties: false
835 additionalProperties: false
850 additionalProperties: false
861 sulTransmissionBandwidth:
871 additionalProperties: false
873 additionalProperties: false
875 additionalProperties: false
877 transmissionBandwidth:
887 additionalProperties: false
889 additionalProperties: false
891 additionalProperties: false
907 additionalCellInformation:
908 $ref: '#/components/schemas/AdditionalCellInformation'
909 additionalProperties: false
911 additionalProperties: false
916 criticalityDiagnostics:
918 informationElementCriticalityDiagnostics:
931 additionalProperties: false
936 procedureCriticality:
944 additionalProperties: false
966 additionalProperties: false
988 $ref: '#/components/schemas/Enb'
989 additionalProperties: false
990 AdditionalCellInformation:
998 antennaAzimuthDirection:
1016 $ref: '#/components/schemas/Enb'
1029 $ref: '#/components/schemas/Gnb'
1041 $ref: '#/components/schemas/SetupFailure'
1042 additionalProperties: false