Porównane wersje

Stara Wersja 2

changes.mady.by.user Avinoam Bernstein

Zapisano

porównane z

Nowa wersja 3

changes.mady.by.user Avinoam Bernstein

Zapisano

Klucz

  • Te wersy zostały dodane. Tosłowo zostało dodane.
  • Te wersy zostały usunięte. To słowo zostało usunięte.
  • Formatowanie zostało zmienione.

...

The body is empty in case 204 No Content, and with specific HTTP code and error details in case failure


1. Health Check Request 

Reset nodeb Request  (Deprecated)


Resource

 

Resource for this interface

/v#

/health

Description

For simple health check the client should send GET request to /health endpoint. If client receives 200OK it means the server is up and running

/nodeb/<ran name>/reset

Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb/<ran name>/reset

Description

E2 Manager is requested to Reset specific RAN  

HTTP Method

GET

PUT

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK

204 No Content


Code Block
languagejava
themeConfluence
GETPUT http://<serverBaseURL>/v#/health/nodeb/<ran name>/reset
(See remark above about changing the Endpoint)

Request Data Details

Listed below are the key elements included in the request.

#Parameter

Location

Data TypeRequired?Description and Value Rules
1

accept

Header

String

Status
colourRed
titleYES

Refer

to Standard

to - Standard API Request Headers

2

content-type

Header

String


See above - Standard API Request Headers

3

cause

Body

String


Reason of the Reset (Cause enum). If not provided - E2M  will send misc:om-intervention


Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb/<ranName>/reset.

Code Block
language
Code Block
languagejava
themeConfluence
GETPUT http://localhost:3800/v1/health nodeb/NYC213123/reset

accept: application/json

{

"cause":  “misc:om-intervention”

}

Response Data Details

The body There is empty no Body in case 200 OK. No other response expected. If no answer - there is a problem....204 No Content, and with error details in case failure


1. Health Check Request 

2. Get NodeB Request 


Resource

 

Resource for this interface

/v#/

nodeb

health

Description

For

fetching nodeb data from Redis,

simple health check the client should send GET request to /health endpoint. If client receives 200OK it means the server is up and running

HTTP Method

GET

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK


Code Block
languagejava
themeConfluence
GET http://<serverBaseURL>/v#/nodeb/<ranName>health

Request Data Details

Listed below are the key elements included in the request.

#Parameter

Location

Data TypeRequired?Description and Value Rules
1

accept

Header

String

Status
colourRed
titleYES

Refer

to Standard

to Standard API Request Headers

2


Code Block

...

language

...

java

...

theme

...

Status
colourRed
titleYES

...

Refer to Standard API Request Headers

...

ranIp

...

Body

...

String

...

Status
colourRed
titleYES

...

IP of the RAN

...

ranPort

...

Body

...

Int

...

Status
colourRed
titleYES

...

Port of the RAN

...

ranName

...

Body

...

String

...

Status
colourRed
titleYES

...

Name of the RAN

Confluence
GET http://localhost:3800/v1/health 
accept: application/json

Response Data Details

The body is empty in case 200 OK. No other response expected. If no answer - there is a problem....

2. Get NodeB Request 


Resource

 

Resource for this interface

/v#/nodeb

Description

For fetching nodeb data from Redis, the client should send GET request

HTTP Method

GET

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK


Code Block
languagejava
themeConfluence
GET http://<serverBaseURL>/v#/nodeb/<ranName>

Request Data Details

Listed below are the key elements included in the request.

Code Block
languagejava
themeConfluence
GET http://localhost:3800/v1/nodeb/NYC213123  
accept: application/json  
Content-Type: application/json

Response Data Details

In case 200 OK, this is the payload

#Parameter

Location

Data TypeRequired?Description and Value Rules
1
content-type

accept

Header

String

Status
colourRed
titleYES

Refer to Standard API Request Headers

2
connectionStatus

content-type

Body

Header

ENUM

String

Status
colourRed
titleYES

Refer to Standard API Request Headers

3
ip

ranIp

Body

String

Status
colourRed
titleYES

IP of the RAN

4
port

ranPort

Body

Integer

Int

Status
colourRed
titleYES

Port of the RAN

5
nodeType

ranName

Body

ENUM

String

Status
colourRed
titleYES

Name of the RAN


Code Block
languagejava
themeConfluence
GET http://localhost:3800/v1/nodeb/NYC213123  
accept: application/json  
Content-Type: application/json

Response Data Details

In case 200 OK, this is the payload

#Parameter

Location

Data TypeRequired?Value Rules
1

