Page History

...

#	API	Resource After base URI	HTTP Verb
	~~X2 Setup Request Message Request~~ (deprecated)	/v#/nodeb/x2-setup	POST
	~~ENDC Setup Request Message Request~~ (deprecated)	/v#/nodeb/endc-setup	POST
	~~Reset nodeb Request~~ (deprecated)	/v#/nodeb/<ranName>/reset *	PUT
1	Health Check Request	/v#/health	GET
2	Get nodeb data Request	/v#/nodeb/<ranName>	GET
3	Update GNB Request	/v#/nodeb/<ranName>/update	PUT
4Reset nodeb Request	Insert ENB Request	/v#/nodeb/<ranName>/Insertenb	POST
5	Update ENB Request	/v#/nodeb/<ranName>/reset *updateenb	PUT
56	Shut Down Request	/v#/nodeb/shutdown	PUT
57	Get All nodeb States Request (Changed, Stretch Goal)	/v#/nodeb/states	GET
68	Get NodeB State Request (New, Stretch Goal)	/v#/nodeb/states/<ranName>	GET
79	RAN Health Check Request (New, Stretch Goal)	/v#/nodeb/health	PUT
810	Get All E2T Request	/v#/e2t/list	GET
911	E2M set parameters (New)	/v#/nodeb/parameters	PUT

...

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

...

language	java
theme	Confluence

204 No Content

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.

#	Parameter	Location	Data Type	Required?	Description and Value Rules
1	accept	Header	String

Status

colour	Red
title	YES

Refer to Standard

	YES	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.

PUT http://localhost:3800/v1/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

HTTP Method

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

language	java
theme	Confluence

GET http://<serverBaseURL>/v#/nodeb/<ranName>health

Request Data Details

Listed below are the key elements included in the request.

#

Parameter

Location

Data Type

Required?

Description and Value Rules

1

accept

Header

String

Status

colour	Red
title	YES

Refer

to Standard API Request Headers2

content-type

Header

String

Status

colour	Red
title	YES

Refer

to Standard API Request Headers

3

ranIp

Body

String

Status

colour	Red
title	YES

IP of the RAN

4

ranPort

Body

Int

Status

colour	Red
title	YES

Port of the RAN

5

ranName

Body

String

Status

colour	Red
title	YES

Name of the RAN

Code Block

language	java
theme	Confluence

GET http://localhost:3800/v1/nodeb/NYC213123health  
accept: application/json  
Content-Type: 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

language	java
theme	Confluence

GET http://<serverBaseURL>/v#/nodeb/<ranName>

Request Data Details

Listed below are the key elements included in the request.

#	Parameter	Location	Data Type	Required?	Description and Value Rules
1	accept	Header	String

#Parameter

Location

Data TypeRequired?Value Rules1

content-type

Header

String

Status

colour	Red
title	YES

2

connectionStatus

Body

ENUM

Status

colour	Red
title	YES

3

ip

Body

Refer to Standard API Request Headers

2

content-type

Header

String

Status

colour	Red
title	YES

4port

Refer to Standard API Request Headers
3	ranIp	Body

Integer

String

Status

colour	Red
title	YES

IP of the RAN

5

4

nodeType

ranPort

Body

ENUM

Int

Status

colour	Red
title	YES

Port of the RAN

6

5

ranName

Body

String

7

enb (or gnb)

Body

Object

Status

colour	Green
title	NO

According the nodetype – ENB or GNB

Mandatory when the status is CONNECTED

8

failureType

Body

ENUM

Status

colour	Green
title	NO

Mandatory when the status is CONNECTED_SETUP_FAILED

9

setupFailure

Body

Object

Status

colour	Green
title	NO

Mandatory when the status is CONNECTED_SETUP_FAILED

10globalNbIdBodyObject

Status

colour	Green
title	NO

Mandatory when the status is CONNECTED.

Refer to object globalNbId

ENB

Contains information of the eNodeb

Status

colour	Red
title	YES

Name of the RAN

Code Block

language	java
theme	Confluence

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

Data Type

Required?Value Rules1

