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/enb/{ranName}':
55 operationId: DeleteEnb
60 description: Name of RAN to delete
65 description: Successful operation
69 $ref: '#/components/schemas/DeleteEnbResponse'
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/UpdateGnbResponse'
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/AddEnbResponse'
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
320 additionalProperties: false
323 $ref: '#/components/schemas/Gnb'
335 $ref: '#/components/schemas/SetupFailure'
336 additionalProperties: false
344 $ref: '#/components/schemas/Enb'
345 additionalProperties: false
353 additionalProperties: false
373 $ref: '#/components/schemas/Enb'
386 $ref: '#/components/schemas/Gnb'
398 $ref: '#/components/schemas/SetupFailure'
399 additionalProperties: false
410 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
411 state, 404 - resource not found, 500 - RNIB error, 501 - internal
412 problem, 502 - RMR error, 503 - Routing Manager Unavailable
415 description: Human readable text
416 RedButtonPartialSuccessResponseModel:
423 description: Partial success reason
440 ranFunctionDefinition:
472 dlTransmissionBandwidth:
478 ulTransmissionBandwidth:
484 additionalProperties: false
488 additionalSpecialSubframeExtensionInfo:
490 additionalSpecialSubframePatternsExtension:
502 additionalProperties: false
504 additionalSpecialSubframeInfo:
506 additionalSpecialSubframePatterns:
518 additionalProperties: false
532 specialSubframePatterns:
536 additionalProperties: false
542 transmissionBandwidth:
546 additionalProperties: false
548 additionalProperties: false
556 freqBandIndicatorPriority:
560 mbmsServiceAreaIdentities:
567 radioframeAllocationOffset:
569 radioframeAllocationPeriod:
575 subframeAllocationType:
579 additionalProperties: false
597 additionalProperties: false
600 numberOfAntennaPorts:
610 prachConfigurationIndex:
612 prachFrequencyOffset:
616 zeroCorrelationZoneConfiguration:
621 additionalCellInformation:
622 $ref: '#/components/schemas/AdditionalCellInformation'
629 $ref: '#/components/schemas/ServedNrCells'
632 $ref: '#/components/schemas/RanFunction'
638 - servedNrCellInformation
663 additionalProperties: false
674 sulTransmissionBandwidth:
684 additionalProperties: false
686 additionalProperties: false
688 additionalProperties: false
701 additionalProperties: false
712 sulTransmissionBandwidth:
722 additionalProperties: false
724 additionalProperties: false
726 additionalProperties: false
728 additionalProperties: false
743 additionalProperties: false
754 sulTransmissionBandwidth:
764 additionalProperties: false
766 additionalProperties: false
768 additionalProperties: false
770 additionalProperties: false
772 additionalProperties: false
786 additionalProperties: false
789 servedNrCellInformation:
814 additionalProperties: false
825 sulTransmissionBandwidth:
835 additionalProperties: false
837 additionalProperties: false
839 additionalProperties: false
841 dlTransmissionBandwidth:
851 additionalProperties: false
864 additionalProperties: false
875 sulTransmissionBandwidth:
885 additionalProperties: false
887 additionalProperties: false
889 additionalProperties: false
891 ulTransmissionBandwidth:
901 additionalProperties: false
903 additionalProperties: false
918 additionalProperties: false
929 sulTransmissionBandwidth:
939 additionalProperties: false
941 additionalProperties: false
943 additionalProperties: false
945 transmissionBandwidth:
955 additionalProperties: false
957 additionalProperties: false
959 additionalProperties: false
975 additionalCellInformation:
976 $ref: '#/components/schemas/AdditionalCellInformation'
977 additionalProperties: false
979 additionalProperties: false
984 criticalityDiagnostics:
986 informationElementCriticalityDiagnostics:
999 additionalProperties: false
1004 procedureCriticality:
1012 additionalProperties: false
1030 transportLayerCause:
1034 additionalProperties: false
1056 $ref: '#/components/schemas/Enb'
1057 additionalProperties: false
1074 additionalProperties: false
1077 $ref: '#/components/schemas/Enb'
1089 $ref: '#/components/schemas/SetupFailure'
1090 additionalProperties: false
1108 additionalProperties: false
1111 $ref: '#/components/schemas/Enb'
1123 $ref: '#/components/schemas/SetupFailure'
1124 additionalProperties: false
1126 AdditionalCellInformation:
1134 antennaAzimuthDirection:
1152 $ref: '#/components/schemas/Enb'
1165 $ref: '#/components/schemas/Gnb'
1177 $ref: '#/components/schemas/SetupFailure'
1178 additionalProperties: false