content-type

Header

String

6

ranName

Body

String

7

enb (or gnb)

Body

Object

Status
colourGreen
titleNO

According the nodetype – ENB or GNB

Mandatory when the status is CONNECTED

8

failureType

Body

ENUM

Status
colour

Green

Red
title

NO

Mandatory when the status is CONNECTED_SETUP_FAILED

9

setupFailure

Body

Object

YES


2

connectionStatus

Body

ENUM

Status
colour

Green

Red
title

NO

Mandatory when the status is CONNECTED_SETUP_FAILED

10globalNbIdBody

YES


3

ip

Body

String

Object

Status
colour

Green

Red
titleYES

NO

Mandatory when the status is CONNECTED.

Refer to object globalNbId

ENB

Contains information of the eNodeb


4

port

Body

Integer

Status
colourRed
titleYES


5

nodeType

Body

#Parameter

Data Type

Required?Value Rules1enbType

ENUM

Status
colourRed
titleYES

Refer to ENB Type ENUM

2

guGroupIds

Array of String

Status
colourGreen
titleNO

3

servedCells

Array of


6

ranName

Body

String



7

enb (or gnb)

Body

Object

Status
colour
Red
Green
title
YES

Refer to served Cells object

Served Cells

Contains information of the cell

#Parameter

Data Type

Required?Value Rules1

bandwidthReducedSi

NO


According the nodetype – ENB or GNB

Mandatory when the status is CONNECTED

8

failureType

Body

ENUM

Status
colourGreen
titleNO

Refer to bandwidthReducedSi ENUM

2

broadcastPlmns

Array of String

Mandatory when the status is CONNECTED_SETUP_FAILED

9

setupFailure

Body

Object

Status
colour

Red

Green
title

YES

Array of PLMNs

3

cellId

String

Status
colourRed
titleYES

4choiceEutraMode

NO

Mandatory when the status is CONNECTED_SETUP_FAILED

10globalNbIdBodyObject
Status
colour
Red
Green
title
YES

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

5

csgId

String

Status
colourGreen
titleNO

6
NO

Mandatory when the status is CONNECTED.

Refer to object globalNbId

ENB

Contains information of the eNodeb

#Parameter

Data Type

Required?Value Rules
1

enbType

eutraMode

ENUM

Status
colourRed
titleYES

Refer

to eutraMode

to ENB Type ENUM

7
2
freqBandIndicatorPriority

guGroupIds

ENUM8

mbmsServiceAreaIdentities

Array of String

Status
colourGreen
titleNO

Refer to  freqBandIndicatorPriority ENUM


3

servedCells

Array of

String

Object

Status
colour

Green

Red
titleYES

Refer to served Cells object

Served Cells

Contains information of the cell

Array of IntegerneighbourInfos ObjectGreenENUMGreenIntegerObjectString to tac Object
#Parameter

Data Type

Required?Value Rules
1

bandwidthReducedSi

ENUM

NO
9

mbsfnSubframeInfos

Array of Object

Status
colourGreen
titleNO

Refer to mbsfn Subframe Object

10

multibandInfos

Status
colourGreen
titleNO

11

Refer to bandwidthReducedSi ENUM

2

broadcastPlmns

Array of

String

Status
colour

Red
title

NO

Refer to neighbour Information Object

12

numberOfAntennaPorts

YES

Array of PLMNs

3

cellId

String

Status
colour

Red
title

NO

Refer to numberOfAntennaPorts ENUM

13

pci

YES


4

choiceEutraMode

Object

Status
colourRed
titleYES

14

prachConfiguration

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

5

csgId

String

Status
colourGreen
titleNO

Refer to prach Configuration Object

15

Tac


6

eutraMode

ENUM

Status
colourRed
titleYES

Refer

Choice Eutra Mode

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

...

Data Type

...

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

...

fdd

...

Object

...

Refer to FDD Info

...

tdd

...

Object

...

Refer to TDD Info

FDD Info

Contains information of the FDD Cell

#Parameter

Data Type

Required?Value Rules1

dlTransmissionBandwidth

ENUM

Status
colourRed
titleYES

Refer to TransmissionBandwidth ENUM

2

dlearFcn

Integer

Status
colourRed
titleYES

3ulTransmissionBandwidth

ENUM

Status
colour

Red

Green
title

YES

NO

Refer to

TransmissionBandwidth

numberOfAntennaPorts ENUM

4
13
ulearFcn#Parameter

Data Type

Required?Value Rules1

additionalSpecialSubframeExtensionInfo

Object

Statuscolour

pci

Integer

Status
colourRed
titleYES

TDD Info

Contains information of the TDD Cell


14

prachConfiguration

Object

Status
colour

Green
titleNO

Refer

to Additional Special Subframe Extension Info

to prach Configuration Object

15

Tac

String

2

additionalSpecialSubframeInfo

Object

Status
colour

Green

Red
title

NO

YES

Refer

to Additional Special Subframe Info3

earFcn

Integer

to tac 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

fdd

Object


Refer to FDD Info

2

tdd

Object


Refer to TDD Info

FDD Info

Contains information of the FDD Cell

Status
colourRed
titleYES

4

specialSubframeInfo

Object

Status
colourRed
titleYES

Refer to Special Subframe Info

5

subframeAssignment

ENUM

Status
colourRed
titleYES

6

transmissionBandwidth

#Parameter

Data Type

Required?Value Rules
1

dlTransmissionBandwidth

#Parameter

Data Type

Required?Value Rules1

additionalSpecialSubframePatternsExtension

ENUM

ENUM

Status
colourRed
titleYES

Additional Special Subframe Extension Info

Contains information of the Sub Frame

Refer to TransmissionBandwidth ENUM

2

dlearFcn

Integer

Status
colourRed
titleYES

Refer to Additional Special Subframe Patterns ENUM

2cyclicPrefixDl


3

ulTransmissionBandwidth

ENUM

Status
colourRed
titleYES

Refer to

CyclicPrefix

TransmissionBandwidth ENUM

3
4
cyclicPrefixUl

ulearFcn

ENUM

Integer

Status
colourRed
titleYES

Refer to CyclicPrefix ENUM

...


TDD Info

Contains information of the Sub FrameTDD Cell

#Parameter

Data Type

Required?Value Rules
1
additionalSpecialSubframePatterns

additionalSpecialSubframeExtensionInfo

ENUM

Object

Status
colour

Red

Green
title

YES

NO

Refer to Additional Special Subframe

ENUM

Extension Info

2
cyclicPrefixDl

additionalSpecialSubframeInfo

ENUM

Object

Status
colour

Red

Green
title

YES

NO

Refer

to CyclicPrefix ENUM

to Additional Special Subframe Info

3
cyclicPrefixUl

earFcn

ENUM

Integer

Status
colourRed
titleYES

Refer to CyclicPrefix ENUM

...


4

specialSubframeInfo

Object

Status
colourRed
titleYES

Refer to Special Subframe Info

5

subframeAssignment

ENUM

Status
colourRed
titleYES


6

transmissionBandwidth

ENUM

Status
colourRed
titleYES


Additional Special Subframe Extension Info

Contains information of the Sub Frame

#Parameter

Data Type

Required?Value Rules
1
SpecialSubframePatterns

additionalSpecialSubframePatternsExtension

ENUM

Status
colourRed
titleYES

Refer

to Special

to Additional Special Subframe Patterns ENUM

2

cyclicPrefixDl

ENUM

Status
colourRed
titleYES

Refer

to CyclicPrefix

to CyclicPrefix ENUM

3

cyclicPrefixUl

ENUM

Status
colourRed
titleYES

Refer

to CyclicPrefix

to CyclicPrefix ENUM

...

Additional Special Subframe Info

Contains information of the Sub Frame

#Parameter

Data Type

Required?Value Rules
1
radioframeAllocationOffset

additionalSpecialSubframePatterns

Integer

ENUM

Status
colourRed
titleYES

Refer to Additional Special Subframe ENUM

2
radioframeAllocationPeriod

cyclicPrefixDl

ENUM

Status
colourRed
titleYES

Refer to CyclicPrefix ENUM

3
subframeAllocation

cyclicPrefixUl

String

ENUM

Status
colourRed
titleYES

4subframeAllocationType

Refer to CyclicPrefix ENUM

Status
colourRed
titleYES

Neighbor Information

Special Subframe Info

Contains information of the NeighborSub Frame

#Parameter

Data Type

Required?Value Rules
1
ecgi

SpecialSubframePatterns

String

ENUM

Status
colourRed
titleYES

Refer to Special Subframe ENUM

2
pci

cyclicPrefixDl

Integer

ENUM

Status
colourRed
titleYES

Refer to CyclicPrefix ENUM

3
earFcn

cyclicPrefixUl

Integer

ENUM

Status
colourRed
titleYES

4

tac

String

Status
colourGreen
titleNO

Prach Configuration

Refer to CyclicPrefix ENUM