enbType

ENUM

#

Parameter

Location

Data Type

Required?

Value Rules

1

content-type

Header

String

Status

colour	Red
title	YES

2

connectionStatus

Body

ENUM

Status

colour	Red
title	YES

3

ip

Body

String

Status

colour	Red
title	YES

Refer to ENB Type ENUM

2

guGroupIds

Array of String

4

port

Body

Integer

Status

colour

Green

Red
title	YES

NO

5

3

nodeType

servedCells

Body

Array of Object#Parameter

Data Type

Required?Value Rules1

bandwidthReducedSi

ENUM

Statuscolour

ENUM

Status

colour	Red
title	YES

Refer to served Cells object

Served Cells

Contains information of the cell

6

ranName

Body

String

7

enb (or gnb)

Body

Object

Status

colour

Green
title	NO

Refer to bandwidthReducedSi ENUM

2

broadcastPlmns

Array of String

According the nodetype – ENB or GNB

Mandatory when the status is CONNECTED

8

failureType

Body

ENUM

Status

colour

Red

title
Green

YES

	NO

Mandatory when the status is CONNECTED_SETUP_FAILED

9

setupFailure

Body

Object

Array of PLMNs

3

cellId

String

Status

colour

Red

title
Green

YES4

choiceEutraMode

Object

Status

colour	Red
title	YES

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

5

csgId

String

NO

Mandatory when the status is CONNECTED_SETUP_FAILED

10

globalNbId

Body

Object

Status

colour	Green
title	NO

6

eutraMode

ENUM

Status

colour	Red
title	YES

Refer to eutraMode ENUM

7

Mandatory when the status is CONNECTED.

Refer to object globalNbId

ENB

Contains information of the eNodeb

#	Parameter	Data Type	Required?	Value Rules
1	enbType

freqBandIndicatorPriority

ENUM

Status

colour

Green

title
Red

NO

YES

Refer

to freqBandIndicatorPriority

to ENB Type ENUM

8

2

mbmsServiceAreaIdentities

guGroupIds

Array of String

Status

colour	Green
title	NO

9

3

mbsfnSubframeInfos

servedCells

Array of Object

Status

colour

Green

title
Red

NO

YES

Refer to served Cells object

Served Cells

Contains information of the cell

to mbsfn Subframe ObjectArray of Object to neighbour Information ObjectENUMGreenInteger14prachConfigurationGreenNO to prach Configuration ObjectTacRedYES

#

Parameter

Data Type

Required?

Value Rules

1

bandwidthReducedSi

ENUM

10

multibandInfos

Array of Integer

Status

colour	Green
title	NO

11

neighbourInfos

Status

colour	Green
title	NO

Refer

to bandwidthReducedSi ENUM

2

broadcastPlmns

Array of String

12

numberOfAntennaPorts

Status

colour

title
Red

NO

Refer to numberOfAntennaPorts ENUM

13

pci

YES

Array of PLMNs

3

cellId

String

Status

colour	Red
title	YES

4

choiceEutraMode

Object

Status

colour

title
Red

YES

Refer

15

to choice Eutra Mode Object. One of them must appear

5

csgId

String

Status

colour

Green
title	NO

6

eutraMode

Refer to tac Object

Choice Eutra Mode

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

...

Data Type

...

ENUM

Status

colour	Red
title	YES

Refer to eutraMode ENUM

7

freqBandIndicatorPriority

ENUM

Status

colour	Green
title	NO

Refer to freqBandIndicatorPriority ENUM

8

mbmsServiceAreaIdentities

Array of String

Status

colour	Green
title	NO

9

mbsfnSubframeInfos

Array of Object

...

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

colour

Red

title
Green

YES

NO

Refer

to TransmissionBandwidth ENUM

to mbsfn Subframe Object
10	multibandInfos	Array of

2

dlearFcn

Integer

Status

colour

Red

title
Green

YES

NO

3

11

ulTransmissionBandwidth

neighbourInfos

ENUM

Array of Object

Status

colour

Red

title
Green

YES

NO

Refer

