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 (Changed)	/v#/nodeb/<ranName>	GET
3	Update GNB Request (New)	/v#/nodeb/<ranName>/update	PUT
4	Shut Down Request	/v#/nodeb/shutdown	PUT
5	Get All nodeb States Request (Changed, Stretch Goal)	/v#/nodeb/statesids	GET
6	Get NodeB State Request (New, Stretch Goal)	/v#/nodeb/states/<ranName>	GET
7	RAN Health Check Request (New, Stretch Goal)	/v#/nodeb/health	PUT
~~Reset nodeb Request~~ (deprecated)	/v#/nodeb/<ranName>/reset *	PUT	8	Get All E2T Request	/v#/e2t/list	GET

...

NodeB State

	HTTP 202 Accepted	HTTP Error 400 Bad Request	HTTP Error 404 Not Found	HTTP Error 500 Internal Server Error
Get nodeb data			404	500, 501
Update GNB		401, 402	404	500, 501
Shut Down	511	405		500, 501, 502
Get All nodeb Statesnodeb				500, 501
Get	All E2T	404			500, 501	RAN Health Check	406	500, 501	Get All E2T	500, 501

In addition, there are In addition, there are 2 Basic HTTP error happens before the handlers are calling:

...

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

language	java
theme	Confluence

GETPUT http://<serverBaseURL>/v#/health

Request Data Details

/nodeb/<ran name>/reset
(See remark above about changing the Endpoint)

Request Data Details

Listed below are the 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 Headers

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

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

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

to Standard API Request Headers

2

Code Block

...

language

...

java

...

theme

...

Status

colour	Red
title	YES

...

Refer to Standard API Request Headers

...

ranIp

...

Body

...

String

...

Status

colour	Red
title	YES

...

IP of the RAN

...

ranPort

...

Body

...

Int

...

Status

colour	Red
title	YES

...

Port of the RAN

...

ranName

...

Body

...

String

...

Status

colour	Red
title	YES

...

Name of the RAN

Confluence

GET http://localhost:3800/v1/health

Code Block

language	java
theme	Confluence

GET http://localhost:3800/v1/nodeb/NYC213123  
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 TypeRequired?Value Rules1

content-type

Header

String

Status

colour	Red
title	YES

2

connectionStatus

Body

ENUM

Status

#

Parameter

Location

Data Type

Required?

Description and Value Rules

1

accept

Header

String

Status

colour	Red
title	YES

Refer to Standard API Request Headers

2

content-type

Header

3

ip

Body

String

Status

colour	Red
title	YES

4port

Refer to Standard API Request Headers
3	ranIp	Body

Integer

String

Status

colour	Red
title	YES

5nodeType

IP of the RAN
4	ranPort	Body

ENUM

Int

Status

colour	Red
title	YES

6

Port of the RAN
5	ranName	Body	String

7

enb (or gnb)

Body

Object

Status

colour

Green

title
Red

NO

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

ObjectGreen

#

Parameter

Location

Data Type

Required?

Value Rules

1

content-type

Header

String

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

Status

colour

Red
title	YES

NO

2

connectionStatus

Body

ENUM

Mandatory when the status is CONNECTED_SETUP_FAILED

10

globalNbId

Body

Object

Status

colour

Green

Red
title	YES

NO

Mandatory when the status is CONNECTED.

Refer to object globalNbId

ENB

Contains information of the eNodeb

3

ip

Body

String

Status

colour	Red
title	YES

4

port

Body

Integer

#Parameter

Data Type

Required?Value Rules1

enbType

ENUM

Status

colour	Red
title	YES

Refer to ENB Type ENUM

2

guGroupIds

Array of String

5

nodeType

Body

ENUM

Status

colour

GreenArray of

title
Red

NO3

servedCells

	YES

6

ranName

Body

String

7

enb (or gnb)

Body

Object

Status

colour

Red

title
Green

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

colour	Green
title	NO

Refer to bandwidthReducedSi ENUM

