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'
50 '/nodeb/enb/{ranName}':
55 operationId: DeleteEnb
60 description: Name of RAN to delete
65 description: Successful operation
69 $ref: '#/components/schemas/NodebResponse'
71 description: The specified RAN is not ENB
75 $ref: '#/components/schemas/ErrorResponse'
77 description: A RAN with the specified name was not found
79 application/problem+json:
81 $ref: '#/components/schemas/ErrorResponse'
83 description: Internal Error
85 application/problem+json:
87 $ref: '#/components/schemas/ErrorResponse'
92 operationId: UpdateEnb
97 description: Name of ENB ran to update
104 $ref: '#/components/schemas/UpdateEnbRequest'
108 description: Successful operation
112 $ref: '#/components/schemas/NodebResponse'
114 description: Invalid input
116 application/problem+json:
118 $ref: '#/components/schemas/ErrorResponse'
120 description: Internal error
122 application/problem+json:
124 $ref: '#/components/schemas/ErrorResponse'
125 '/nodeb/{ranName}/update':
130 operationId: UpdateGnb
135 description: Name of GNB RAN to update
142 $ref: '#/components/schemas/UpdateGnbRequest'
146 description: Successful operation
150 $ref: '#/components/schemas/NodebResponse'
152 description: Invalid input
154 application/problem+json:
156 $ref: '#/components/schemas/ErrorResponse'
158 description: Internal error
160 application/problem+json:
162 $ref: '#/components/schemas/ErrorResponse'
167 summary: Close all connections to the RANs
170 description: 'Operation succeeded internally, outbound calls failed'
174 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
176 description: Successful operation
178 description: Internal Error
180 application/problem+json:
182 $ref: '#/components/schemas/ErrorResponse'
187 summary: Get RANs identities list
188 operationId: getNodebIdList
191 description: Successful operation
197 $ref: '#/components/schemas/NodebIdentity'
199 description: Internal Error
201 application/problem+json:
203 $ref: '#/components/schemas/ErrorResponse'
206 summary: Update e2mgr configuration
209 operationId: SetConfiguration
214 $ref: '#/components/schemas/SetConfiguration'
218 description: Successful operation
222 $ref: '#/components/schemas/SetConfiguration'
224 description: Invalid input
226 application/problem+json:
228 $ref: '#/components/schemas/ErrorResponse'
230 description: Internal error
232 application/problem+json:
234 $ref: '#/components/schemas/ErrorResponse'
239 summary: E2 Manager Service Health Check
247 summary: Gets a list of all E2T Instances address and their associated RANs
250 description: Successful operation
256 $ref: '#/components/schemas/E2tIdentity'
258 description: Internal Error
260 application/problem+json:
262 $ref: '#/components/schemas/ErrorResponse'
273 $ref: '#/components/schemas/AddEnbRequest'
277 description: Successful operation
281 $ref: '#/components/schemas/NodebResponse'
283 description: Invalid input
285 application/problem+json:
287 $ref: '#/components/schemas/ErrorResponse'
289 description: Internal error
291 application/problem+json:
293 $ref: '#/components/schemas/ErrorResponse'
302 $ref: '#/components/schemas/ServedNrCells'
303 additionalProperties: false
310 $ref: '#/components/schemas/Enb'
311 additionalProperties: false
319 additionalProperties: false
341 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
342 state, 404 - resource not found, 500 - RNIB error, 501 - internal
343 problem, 502 - RMR error, 503 - Routing Manager Unavailable
346 description: Human readable text
347 RedButtonPartialSuccessResponseModel:
354 description: Partial success reason
371 ranFunctionDefinition:
403 dlTransmissionBandwidth:
409 ulTransmissionBandwidth:
415 additionalProperties: false
419 additionalSpecialSubframeExtensionInfo:
421 additionalSpecialSubframePatternsExtension:
433 additionalProperties: false
435 additionalSpecialSubframeInfo:
437 additionalSpecialSubframePatterns:
449 additionalProperties: false
463 specialSubframePatterns:
467 additionalProperties: false
473 transmissionBandwidth:
477 additionalProperties: false
479 additionalProperties: false
487 freqBandIndicatorPriority:
491 mbmsServiceAreaIdentities:
498 radioframeAllocationOffset:
500 radioframeAllocationPeriod:
506 subframeAllocationType:
510 additionalProperties: false
528 additionalProperties: false
531 numberOfAntennaPorts:
541 prachConfigurationIndex:
543 prachFrequencyOffset:
547 zeroCorrelationZoneConfiguration:
552 additionalCellInformation:
553 $ref: '#/components/schemas/AdditionalCellInformation'
560 $ref: '#/components/schemas/ServedNrCells'
563 $ref: '#/components/schemas/RanFunction'
569 - servedNrCellInformation
594 additionalProperties: false
605 sulTransmissionBandwidth:
615 additionalProperties: false
617 additionalProperties: false
619 additionalProperties: false
632 additionalProperties: false
643 sulTransmissionBandwidth:
653 additionalProperties: false
655 additionalProperties: false
657 additionalProperties: false
659 additionalProperties: false
674 additionalProperties: false
685 sulTransmissionBandwidth:
695 additionalProperties: false
697 additionalProperties: false
699 additionalProperties: false
701 additionalProperties: false
703 additionalProperties: false
717 additionalProperties: false
720 servedNrCellInformation:
745 additionalProperties: false
756 sulTransmissionBandwidth:
766 additionalProperties: false
768 additionalProperties: false
770 additionalProperties: false
772 dlTransmissionBandwidth:
782 additionalProperties: false
795 additionalProperties: false
806 sulTransmissionBandwidth:
816 additionalProperties: false
818 additionalProperties: false
820 additionalProperties: false
822 ulTransmissionBandwidth:
832 additionalProperties: false
834 additionalProperties: false
849 additionalProperties: false
860 sulTransmissionBandwidth:
870 additionalProperties: false
872 additionalProperties: false
874 additionalProperties: false
876 transmissionBandwidth:
886 additionalProperties: false
888 additionalProperties: false
890 additionalProperties: false
906 additionalCellInformation:
907 $ref: '#/components/schemas/AdditionalCellInformation'
908 additionalProperties: false
910 additionalProperties: false
915 criticalityDiagnostics:
917 informationElementCriticalityDiagnostics:
930 additionalProperties: false
935 procedureCriticality:
943 additionalProperties: false
965 additionalProperties: false
987 $ref: '#/components/schemas/Enb'
988 additionalProperties: false
989 AdditionalCellInformation:
997 antennaAzimuthDirection:
1015 $ref: '#/components/schemas/Enb'
1028 $ref: '#/components/schemas/Gnb'
1040 $ref: '#/components/schemas/SetupFailure'
1041 additionalProperties: false