to TransmissionBandwidth ENUM4

ulearFcn

to neighbour Information Object
12	numberOfAntennaPorts	ENUM

Integer

Status

colour

Red

title
Green

YES

TDD Info

Contains information of the TDD Cell

NO

Refer to numberOfAntennaPorts ENUM

13

pci

Integer

#Parameter

Data Type

Required?Value Rules1

additionalSpecialSubframeExtensionInfo

Object

Status

colour

Green

title
Red

NO

Refer to Additional Special Subframe Extension Info

2additionalSpecialSubframeInfo

YES

14

prachConfiguration

Object

Status

colour	Green
title	NO

Refer

to Additional Special Subframe Info3

earFcn

to prach Configuration Object
15	Tac	String

Integer

Status

colour	Red
title	YES

4

specialSubframeInfo

Refer to tac Object

Status

colour	Red
title	YES

Refer to Special Subframe Info

5

subframeAssignment

ENUM

Status

colour	Red
title	YES

6

transmissionBandwidth

ENUM

Status

colour	Red
title	YES

...

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 Sub FrameFDD Cell

#	Parameter	Data Type	Required?	Value Rules
1

additionalSpecialSubframePatternsExtension

dlTransmissionBandwidth

ENUM

Status

colour	Red
title	YES

Refer to

Additional Special Subframe Patterns

TransmissionBandwidth ENUM

2

cyclicPrefixDl

dlearFcn

ENUM

Integer

Status

colour	Red
title	YES

Refer to CyclicPrefix ENUM

3

cyclicPrefixUl

ulTransmissionBandwidth

ENUM

Status

colour	Red
title	YES

Refer to

CyclicPrefix ENUM

...

TransmissionBandwidth ENUM

4

ulearFcn

Integer

Status

colour	Red
title	YES

TDD Info

Contains information of the Sub FrameTDD Cell

#	Parameter	Data Type	Required?	Value Rules
1

additionalSpecialSubframePatterns

additionalSpecialSubframeExtensionInfo

ENUM

Object

Status

colour

Red

title
Green

YES

NO

Refer to Additional Special Subframe

ENUM

Extension Info

2

additionalSpecialSubframeInfo

Object

Status

colour	Green
title	NO

Refer to Additional Special Subframe Info

3

earFcn

Integer

Status

colour	Red
title	YES

4

specialSubframeInfo

Object

cyclicPrefixDl

ENUM

Status

colour	Red
title	YES

Refer

to CyclicPrefix ENUM3cyclicPrefixUl

to Special Subframe Info

5

subframeAssignment

ENUM

Status

colour	Red
title	YES

6

transmissionBandwidth

Refer to CyclicPrefix ENUM

ENUM

Status

colour	Red
title	YES

Additional Special Subframe Extension Info

Contains information of the Sub Frame

#	Parameter	Data Type	Required?	Value Rules
1

SpecialSubframePatterns

additionalSpecialSubframePatternsExtension

ENUM

Status

colour	Red
title	YES

Refer

to Special

to Additional Special Subframe Patterns ENUM

2

cyclicPrefixDl

ENUM

Status

colour	Red
title	YES

Refer

to CyclicPrefix

to CyclicPrefix ENUM

3

cyclicPrefixUl

ENUM

Status

colour	Red
title	YES

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

colour	Red
title	YES

Refer to Additional Special Subframe ENUM

2

radioframeAllocationPeriod

cyclicPrefixDl

ENUM

Status

colour	Red
title	YES

Refer to CyclicPrefix ENUM

3

subframeAllocation

cyclicPrefixUl

String

ENUM

Status

colour	Red
title	YES

4subframeAllocationTypeENUM

Status

colour	Red
title	YES

Neighbor Information

Refer to CyclicPrefix ENUM

Special Subframe Info

Contains information of the NeighborSub Frame

#	Parameter	Data Type	Required?	Value Rules
1

ecgi

SpecialSubframePatterns

String

ENUM

Status

colour	Red
title	YES

Refer to Special Subframe ENUM

2

pci

cyclicPrefixDl

Integer