mbsfn Subframe

Contains information of the PrachSub Frame

title
#Parameter

Data Type

Required?Value Rules
1

highSpeedFlagradioframeAllocationOffset

BooleanInteger

Status
colourRed
titleYES


2

prachConfigurationIndexradioframeAllocationPeriod

IntegerENUM

Status
colourRed
titleYES


3

prachFrequencyOffsetsubframeAllocation

IntegerString

Status
colourRed
titleYES


4rootSequenceIndexsubframeAllocationTypeIntegerENUM
Status
colour
Green
NO
5

zeroCorrelationZoneConfiguration

Integer

Statuscolour
Red
titleYES

...


Neighbor Information

Contains information of the gnodebNeighbor

#Parameter

Data Type

Required?Value Rules
1
servedNrCells

ecgi

Array of Object

String

Status
colourRed
titleYES

Refer to served NR Cells object


2
ranFunctions

pci

Array of Object

Integer

Status
colourRed
titleYES

Refer to served RAN function object

Served NR Cells

Contains information of the GNB cell


3

earFcn

Integer

Status
colourRed
titleYES


4

tac

String

#Parameter

Data Type

Required?Value Rules1

nrNeighbourInfos

Array of object

Status
colourGreen
titleNO

Refer to NrNeighbourInformation object

2

servedNrCellInformation

Object

Status
colourRed
titleYES

Refer to ServedNRCellInformation object

Nr Neighbour Information


Prach Configuration

Contains information of the Neighbor of this GNB Note it is quite similar to Served NR Cell InformationPrach

#Parameter

Data Type

Required?Value Rules
1
nrCgi

highSpeedFlag

String

Boolean

Status
colourRed
titleYES


2
choiceNrMode

prachConfigurationIndex

Object

Integer

Status
colourRed
titleYES

Refer to Choice NR Mode Object


3
configuredStac

prachFrequencyOffset

String

Integer

Status
colour

Green

Red
title

NO

YES


4
nrMode

rootSequenceIndex

ENUM

Integer

Status
colour

Red

Green
title

Yes

NO

Refer to NR Mode ENUM


5
nrPci

zeroCorrelationZoneConfiguration

Integer

Status
colourRed
title

Yes

YES

6

stac5g

String

Status
colourGreen
titleNO

Served NR Cell Information

Contains information of the cell


Gnb

Contains information of the gnodeb

#Parameter

Data Type

Required?Value Rules
1
cellId

servedNrCells

String

Array of Object

Status
colourRed
titleYES

Refer to served NR Cells object

2
choiceNrMode
ranFunctionsArray of Object

Status
colourRed
titleYES

Refer
to Choice NR Mode Object3

configuredStac

String

Status
colourGreen
titleNO

4

nrMode

to served RAN function object

Served NR Cells

Contains information of the GNB cell

#Parameter

Data Type

Required?Value Rules
1

nrNeighbourInfos

Array of object

ENUM

Status
colour

Red

Green
title

YES

NO

Refer

to NR Mode ENUM

to NrNeighbourInformation object

2

servedNrCellInformation

Object

5

nrPci

Integer

Status
colourRed
titleYES

6

servedPlmns

Array of String

Refer to ServedNRCellInformation object

Nr Neighbour Information

Contains information of the Neighbor of this GNB Note it is quite similar to Served NR Cell Information

Status
#Parameter

Data Type

Required?Value Rules
1

nrCgi

String

Status

colourRed
titleYES

Array of PLMNs


2
7

choiceNrMode

stac5g

Object

String

Status
colour

Green

Red
title

NO

YES

...

Refer to Choice NR Mode

...

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

...

Data Type

...

fdd

...

Object

...

Refer to NR FDD Info

...

tdd

...

Object

...

Refer to NR TDD Info

NR FDD Info

Contains information of the NR FDD Cell

...

Data Type

...

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

stac5g

String

Status
colourGreen
titleNO


Served NR Cell Information

Contains information of the cell

...

dlFreqInfo

...

Object

...

Refer to dl Freq Info Object

...

dlTransmissionBandwidth

...

Object

...

Refer to dl Transmission Bandwidth Object

...

ulFreqInfo

...

Object

...

Refer to ul Freq Info Object

...

ulTransmissionBandwidth

...

Object

...

Refer to ul Transmission Bandwidth Object

dl Freq Info or ul Freq Info or nr Freq Info NR

Contains information of the Cell

#Parameter

Data Type

Required?Value Rules
1

frequencyBands

Object

Refer to frequency Bands Object

cellId

String

Status
colourRed
titleYES


2
nrArFcn

choiceNrMode

integer

Object

Status
colourRed
titleYES

Refer to Choice NR Mode Object

3
sulInformation

configuredStac

Object

Refer to sul Information Object

Frequency Bands

Contains information of the Frequency Bands

String

Status
colourGreen
titleNO


4

nrMode

ENUM

Status
colourRed
titleYES

Refer to NR Mode ENUM

5

nrPci

Integer

#Parameter

Data Type

Required?Value Rules1

nrFrequencyBand

integer

Status
colourRed
titleYES

2supportedSulBands


6

servedPlmns

Array of String

Status
colourRed
titleYES

Array of

integer

PLMNs

7

stac5g

String

Status
colourGreen
titleNO

...


Choice NR Mode

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

#Parameter

Data Type

Required?Value Rules
1

sulArFcn

integer

fdd

Object


Refer to NR FDD Info

2
sulTransmissionBandwidth

tdd

object

Object


Refer

to sul Transmission Bandwidth object

...

to NR TDD Info

NR FDD Info

Contains information of the TBDNR FDD Cell

#Parameter

Data Type

Required?Value Rules
1
ncnrb

dlFreqInfo

ENUM

Object


Refer

to ncnrb ENUM2

nrscs

ENUM

Refer to nrscs ENUM

...

to dl Freq Info Object

2

dlTransmissionBandwidth

Object


Refer to dl Transmission Bandwidth Object

3

ulFreqInfo

Object


Refer to ul Freq Info Object

4

ulTransmissionBandwidth

Object


Refer to ul Transmission Bandwidth Object

dl Freq Info or ul Freq Info or nr Freq Info NR

Contains information of the NE Cell TDD

#Parameter

Data Type

Required?Value Rules
1
nrFreqInfo

frequencyBands

Object


Refer

to nr Freq Info

to frequency Bands Object

2
transmissionBandwidth

nrArFcn

integer

Status
colourRed
titleYES


3

sulInformation

Object


Refer

to transmission Bandwidth

to sul Information Object

...

Frequency Bands

Contains information of the Function this RAN supports - Please refer to O-RAN Working Group 3, E2 Application Protocol (E2AP)Frequency Bands

#
#
Parameter

Data Type

Required?Value Rules
1
ranFunctionId

nrFrequencyBand

Integer

integer

Status
colourRed
titleYES


2
ranFunctionDefinition

supportedSulBands

String

Array of integer

Status
colour

Red

Green
title

YES

NO

3ranFunctionRevisionInteger

Status
colourRed
titleYES

Setup Failure


sul Information

Contains information of the errorTBD

#Parameter

Data Type

Required?Value Rules
1
cause_group

sulArFcn

ENUM

integer

status



2
colour

sulTransmissionBandwidth

GreentitleNO

One of the following ENUM

  • RadioNetworkLayerCause
  • TransportLayerCause
  • ProtocolCause
  • MiscellaneousCause
2

TimeToWait

ENUM

Look on TimeToWait ENUM

3

CriticalityDiagnostics

Object

...

object


Refer to sul Transmission Bandwidth object

dl Transmission Bandwidth or ul Transmission Bandwidth or sul Transmission Bandwidth or Transmission Bandwidth

Contains information of the TBD

#Parameter

Data Type

Required?Value Rules
1

ncnrb

ENUM


Refer to ncnrb ENUM

2

nrscs

ENUM


Refer to nrscs ENUM

NR TDD Info

Contains information of the errorNE Cell TDD

#Parameter

Data Type

Required?Value Rules
1
informationElementCriticalityDiagnostics

nrFreqInfo

Object

·       


Refer to nr Freq Info Object

2

procedureCode

Integer

3

procedureCriticality

ENUM

Refer to Criticality ENUM

4

triggeringMessage

ENUM

Refer to TriggeringMessage ENUM

Information Element Criticality Diagnostics

transmissionBandwidth

Object


Refer to transmission Bandwidth Object

RAN Function

Contains information of the Function this RAN supports - Please refer to O-RAN Working Group 3, E2 Application Protocol (E2AP)Contains information of the error

#Parameter

Data Type

Required?Value Rules
1

ieCriticality

ENUM

Refer to Criticality ENUM

ranFunctionId

Integer

Status
colourRed
titleYES


2
ieId
ranFunctionDefinitionString
Integer

Status

3

colour

typeOfError

Red

ENUM

title

Refer to TypeOfError ENUM

YES


3
. Update GNB Request  
Resource
ranFunctionRevision

 

Resource for this interface

/v#/nodeb

Description

For storing nodeb data to Redis, the client should send PUT request

HTTP Method

PUT

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK

PUT http://<serverBaseURL>/v#/nodeb/<ranName>/update

...

Integer

Status
colourRed
titleYES


Setup Failure

Contains information of the error

#Parameter

Location

Data Type

Required?Value Rules
accept
1
Header

cause_group

String

ENUM

YES

Refer to Standard API Request Headers

content-type

Header

String

YES

Refer to Standard API Request Headers

servedNrCellsBodyArray of ObjectYESPlease refer to Served NR Cells array inside the gNB Object (In the Get NodeB Response)

Example:

Status
colourGreen
titleNO

One of the following ENUM

  • RadioNetworkLayerCause
  • TransportLayerCause
  • ProtocolCause
  • MiscellaneousCause
2

TimeToWait

ENUM


Look on TimeToWait ENUM

3

CriticalityDiagnostics

Object



Criticality Diagnostics

Contains information of the error

#Parameter

Data Type

Required?Value Rules
1

informationElementCriticalityDiagnostics

Object


·       

2

procedureCode

Integer



3

procedureCriticality

ENUM


Refer to Criticality ENUM

4

triggeringMessage

ENUM


Refer to TriggeringMessage ENUM

Information Element Criticality Diagnostics

Contains information of the error

#Parameter

Data Type

Required?Value Rules
1

ieCriticality

ENUM


Refer to Criticality ENUM

2

ieId

Integer



3

typeOfError

ENUM


Refer to TypeOfError ENUM


3. Update GNB Request  


Resource

 

Resource for this interface

/v#/nodeb

Description

For storing nodeb data to Redis, the client should send PUT request

HTTP Method

PUT

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK


PUT http://<serverBaseURL>/v#/nodeb/<ranName>/update

Request Data Details

#

Parameter

Location

Data Type

Required?

Value Rules


acceptHeaderString

YES

Refer to Standard API Request Headers

content-type

Header

String

YES

Refer to Standard API Request Headers


servedNrCellsBodyArray of ObjectYESPlease refer to Served NR Cells array inside the gNB Object (In the Get NodeB Response)

Example:

Code Block
languagejava
themeConfluence
PUT http://localhost:3800/v1/nodeb/test1/update
accept: application/json
{
       "servedNrCells": [
      {
        "servedNrCellInformation": {
         "nrPci": 100,
          "cellId": "02f829:0007ab0178",
          "servedPlmns": [
Code Block
languagejava
themeConfluence
PUT http://localhost:3800/v1/nodeb/test1/update
accept: application/json
{
       "servedNrCells": [
      {
        "servedNrCellInformation": {
         "nrPci": 100,
          "cellId": "02f829:0007ab0178",
          "servedPlmns": [
            "02f829"
          ],
          "nrMode": "FDD",
          "choiceNrMode": {
            "fdd": {
              "ulFreqInfo": {
                "nrArFcn": "100",
                "frequencyBands": [
                  {
                    "nrFrequencyBand": 9,
                    "supportedSulBands": [
                      9
                    ]
                  }
                ]
              },
              "dlFreqInfo": {
                "nrArFcn": "100",
                "frequencyBands": [
                  {
                    "nrFrequencyBand": 9,
                    "supportedSulBands": [
                      9
                    ]
                  }
                ]
              },
              "ulTransmissionBandwidth": {
                "nrscs": "SCS15",
                "ncnrb": "NRB11"
              },
              "dlTransmissionBandwidth": {
                "nrscs": "SCS15",
                "ncnrb": "NRB11"
              }
            }
          }
        },
        "nrNeighbourInfos": [
          {
            "nrCgi": "string",
            "choiceNrMode": {
              "fdd": {
                "ulFreqInfo": {
                  "nrArFcn": "100",
                  "frequencyBands": [
                    {
                      "nrFrequencyBand": 9,
                      "supportedSulBands": [
                        9
                      ]
                    }
                  ]
                },
                "dlFreqInfo": {
                  "nrArFcn": "100",
                  "frequencyBands": [
                    {
                      "nrFrequencyBand": 9,
                      "supportedSulBands": [
                        9
                      ]
                    }
                  ]
                },
                "ulTransmissionBandwidth": {
                  "nrscs": "SCS15",
                  "ncnrb": "NRB11"
                },
                "dlTransmissionBandwidth": {
                  "nrscs": "SCS15",
                  "ncnrb": "NRB11"
                }
              }
            },
            "configuredStac": "string",
            "nrPci": 200,
            "nrMode": "FDD",
            "stac5g": "string"
          },
          {
            "nrCgi": "string",
            "choiceNrMode": {
              "fdd": {
                "ulFreqInfo": {
                  "nrArFcn": "100",
                  "frequencyBands": [
                    {
                      "nrFrequencyBand": 9,
                      "supportedSulBands": [
                        9
                      ]
                    }
                  ]
                },
                "dlFreqInfo": {
                  "nrArFcn": "100",
                  "frequencyBands": [
                    {
                      "nrFrequencyBand": 9,
                      "supportedSulBands": [
                        9
                      ]
                    }
                  ]
                },
                "ulTransmissionBandwidth": {
                  "nrscs": "SCS15",
                  "ncnrb": "NRB11"
                },
                "dlTransmissionBandwidth": {
                  "nrscs": "SCS15",
                  "ncnrb": "NRB11"
                }
              }
            },
            "configuredStac": "string",
            "nrPci": 201,
            "nrMode": "FDD",
            "stac5g": "string"
          }
        ]
      },
      {
        "servedNrCellInformation": {
          "nrPci": 101,
          "cellId": "02f829:0007ab0120",
          "servedPlmns": [
            "02f829"
          ],
          "nrMode": "FDD",
          "choiceNrMode": {
            "fdd": {
              "ulFreqInfo": {
                "nrArFcn": "100",
                "frequencyBands": [
                  {
                    "nrFrequencyBand": 9,
                    "supportedSulBands": [
                      9
                    ]
                  }
                ]
              },
              "dlFreqInfo": {
                "nrArFcn": "100",
                "frequencyBands": [
                  {
                    "nrFrequencyBand": 9,
                    "supportedSulBands": [
                      9
                    ]
                  }
                ]
              },
              "ulTransmissionBandwidth": {
                "nrscs": "SCS15",
                "ncnrb": "NRB11"
              },
              "dlTransmissionBandwidth": {
                "nrscs": "SCS15",
                "ncnrb": "NRB11"
              }
            }
          }
        },
        "nrNeighbourInfos": [
          {
            "nrCgi": "string",
            "choiceNrMode": {
              "fdd": {
                "ulFreqInfo": {
                  "nrArFcn": "100",
                  "frequencyBands": [
                    {
                      "nrFrequencyBand": 9,
                      "supportedSulBands": [
                        9
                      ]
                    }
                  ]
                },
                "dlFreqInfo": {
                  "nrArFcn": "100",
                  "frequencyBands": [
                    {
                      "nrFrequencyBand": 9,
                      "supportedSulBands": [
                        9
                      ]
                    }
                  ]
                },
                "ulTransmissionBandwidth": {
                  "nrscs": "SCS15",
                  "ncnrb": "NRB11"
                },
                "dlTransmissionBandwidth": {
                  "nrscs": "SCS15",
                  "ncnrb": "NRB11"
                }
              }
            },
            "configuredStac": "string",
            "nrPci": 300,
            "nrMode": "FDD",
            "stac5g": "string"

            },
            ]
"configuredStac": "string",
       }
     ]
}

Response Data Details

In case 200 OK, the payload is identical to Get NodeB <RAN Name>.

...

4. Shut Down Request 

...

Resource

 

...

Resource for this interface

/v#/nodeb

...

Description

...

E2 Manager is requested to Shut Down all the RANs  

...

HTTP Method

...

PUT

...

Supported Representation Formats

...

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

...

Successful HTTP Response Code

...

204 No Content

"nrPci": 300,
            "nrMode": "FDD",
            "stac5g": "string"
          }
        ]
      }
    ]
}

Response Data Details

In case 200 OK, the payload is identical to Get NodeB <RAN Name>.


4. Shut Down Request 

Code Block
languagejava
themeConfluence
PUT http://<serverBaseURL>/v#/nodeb/shutdown

Request Data Details

Listed below are the key elements included in the request.

...

Location

...

accept

...

Header

...

String

...

Status
colourRed
titleYES

...

Refer to - Standard API Request Headers

Code Block
languagejava
themeConfluence
PUT http://localhost:3800/v1/nodeb/shutdown
accept: application/json

Response Data Details

There is no Body in case 204 No Content, and with 202 Accepted with error details in case failure such as Routing Manager (511)

5. Get All NodeB Request


Resource

 

Resource for this interface

/v#/nodeb

/ids

Description

E2 Manager is requested to

get list of all RANs in its RNIB DB

Shut Down all the RANs  

HTTP Method

GET

PUT

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK

204 No Content


Code Block
languagejava
themeConfluence
GETPUT http://<serverBaseURL>/v#/nodeb/idsshutdown

Request Data Details

Listed below are the key elements included in the request.

#Parameter

Location

Data TypeRequired?Description and Value Rules
1

accept

Header

String

Status
colourRed
titleYES

Refer to - Standard API Request Headers


Code Block
languagejava
themeConfluence
GETPUT http://localhost:3800/v1/nodeb/idsshutdown
accept: application/json

Response Data Details

In case 200 OK, this is the payload

...

Location

...

content-type

...

Header

...

String

...

Status
colourRed
titleYES

...

rans

...

Body

...

List of Object

...

Status
colourRed
titleYES

...

Can be empty in case no RANs. See nodebIdentity

There is no Body in case 204 No Content, and with 202 Accepted with error details in case failure such as Routing Manager (511)


5. Get All NodeB Request


Resource

 

Resource for this interface

/v#/nodeb/ids

Description

E2 Manager is requested to get list of all RANs in its RNIB DB

HTTP Method

GET

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK


Code Block
languagejava
themeConfluence
GET http://<serverBaseURL>/v#/nodeb/ids

Request Data Details

Listed below are the key elements included in the request.

#Parameter

Location

nodebIdentity

Contains information of the eNodeb

...

Data Type

...

inventoryName

...

String

...

Status
colourRed
titleYES

...

Name of the RAN

...

globalNbId

...

Object

...

Status
colourRed
titleYES

...

ID of the RAN - Refer globalNbId object

globalNbId

Contains information of the eNodeb

#Parameter

Data TypeRequired?Description and Value Rules
1
nbId

accept

Header

String

yes

ID of the RAN. Different ID for eNB or gNB. In case eNB it is according the eNB Type.

2

plmnId

Object

yes

ID of the PLMN (Public Land Mobile Network)

Reset nodeb Request  (Deprecated)

Resource

 

Resource for this interface

/v#/nodeb/<ran name>/reset

Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb/<ran name>/reset

Description

E2 Manager is requested to Reset specific RAN  

HTTP Method

PUT

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

204 No Content

Code Block
languagejava
themeConfluence
PUT http://<serverBaseURL>/v#/nodeb/<ran name>/reset
(See remark above about changing the Endpoint)

Request Data Details

Listed below are the key elements included in the request.

Status
colourRed
titleYES

Refer to - Standard API Request Headers


Code Block
languagejava
themeConfluence
GET http://localhost:3800/v1/nodeb/ids
accept: application/json

Response Data Details

In case 200 OK, this is the payload

#Parameter

Location

Data TypeRequired?Value Rules
1

content-type

Header

String

Status
colourRed
titleYES


2

rans

Body

List of Object

Status
colourRed
titleYES

Can be empty in case no RANs. See nodebIdentity

nodebIdentity

Contains information of the eNodeb

#Parameter

Data Type

Required?Value Rules
1

inventoryName

String

Status
colourRed
titleYES

Name of the RAN

2

globalNbId

Object

#Parameter

Location

Data TypeRequired?Description and Value Rules1

accept

Header

String

Status
colourRed
titleYES

Refer to - Standard API Request Headers

2

content-type

Header

String

See above - Standard API Request Headers

3

cause

Body

String

Reason of the Reset (Cause enum). If not provided - E2M  will send misc:om-intervention

Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb/<ranName>/reset.

Code Block
languagejava
themeConfluence
PUT http://localhost:3800/v1/nodeb/NYC213123/reset

accept: application/json

{

"cause":  “misc:om-intervention”

}

Response Data Details

There is no Body in case 204 No Content, and with error details in case failure

There is no Body in case 204 No Content, and with error details in case failure

ID of the RAN - Refer globalNbId object

globalNbId

Contains information of the eNodeb

#Parameter

Data Type

Required?Value Rules
1

nbId

String

yes

ID of the RAN. Different ID for eNB or gNB. In case eNB it is according the eNB Type.

2

plmnId

Object

yes

ID of the PLMN (Public Land Mobile Network)


6

8

. Get All E2T Request 



Resource

 

Resource for this interface

/v#/e2t/list

Description

E2 Manager is requested to get list of all E2T Instances address and list of RANs associate with each E2T Instance

HTTP Method

GET

Supported Representation Formats

Request: Request Format ie application/json, none, etc

Response: Response Format ie application/json, none, etc

Successful HTTP Response Code

200 OK

...