Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Adding RAN Function Definition object in RAN Function Object in gNB Object (Response of several methods)
  • Supporting E2M Set Parameter (New method) with Enable RIC parameter
  • Get All NodeB States Request changed its End-Point URL
  • Adding Connection Status in RAN object in Get All NodeB States Response
  • Added Additional Cell Information for both eNB and gNB (in the Insert eNB Request, Update eNB or gNB Request and GET NodeB Response).

API Request Overview

Info

In the URI of each method in this document we write “V#” instead of V1, since when moving from Version to Version sometimes we forgot to update it in the document. So to make our life easier, V# covers the Latest version.

...

#Parameter

Data Type

Required?Value Rules
1

bandwidthReducedSi

ENUM

Status
colourGreen
titleNO

Refer to bandwidthReducedSi ENUM

2

broadcastPlmns

Array of String

Status
colourRed
titleYES

Array of PLMNs

3

cellId

String

Status
colourRed
titleYES


4

choiceEutraMode

Object

Status
colourRed
titleYES

Refer to choice Eutra Mode Object. One of them must appear

5

csgId

String

Status
colourGreen
titleNO


6

eutraMode

ENUM

Status
colourRed
titleYES

Refer to eutraMode ENUM

7

freqBandIndicatorPriority

ENUM

Status
colourGreen
titleNO

Refer to  freqBandIndicatorPriority ENUM

8

mbmsServiceAreaIdentities

Array of String

Status
colourGreen
titleNO


9

mbsfnSubframeInfos

Array of Object

Status
colourGreen
titleNO

Refer to mbsfn Subframe Object

10

multibandInfos

Array of Integer

Status
colourGreen
titleNO


11

neighbourInfos

Array of Object

Status
colourGreen
titleNO

Refer to neighbour Information Object

12

numberOfAntennaPorts

ENUM

Status
colourGreen
titleNO

Refer to numberOfAntennaPorts ENUM

13

pci

Integer

Status
colourRed
titleYES


14

prachConfiguration

Object

Status
colourGreen
titleNO

Refer to prach Configuration Object

15

Tac

String

Status
colourRed
titleYES

Refer to tac Object

16additionalCellInformationObject

Status
colourGreen
titleNO

Refer to Additional Cell Information Object

Choice Eutra Mode

Contains information of the Cell  – It is either FDD or TDD - Only one should exist

...

#Parameter

Data Type

Required?Value Rules
1

highSpeedFlag

Boolean

Status
colourRed
titleYES


2

prachConfigurationIndex

Integer

Status
colourRed
titleYES


3

prachFrequencyOffset

Integer

Status
colourRed
titleYES


4

rootSequenceIndex

Integer

Status
colourGreen
titleNO


5

zeroCorrelationZoneConfiguration

Integer

Status
colourRed
titleYES


Additional Cell Information

This will be updated in R5 by REST API

#

Parameter

Data Type

Required?

Value Rules

1

cellLatitude

Integer

Status
colourGreen
titleNO


2

cellLongitude

Integer

Status
colourGreen
titleNO


3antennaHeightInteger

Status
colourGreen
titleNO

In meter
4antennaAzimuthDirectionInteger

Status
colourGreen
titleNO
-

degree, 0-360
5antennaTiltAngleInteger

Status
colourGreen
titleNO

degree, 0-90
6antennaMaxTransmitInteger

Status
colourGreen
titleNO

dBm
7antennaMaxGainInteger

Status
colourGreen
titleNO

dB

Gnb

Contains information of the gnodeb

...

#Parameter

Data Type

Required?Value Rules
1

cellId

String

Status
colourRed
titleYES


2

choiceNrMode

Object

Status
colourRed
titleYES

Refer to Choice NR Mode Object

3

configuredStac

String

Status
colourGreen
titleNO


4

nrMode

ENUM

Status
colourRed
titleYES

Refer to NR Mode ENUM

5

nrPci

Integer

Status
colourRed
titleYES


6

servedPlmns

Array of String

Status
colourRed
titleYES

Array of PLMNs

7

stac5g

String

Status
colourGreen
titleNO


8additionalCellInformationObject

Status
colourGreen
titleNO

Refer to Additional Cell Information

Choice NR Mode

Contains information of the TBD – Note – It is either FDD or TDD, one of them must exist

...