ENUM

Status

colour	Red
title	YES

Refer to CyclicPrefix ENUM

3

earFcn

cyclicPrefixUl

Integer

ENUM

Status

colour	Red
title	YES

4

tac

String

Status

colour	Green
title	NO

Prach Configuration

Refer to CyclicPrefix ENUM

mbsfn Subframe

Contains information of the PrachSub Frame

Integer

#

Parameter

Data Type

Required?

Value Rules

1

highSpeedFlagradioframeAllocationOffset

BooleanInteger

Status

colour	Red
title	YES

2

prachConfigurationIndexradioframeAllocationPeriod

IntegerENUM

Status

colour	Red
title	YES

3

prachFrequencyOffsetsubframeAllocation

IntegerString

Status

colour	Red
title	YES

4

rootSequenceIndex

Integer

Status

colour	Green
title	NO

5

zeroCorrelationZoneConfiguration

subframeAllocationType

ENUM

Status

colour	Red
title	YES

...

Neighbor Information

Contains information of the gnodebNeighbor

#	Parameter	Data Type	Required?	Value Rules
1

servedNrCells

ecgi

Array of Object

String

Status

colour	Red
title	YES

Refer to served NR Cells object

2ranFunctionsArray of Object

2

pci

Integer

Status

colour	Red
title	YES

Refer to served RAN function object

Served NR Cells

Contains information of the GNB cell

#Parameter

Data Type

Required?Value Rules1

nrNeighbourInfos

Array of object


3	earFcn	Integer

Status

colour

Green

title
Red

NO

YES

Refer to NrNeighbourInformation object

4

2

tac

servedNrCellInformation

String

Object

Status

colour

Red

title
Green

YES

Refer to ServedNRCellInformation object

...

NO

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

colour	Red
title	YES

2

choiceNrMode

prachConfigurationIndex

Object

Integer

Status

colour	Red
title	YES

Refer to Choice NR Mode Object

3

configuredStac

prachFrequencyOffset

String

Integer

Status

colour

Green

title
Red

NO

YES

4

nrMode

rootSequenceIndex

ENUM

Integer

Status

colour

Red

title
Green

Yes

NO

Refer to NR Mode ENUM

5

nrPci

zeroCorrelationZoneConfiguration

Integer

Status

title
colour	Red

Yes6

stac5g

String

Status

colour	Green
title	NO

Served NR Cell Information

YES

Gnb

Contains information of the cellgnodeb

#	Parameter	Data Type	Required?	Value Rules
1

cellId

servedNrCells

String

Array of Object

Status

colour	Red
title	YES

Refer to served NR Cells object

2

choiceNrMode

ranFunctions

Array of Object

Status

colour	Red
title	YES

Refer

to Choice NR Mode Object3

configuredStac

String

Status

colour	Green
title	NO

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

title
Green

YES

NO

Refer

to NR Mode ENUM

to NrNeighbourInformation object
2	servedNrCellInformation	Object

5

nrPci

Integer

Status

colour	Red
title	YES

6

servedPlmns

Array of String

Status

colour	Red
title	YES

Array of PLMNs

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

#	Parameter	Data Type	Required?	Value Rules
1	nrCgi

7stac5g

String

Status

colour

Green

title
Red

NO

YES

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

...

2

choiceNrMode

Object

Status

colour	Red
title	YES

Refer to Choice NR Mode Object

3

configuredStac

String

Status

colour	Green
title	NO

4

nrMode

ENUM

Status

colour	Red
title	Yes

Refer to NR Mode ENUM

5

nrPci

Integer

Status


colour	Red
title	Yes

6

stac5g

String

Status

colour	Green
title	NO

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

colour	Red
title	YES

2

nrArFcn

choiceNrMode

integer

Object

Status

colour	Red
title	YES

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

colour	Green
title	NO

4

nrMode

ENUM

Status


colour	Red
title	YES

Refer to NR Mode ENUM

5

nrPci

Integer

#Parameter

Data Type

Required?Value Rules1

nrFrequencyBand

integer

Status

colour	Red
title	YES

