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'
119 '/nodeb/enb/{ranName}':
124 operationId: DeleteEnb
129 description: Name of RAN to delete
134 description: Successful operation
138 $ref: '#/components/schemas/DeleteEnbResponse'
140 description: The specified RAN is not ENB
144 $ref: '#/components/schemas/ErrorResponse'
146 description: A RAN with the specified name was not found
148 application/problem+json:
150 $ref: '#/components/schemas/ErrorResponse'
152 description: Internal Error
154 application/problem+json:
156 $ref: '#/components/schemas/ErrorResponse'
161 summary: Close all connections to the RANs
164 description: 'Operation succeeded internally, outbound calls failed'
168 $ref: '#/components/schemas/RedButtonPartialSuccessResponseModel'
170 description: Successful operation
172 description: Internal Error
174 application/problem+json:
176 $ref: '#/components/schemas/ErrorResponse'
181 summary: Get RANs identities list
182 operationId: getNodebIdList
185 description: Successful operation
191 $ref: '#/components/schemas/NodebIdentity'
193 description: Internal Error
195 application/problem+json:
197 $ref: '#/components/schemas/ErrorResponse'
200 summary: Update e2mgr configuration
203 operationId: SetConfiguration
208 $ref: '#/components/schemas/SetConfiguration'
212 description: Successful operation
216 $ref: '#/components/schemas/SetConfiguration'
218 description: Invalid input
220 application/problem+json:
222 $ref: '#/components/schemas/ErrorResponse'
224 description: Internal error
226 application/problem+json:
228 $ref: '#/components/schemas/ErrorResponse'
233 summary: E2 Manager Service Health Check
241 summary: Gets a list of all E2T Instances address and their associated RANs
244 description: Successful operation
250 $ref: '#/components/schemas/E2tIdentity'
252 description: Internal Error
254 application/problem+json:
256 $ref: '#/components/schemas/ErrorResponse'
279 $ref: '#/components/schemas/Enb'
280 additionalProperties: false
298 additionalProperties: false
301 $ref: '#/components/schemas/Enb'
313 $ref: '#/components/schemas/SetupFailure'
314 additionalProperties: false
333 additionalProperties: false
336 $ref: '#/components/schemas/Enb'
348 $ref: '#/components/schemas/SetupFailure'
349 additionalProperties: false
358 $ref: '#/components/schemas/ServedNrCells'
359 additionalProperties: false
376 additionalProperties: false
379 $ref: '#/components/schemas/Gnb'
391 $ref: '#/components/schemas/SetupFailure'
392 additionalProperties: false
401 additionalProperties: false
421 $ref: '#/components/schemas/Enb'
434 $ref: '#/components/schemas/Gnb'
446 $ref: '#/components/schemas/SetupFailure'
447 additionalProperties: false
458 401 - corrupted json, 402 - validation error, 403 - RAN in wrong
459 state, 404 - resource not found, 500 - RNIB error, 501 - internal
460 problem, 502 - RMR error, 503 - Routing Manager Unavailable
463 description: Human readable text
464 RedButtonPartialSuccessResponseModel:
471 description: Partial success reason
488 ranFunctionDefinition:
520 dlTransmissionBandwidth:
526 ulTransmissionBandwidth:
532 additionalProperties: false
536 additionalSpecialSubframeExtensionInfo:
538 additionalSpecialSubframePatternsExtension:
550 additionalProperties: false
552 additionalSpecialSubframeInfo:
554 additionalSpecialSubframePatterns:
566 additionalProperties: false
580 specialSubframePatterns:
584 additionalProperties: false
590 transmissionBandwidth:
594 additionalProperties: false
596 additionalProperties: false
604 freqBandIndicatorPriority:
608 mbmsServiceAreaIdentities:
615 radioframeAllocationOffset:
617 radioframeAllocationPeriod:
623 subframeAllocationType:
627 additionalProperties: false
645 additionalProperties: false
648 numberOfAntennaPorts:
658 prachConfigurationIndex:
660 prachFrequencyOffset:
664 zeroCorrelationZoneConfiguration:
669 additionalCellInformation:
670 $ref: '#/components/schemas/AdditionalCellInformation'
677 $ref: '#/components/schemas/ServedNrCells'
680 $ref: '#/components/schemas/RanFunction'
686 - servedNrCellInformation
711 additionalProperties: false
722 sulTransmissionBandwidth:
732 additionalProperties: false
734 additionalProperties: false
736 additionalProperties: false
749 additionalProperties: false
760 sulTransmissionBandwidth:
770 additionalProperties: false
772 additionalProperties: false
774 additionalProperties: false
776 additionalProperties: false
791 additionalProperties: false
802 sulTransmissionBandwidth:
812 additionalProperties: false
814 additionalProperties: false
816 additionalProperties: false
818 additionalProperties: false
820 additionalProperties: false
834 additionalProperties: false
837 servedNrCellInformation:
862 additionalProperties: false
873 sulTransmissionBandwidth:
883 additionalProperties: false
885 additionalProperties: false
887 additionalProperties: false
889 dlTransmissionBandwidth:
899 additionalProperties: false
912 additionalProperties: false
923 sulTransmissionBandwidth:
933 additionalProperties: false
935 additionalProperties: false
937 additionalProperties: false
939 ulTransmissionBandwidth:
949 additionalProperties: false
951 additionalProperties: false
966 additionalProperties: false
977 sulTransmissionBandwidth:
987 additionalProperties: false
989 additionalProperties: false
991 additionalProperties: false
993 transmissionBandwidth:
1003 additionalProperties: false
1005 additionalProperties: false
1007 additionalProperties: false
1023 additionalCellInformation:
1024 $ref: '#/components/schemas/AdditionalCellInformation'
1025 additionalProperties: false
1027 additionalProperties: false
1032 criticalityDiagnostics:
1034 informationElementCriticalityDiagnostics:
1047 additionalProperties: false
1052 procedureCriticality:
1060 additionalProperties: false
1078 transportLayerCause:
1082 additionalProperties: false
1084 AdditionalCellInformation:
1092 antennaAzimuthDirection: