1 # ========================LICENSE_START=================================
4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 # ========================LICENSE_END===================================
21 title: E2 Manager Service
22 description: E2 Manager Service APIs
25 - url: 'http://{apiRoot}/v1'
28 default: 'localhost:3800'
40 $ref: '#/components/schemas/SetupRequest'
46 description: Invalid input
48 application/problem+json:
50 $ref: '#/components/schemas/ErrorResponse'
52 description: Internal error
54 application/problem+json:
56 $ref: '#/components/schemas/ErrorResponse'
62 operationId: endcSetup
67 $ref: '#/components/schemas/SetupRequest'
73 description: Invalid input
77 $ref: '#/components/schemas/ErrorResponse'
79 description: Internal Error
81 application/problem+json:
83 $ref: '#/components/schemas/ErrorResponse'
88 summary: Get RAN by name
94 description: Name of RAN to return
99 description: Successful operation
103 $ref: '#/components/schemas/GetNodebResponse'
105 description: The specified RAN name is invalid
109 $ref: '#/components/schemas/ErrorResponse'
111 description: A RAN with the specified name was not found
113 application/problem+json:
115 $ref: '#/components/schemas/ErrorResponse'
117 description: Internal Error
119 application/problem+json:
121 $ref: '#/components/schemas/ErrorResponse'
127 Close all connections to the RANs
130 description: Successful operation
132 description: Internal Error
134 application/problem+json:
136 $ref: '#/components/schemas/ErrorResponse'
141 summary: Get RANs identities list
142 operationId: getNodebIdList
145 description: Successful operation
151 $ref: '#/components/schemas/NodebIdentity'
153 description: Internal Error
155 application/problem+json:
157 $ref: '#/components/schemas/ErrorResponse'
158 /nodeb/{ranName}/reset:
163 Upon receipt of this message, 'ranName' shall abort any other ongoing procedures over X2 between the RIC and the RAN. The RAN shall delete all the context information related to the RIC, except the application level configuration data exchanged during the X2 Setup or eNB Configuration Update procedures, and release the corresponding resource.
169 description: Name of RAN to return
176 $ref: '#/components/schemas/ResetRequest'
180 description: Successful operation
182 description: Invalid input (invalid cause, RAN in wrong state)
184 application/problem+json:
186 $ref: '#/components/schemas/ErrorResponse'
188 description: A RAN with the specified name was not found
190 application/problem+json:
192 $ref: '#/components/schemas/ErrorResponse'
194 description: Internal Error
196 application/problem+json:
198 $ref: '#/components/schemas/ErrorResponse'
204 summary: E2 Manager Service Health Check
231 enum: [misc:control-processing-overload,
232 misc:hardware-failure,
233 misc:om-intervention,
234 misc:not-enough-user-plane-processing-resources,
236 protocol:transfer-syntax-error,
237 protocol:abstract-syntax-error-reject,
238 protocol:abstract-syntax-error-ignore-and-notify,
239 protocol:message-not-compatible-with-receiver-state,
240 protocol:semantic-error,
241 protocol:unspecified,
242 protocol:abstract-syntax-error-falsely-constructed-message,
243 transport:transport-resource-unavailable,
244 transport:unspecified,
245 radioNetwork:handover-desirable-for-radio-reasons,
246 radioNetwork:time-critical-handover,
247 radioNetwork:resource-optimisation-handover,
248 radioNetwork:reduce-load-in-serving-cell,
249 radioNetwork:partial-handover,
250 radioNetwork:unknown-new-eNB-UE-X2AP-ID,
251 radioNetwork:unknown-old-eNB-UE-X2AP-ID,
252 radioNetwork:unknown-pair-of-UE-X2AP-ID,
253 radioNetwork:ho-target-not-allowed,
254 radioNetwork:tx2relocoverall-expiry,
255 radioNetwork:trelocprep-expiry,
256 radioNetwork:cell-not-available,
257 radioNetwork:no-radio-resources-available-in-target-cell,
258 radioNetwork:invalid-MME-GroupID,
259 radioNetwork:unknown-MME-Code,
260 radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
261 radioNetwork:reportCharacteristicsEmpty,
262 radioNetwork:noReportPeriodicity,
263 radioNetwork:existingMeasurementID,
264 radioNetwork:unknown-eNB-Measurement-ID,
265 radioNetwork:measurement-temporarily-not-available,
266 radioNetwork:unspecified,
267 radioNetwork:load-balancing,
268 radioNetwork:handover-optimisation,
269 radioNetwork:value-out-of-allowed-range,
270 radioNetwork:multiple-E-RAB-ID-instances,
271 radioNetwork:switch-off-ongoing,
272 radioNetwork:not-supported-QCI-value,
273 radioNetwork:measurement-not-supported-for-the-object,
274 radioNetwork:tDCoverall-expiry,
275 radioNetwork:tDCprep-expiry,
276 radioNetwork:action-desirable-for-radio-reasons,
277 radioNetwork:reduce-load,
278 radioNetwork:resource-optimisation,
279 radioNetwork:time-critical-action,
280 radioNetwork:target-not-allowed,
281 radioNetwork:no-radio-resources-available,
282 radioNetwork:invalid-QoS-combination,
283 radioNetwork:encryption-algorithms-not-aupported,
284 radioNetwork:procedure-cancelled,
285 radioNetwork:rRM-purpose,
286 radioNetwork:improve-user-bit-rate,
287 radioNetwork:user-inactivity,
288 radioNetwork:radio-connection-with-UE-lost,
289 radioNetwork:failure-in-the-radio-interface-procedure,
290 radioNetwork:bearer-option-not-supported,
291 radioNetwork:mCG-Mobility,
292 radioNetwork:sCG-Mobility,
293 radioNetwork:count-reaches-max-value,
294 radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
295 radioNetwork:pDCP-Overload]
341 dlTransmissionBandwidth:
347 ulTransmissionBandwidth:
353 additionalProperties: false
357 additionalSpecialSubframeExtensionInfo:
359 additionalSpecialSubframePatternsExtension:
371 additionalProperties: false
373 additionalSpecialSubframeInfo:
375 additionalSpecialSubframePatterns:
387 additionalProperties: false
401 specialSubframePatterns:
405 additionalProperties: false
411 transmissionBandwidth:
415 additionalProperties: false
417 additionalProperties: false
425 freqBandIndicatorPriority:
429 mbmsServiceAreaIdentities:
436 radioframeAllocationOffset:
438 radioframeAllocationPeriod:
444 subframeAllocationType:
448 additionalProperties: false
466 additionalProperties: false
469 numberOfAntennaPorts:
479 prachConfigurationIndex:
481 prachFrequencyOffset:
485 zeroCorrelationZoneConfiguration:
487 additionalProperties: false
491 additionalProperties: false
494 additionalProperties: false
506 additionalProperties: false
531 additionalProperties: false
542 sulTransmissionBandwidth:
552 additionalProperties: false
554 additionalProperties: false
556 additionalProperties: false
569 additionalProperties: false
580 sulTransmissionBandwidth:
590 additionalProperties: false
592 additionalProperties: false
594 additionalProperties: false
596 additionalProperties: false
611 additionalProperties: false
622 sulTransmissionBandwidth:
632 additionalProperties: false
634 additionalProperties: false
636 additionalProperties: false
638 additionalProperties: false
640 additionalProperties: false
654 additionalProperties: false
657 servedNrCellInformation:
676 additionalProperties: false
687 sulTransmissionBandwidth:
697 additionalProperties: false
699 additionalProperties: false
701 additionalProperties: false
703 dlTransmissionBandwidth:
713 additionalProperties: false
726 additionalProperties: false
737 sulTransmissionBandwidth:
747 additionalProperties: false
749 additionalProperties: false
751 additionalProperties: false
753 ulTransmissionBandwidth:
763 additionalProperties: false
765 additionalProperties: false
780 additionalProperties: false
791 sulTransmissionBandwidth:
801 additionalProperties: false
803 additionalProperties: false
805 additionalProperties: false
807 transmissionBandwidth:
817 additionalProperties: false
819 additionalProperties: false
821 additionalProperties: false
837 additionalProperties: false
839 additionalProperties: false
842 additionalProperties: false
856 criticalityDiagnostics:
858 informationElementCriticalityDiagnostics:
871 additionalProperties: false
876 procedureCriticality:
884 additionalProperties: false
906 additionalProperties: false
908 additionalProperties: false
918 description: '401 - corrupted json, 402 - validation error, 403 - RAN in wrong state, 404 - resource not found, 500 - RNIB error, 501 - internal problem, 502 - RMR error'
921 description: Human readable text