2supportedSulBands

6

servedPlmns

Array of String

Status

colour	Red
title	YES

Array of

integer

PLMNs

7

stac5g

String

Status

colour	Green
title	NO

...

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	fdd

sulArFcn

integer

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

colour	Red
title	YES

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

colour	Red
title	YES

2

ranFunctionDefinition

supportedSulBands

String

Array of integer

Status

colour

Red

title
Green

YES3ranFunctionRevisionInteger

Status

colour	Red
title	YES

Setup Failure

NO

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

transmissionBandwidth

Integer

3

procedureCriticality

ENUM

Refer to Criticality ENUM

4

triggeringMessage

ENUM

Refer to TriggeringMessage ENUM

Information Element Criticality Diagnostics

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

colour	Red
title	YES

2

ieId

ranFunctionDefinition

String

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

Request Data Details

Integer

Status

colour	Red
title	YES

Setup Failure

Contains information of the error

#

Parameter

Location

#	Parameter

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:

1

cause_group

ENUM

Status

colour	Green
title	NO

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	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	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
accept	Header	String	YES	Refer to Standard API Request Headers
content-type	Header	String	YES	Refer to Standard API Request Headers
servedNrCells	Body	Array of Object	YES	Please refer to Served NR Cells array inside the gNB Object (In the Get NodeB Response)

Example:

Code Block

language	java
theme	Confluence

PUT http://localhost:3800/v1/nodeb/test1/update
accept: application/json
{
       "servedNrCells": [
      {
        "servedNrCellInformation": {
         "

Code Block

language	java
theme	Confluence

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"
          }
        ]
      }
    ]
}


          }
        ]
      }
    ]
}

Response Data Details

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

3. Insert ENB Request

Resource	Resource for this interface /v#/nodeb
Description	For storing new nodeb data to Redis, the client should send POST request
HTTP Method	POST
Supported Representation Formats	Request: Request Format ie application/json, none, etc Response: Response Format ie application/json, none, etc
Successful HTTP Response Code	201 CREATED

POST http://<serverBaseURL>/v#/nodeb/<ranName>/insertenb

Request Data Details

#	Parameter	Location	Data Type	Required?	Value Rules
1	accept	Header	String	YES	Refer to Standard API Request Headers
2	content-type	Header	String	YES	Refer to Standard API Request Headers
3	enbNode	Body	Object	YES	Please refer to ENB Node
4	servedCells	Body	Array of Object	YES	Please refer to Served Cells array inside the eNB Object (In the Get NodeB Response)

ENB Node

#	Parameter	Data Type	Required?	Value Rules
1	enbType	ENUM	YES
2	ranName	String	YES
3	globalNbId	Object	NO	Refer to object globalNbId
4	ip	String	NO
5	port	Integer	NO
6	guGroupIds	Array of String	NO

Example (TBD)

Response Data Details

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

4.

Reset nodeb

Update ENB Request

Resource

Resource for this interface

/v#

/nodeb/<ran name>/resetNote: 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

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

204 No Content

...

language	java
theme	Confluence

...

200 OK

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

...

<ranName>/updateenb

Request Data Details

...

#	Parameter	Location	Data Type	Required?

Description and colourRedtitle

Value Rules
1	accept	Header	String

Status

YES

Refer

to -

to Standard API Request Headers
2	content-type	Header	String

See above -

YES	Refer to Standard API Request Headers
3

cause

enbNode

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	java
theme	Confluence

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

Object	YES	Please refer to ENB Node
4	servedCells	Body	Array of Object	YES	Please refer to Served Cells array inside the eNB Object (In the Get NodeB Response)

Response Data Details

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

6

5

. 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

...

Code Block

language	java
theme	Confluence

PUT http://<serverBaseURL>/v#/nodeb/shutdown

Request Data Details

Listed below are the key elements included in the request.

...

Code Block

language	java
theme	Confluence

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

7. Get All NodeB States Request (Changed, Stretch Goal)

Resource	Resource for this interface /v#/nodeb/states
Description	E2 Manager is requested to get list of all RANs in its RNIB DB Note: In previous Release it was called Get All nodeb and its signature was different.
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

...

GET http://<serverBaseURL>/v#/nodeb/states

Request Data Details

Listed below are the key elements included in the request.

...

GET http://localhost:3800/v1/nodeb/states
accept: application/json

Response Data Details

In case 200 OK, this is the payload

...

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

6

8. Get NodeB State Request (New, Stretch Goal)

Resource	Resource for this interface /v#/nodeb/states/`<ran name>`
Description	E2 Manager is requested to get specific RAN - Health check
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

...

GET http://<serverBaseURL>/v#/nodeb/states/<ran name>

Request Data Details

Listed below are the key elements included in the request.

...

GET http://localhost:3800/v1/nodeb/states/<ran name>
accept: application/json

Response Data Details

In case 200 OK, this is the payload

#	Parameter	Location	Data Type	Required?	Value Rules
1	content-type	Header	String	YES
2	ran	Body	Object	YES	See nodebIdentity

7

9. RAN Health Check Request (New, Stretch Goal)

Resource	Resource for this interface /v#/nodeb/health
Description	E2 Manager is requested to Check connectivity with RANs (List) or all
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	202 Accepted

...

PUT http://<serverBaseURL>/v#/nodeb/health

Request Data Details

Listed below are the key elements included in the request.

...

PUT http://localhost:3800/v1/nodeb/health

accept: application/json

Response Data Details

202 Accepted or error.

8

10. 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

...

GET http://<serverBaseURL>/v#/e2t/list

Request Data Details

Listed below are the key elements included in the request.

...

GET http://localhost:3800/v1/e2t/list
accept: application/json

Response Data Details

In case 200 OK, this is the payload

...

Code Block

language	java
theme	Confluence

GET http://localhost:3800/v1/e2t/list
accept: application/json

[
    {
        "e2tAddress": "e2t.att.com:38000",
        "ranNames": ["test1","test2"]
    },
    {
        "e2tAddress": "e2t.att.com:38001",
        "ranNames": ["test1","test2","test3"]
    }
]

9

11. E2M Set Parameter (New)

Resource	Resource for this interface /v#/nodeb/parameters
Description	E2 Manager is requested to set some Parameter
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/parameters

Request Data Details

Listed below are the key elements included in the request.

...

PUT http://localhost:3800/v1/nodeb/parameters
accept: application/json

{ "parameters":

[ { "key": "enableRic", "value": "True" }]

}

Response Data Details

200 OK with the list of All parameters or error

...

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 7

New Version 8

Key

Reset nodeb Request (Deprecated)

Request Data Details

Response Data Details

1. Health Check Request

Request Data Details

Response Data Details

2. Get NodeB Request

Request Data Details

ENB

Response Data Details

Served Cells

ENB

Served Cells

Choice Eutra Mode

FDD Info

TDD Info

Choice Eutra Mode

FDD Info

TDD Info

Additional Special Subframe Extension Info

Additional Special Subframe Info

Neighbor Information

Special Subframe Info

Prach Configuration

mbsfn Subframe

Neighbor Information

Served NR Cells

Prach Configuration

Served NR Cell Information

Gnb

Served NR Cells

Nr Neighbour Information

Choice NR Mode

NR FDD Info

Served NR Cell Information

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

Frequency Bands

Choice NR Mode

NR FDD Info

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

Frequency Bands

Setup Failure

sul Information

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

NR TDD Info

Information Element Criticality Diagnostics

RAN Function

Request Data Details

Setup Failure

Example:

Criticality Diagnostics

Information Element Criticality Diagnostics

3. Update GNB Request

Request Data Details

Example:

Response Data Details

3. Insert ENB Request

Request Data Details

ENB Node

Response Data Details

4.

Update ENB Request

Request Data Details

Response Data Details

Response Data Details

6

. Shut Down Request

Request Data Details

Response Data Details

7. Get All NodeB States Request (Changed, Stretch Goal)

Request Data Details

Response Data Details

8. Get NodeB State Request (New, Stretch Goal)