2

broadcastPlmns

Array of String

Mandatory when the status is CONNECTED_SETUP_FAILED

9

setupFailure

Body

Object

Status

colour

Red

title
Green

YES

	NO

Mandatory when the status is CONNECTED_SETUP_FAILED

10

globalNbId

Body

Object

Array of PLMNs

3

cellId

String

Status

colour

Red

title
Green

YES

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

ENUM

Status

colour	Red
title	YES

Refer to ENB Type ENUM

2

guGroupIds

Array of

4

choiceEutraMode

Object

Status

colour	Red
title	YES

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

5

csgId

String

Status

colour	Green
title	NO

6

3

eutraMode

servedCells

ENUM

Array of Object

Status

colour	Red
title	YES

Refer to served Cells object

Served Cells

Contains information of the cell

to eutraMode ENUMArray of IntegerGreenArray of ObjectnumberOfAntennaPorts to numberOfAntennaPorts 13pciIntegerRedYES14prachConfiguration to prach Configuration

#

Parameter

Data Type

Required?

Value Rules

1

bandwidthReducedSi

7

freqBandIndicatorPriority

ENUM

Status

colour	Green
title	NO

Refer to freqBandIndicatorPriority to bandwidthReducedSi ENUM

82

mbmsServiceAreaIdentitiesbroadcastPlmns

Array of String

Status

colour	GreenRed
title	YESNO

Array of PLMNs

93

mbsfnSubframeInfoscellId

Array of ObjectString

Status

colour	GreenRed
title	NO

Refer to mbsfn Subframe Object

10

multibandInfos

YES

4

choiceEutraMode

Object

Status

colour

title
Red

NO

11

neighbourInfos

YES

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

5

csgId

String

Status

colour	Green
title	NO

Refer to neighbour Information Object

12

6

eutraMode

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

title
Green

NO

9

mbsfnSubframeInfos

Array of Object

Status

colour	Green
title	NO

Refer

to mbsfn Subframe Object

1510

TacmultibandInfosString

Array of Integer

Status

colour	RedGreen
title	YESNO

Refer to tac Object

Choice Eutra Mode

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

11

neighbourInfos

Array of Object

Status

colour	Green
title	NO

Refer to neighbour Information Object

12

numberOfAntennaPorts

ENUM

Status

colour	Green
title	NO

Refer to numberOfAntennaPorts ENUM

13

pci

Integer

Status

colour	Red
title	YES

14

prachConfiguration

Object

Status

colour	Green
title	NO

Refer to prach Configuration Object

15

Tac

String

Status

colour	Red
title	YES

Refer to tac Object

Choice Eutra Mode

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

#	Parameter	Data	#	Parameter	Data Type	Required?	Value Rules
1	fdd	Object		Refer to FDD Info
2	tdd	Object		Refer to TDD Info

...

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)

...

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

...

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)

...

Code Block

language	java
theme	Confluence

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

Request Data Details

Listed below are the key elements included in the request.

...

Code Block

language	java
theme	Confluence

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

Response Data Details

In case 200 OK, this is the payload

...

#	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)

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

language	java
theme	Confluence

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.

...

Location

...

accept

...

Header

...

String

...

Status

colour	Red
title	YES

...

Refer to - Standard API Request Headers

...

content-type

...

Header

...

String

...

See above - Standard API Request Headers

...

cause

...

Body

...

String

...

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

8

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

...

Show all results

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Reset nodeb Request (Deprecated)

Request Data Details

Request Data Details

Response Data Details

1. Health Check Request

Request Data Details

Response Data Details

2. Get NodeB Request

Request Data Details

Response Data Details

ENB

Served Cells

ENB

Served Cells

Choice Eutra Mode

Choice Eutra Mode

Request Data Details

Response Data Details

Request Data Details

Response Data Details

Request Data Details

Response Data Details

Reset nodeb Request (Deprecated)

Request Data Details

Response Data Details

6. Get All E2T Request