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'
98 $ref: '#/components/schemas/AddEnbRequest'
102 description: Successful operation
106 $ref: '#/components/schemas/AddEnbResponse'
108 description: Invalid input
110 application/problem+json:
112 $ref: '#/components/schemas/ErrorResponse'
114 description: Internal error
116 application/problem+json:
118 $ref: '#/components/schemas/ErrorResponse'
124 summary: Close all connections to the RANs
127 description: 'Operation succeeded internally, outbound calls failed'
131 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
133 description: Successful operation
135 description: Internal Error
137 application/problem+json:
139 $ref: '#/components/schemas/ErrorResponse'
144 summary: Get RANs identities list
145 operationId: getNodebIdList
148 description: Successful operation
154 $ref: '#/components/schemas/NodebIdentity'
156 description: Internal Error
158 application/problem+json:
160 $ref: '#/components/schemas/ErrorResponse'
163 summary: Update e2mgr configuration
166 operationId: SetConfiguration
171 $ref: '#/components/schemas/SetConfiguration'
175 description: Successful operation
179 $ref: '#/components/schemas/SetConfiguration'
181 description: Invalid input
183 application/problem+json:
185 $ref: '#/components/schemas/ErrorResponse'
187 description: Internal error
189 application/problem+json:
191 $ref: '#/components/schemas/ErrorResponse'
196 summary: E2 Manager Service Health Check
204 summary: Gets a list of all E2T Instances address and their associated RANs
207 description: Successful operation
213 $ref: '#/components/schemas/E2tIdentity'
215 description: Internal Error
217 application/problem+json:
219 $ref: '#/components/schemas/ErrorResponse'
242 $ref: '#/components/schemas/Enb'
243 additionalProperties: false
261 additionalProperties: false
264 $ref: '#/components/schemas/Enb'
276 $ref: '#/components/schemas/SetupFailure'
277 additionalProperties: false
286 $ref: '#/components/schemas/ServedNrCells'
287 additionalProperties: false
304 additionalProperties: false
307 $ref: '#/components/schemas/Gnb'
319 $ref: '#/components/schemas/SetupFailure'
320 additionalProperties: false
329 additionalProperties: false
349 $ref: '#/components/schemas/Enb'
362 $ref: '#/components/schemas/Gnb'
374 $ref: '#/components/schemas/SetupFailure'
375 additionalProperties: false
386 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
387 state, 404 - resource not found, 500 - RNIB error, 501 - internal
388 problem, 502 - RMR error, 503 - Routing Manager Unavailable
391 description: Human readable text
392 RedButtonPartialSuccessResponseModel:
399 description: Partial success reason
416 ranFunctionDefinition:
448 dlTransmissionBandwidth:
454 ulTransmissionBandwidth:
460 additionalProperties: false
464 additionalSpecialSubframeExtensionInfo:
466 additionalSpecialSubframePatternsExtension:
478 additionalProperties: false
480 additionalSpecialSubframeInfo:
482 additionalSpecialSubframePatterns:
494 additionalProperties: false
508 specialSubframePatterns:
512 additionalProperties: false
518 transmissionBandwidth:
522 additionalProperties: false
524 additionalProperties: false
532 freqBandIndicatorPriority:
536 mbmsServiceAreaIdentities:
543 radioframeAllocationOffset:
545 radioframeAllocationPeriod:
551 subframeAllocationType:
555 additionalProperties: false
573 additionalProperties: false
576 numberOfAntennaPorts:
586 prachConfigurationIndex:
588 prachFrequencyOffset:
592 zeroCorrelationZoneConfiguration:
597 additionalCellInformation:
598 $ref: '#/components/schemas/AdditionalCellInformation'
605 $ref: '#/components/schemas/ServedNrCells'
608 $ref: '#/components/schemas/RanFunction'
614 - servedNrCellInformation
639 additionalProperties: false
650 sulTransmissionBandwidth:
660 additionalProperties: false
662 additionalProperties: false
664 additionalProperties: false
677 additionalProperties: false
688 sulTransmissionBandwidth:
698 additionalProperties: false
700 additionalProperties: false
702 additionalProperties: false
704 additionalProperties: false
719 additionalProperties: false
730 sulTransmissionBandwidth:
740 additionalProperties: false
742 additionalProperties: false
744 additionalProperties: false
746 additionalProperties: false
748 additionalProperties: false
762 additionalProperties: false
765 servedNrCellInformation:
790 additionalProperties: false
801 sulTransmissionBandwidth:
811 additionalProperties: false
813 additionalProperties: false
815 additionalProperties: false
817 dlTransmissionBandwidth:
827 additionalProperties: false
840 additionalProperties: false
851 sulTransmissionBandwidth:
861 additionalProperties: false
863 additionalProperties: false
865 additionalProperties: false
867 ulTransmissionBandwidth:
877 additionalProperties: false
879 additionalProperties: false
894 additionalProperties: false
905 sulTransmissionBandwidth:
915 additionalProperties: false
917 additionalProperties: false
919 additionalProperties: false
921 transmissionBandwidth:
931 additionalProperties: false
933 additionalProperties: false
935 additionalProperties: false
951 additionalCellInformation:
952 $ref: '#/components/schemas/AdditionalCellInformation'
953 additionalProperties: false
955 additionalProperties: false
960 criticalityDiagnostics:
962 informationElementCriticalityDiagnostics:
975 additionalProperties: false
980 procedureCriticality:
988 additionalProperties: false
1006 transportLayerCause:
1010 additionalProperties: false
1012 AdditionalCellInformation:
1020 antennaAzimuthDirection: