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	404	500, 501	RAN Health Check	406	500, 501	Get All E2T	500, 501

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#/healthnodeb/<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

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
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 (Changed)

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

language	java
theme	Confluence

Code Block

language	java
theme	Confluence

GET http://localhost:3800<serverBaseURL>/v1v#/nodeb/NYC213123  
accept: application/json  
Content-Type: application/json

Response Data Details

<ranName>

Request Data Details

Listed below are the key elements included in the request.In case 200 OK, this is the payload

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

content-type

accept

Header

String

Status

colour	Red
title	YES

Refer to Standard API Request Headers

2

connectionStatus

content-type

Body

Header

ENUM

String

Status

colour	Red
title	YES

Refer to Standard API Request Headers

3

ip

ranIp

Body

String

Status

colour	Red
title	YES

IP of the RAN

4

port

ranPort

Body

Integer

Int

Status

colour	Red
title	YES

5nodeType

Port of the RAN
5	ranName	Body

ENUM

String

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	Location	Data Type	Required?	Value Rules
1	content-type	Header	String	6	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
Red

NO

Mandatory when the status is CONNECTED_SETUP_FAILED

9

setupFailure

Body

Object

YES

2

connectionStatus

Body

ENUM

Status

colour

Green

title
Red

NO

Mandatory when the status is CONNECTED_SETUP_FAILED

10

YES

3

ip

globalNbId

Body

Object

String

Status

colour

Green

Red
title	YES

NO

Mandatory when the status is CONNECTED.

Refer to object globalNbId

ENB

Contains information of the eNodeb

4

port

Body

Integer

Status

colour	Red
title	YES

5

nodeType

Body

#Parameter

Data Type

Required?Value Rules1enbType

ENUM

Status

colour	Red
title	YES

Refer to ENB Type ENUM

2

guGroupIds

Array of String

Status

colour	Green
title	NO

3

servedCells

Array of


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

YES4

choiceEutraMode

Object

Status

colour	Red
title	YES

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

NO

Mandatory when the status is CONNECTED.

Refer to object globalNbId

ENB

Contains information of the eNodeb

5

csgId

String

Status

colour	Green
title	NO

6

eutraMode

#	Parameter	Data Type	Required?	Value Rules
1	enbType

ENUM

Status

colour	Red
title	YES

Refer

to eutraMode

to ENB Type ENUM

7

2

freqBandIndicatorPriority

guGroupIds

ENUM8

mbmsServiceAreaIdentities

Array of String

Status

colour	Green
title	NO

Refer to freqBandIndicatorPriority ENUM


3	servedCells

Array of

String

Object

Status

colour

Green

Red
title	YES

Refer to served Cells object

Served Cells

Contains information of the cell

neighbourInfos ObjectGreenENUMGreenObject to tac Object

#

Parameter

Data Type

Required?

Value Rules

1

bandwidthReducedSi

ENUM

NO

9

mbsfnSubframeInfos

Array of Object

Status

colour	Green
title	NO

Refer to mbsfn Subframe Object

10

multibandInfos

Array of Integer

Status

colour	Green
title	NO

11

Refer to bandwidthReducedSi ENUM

2

broadcastPlmns

Array of

String

Status

colour

title
Red

NO

Refer to neighbour Information Object

12

numberOfAntennaPorts

YES

Array of PLMNs

3

cellId

String

Status

colour

title
Red

NO

YES

4

choiceEutraMode

Object

Refer to numberOfAntennaPorts ENUM

13

pci

Integer

Status

colour	Red
title	YES

14

prachConfiguration

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

5

csgId

String

Status

colour	Green
title	NO

Refer to prach Configuration Object

6

eutraMode

ENUM

15

Tac

String

Status

colour	Red
title	YES

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

colour	Green
title	NO

Refer to freqBandIndicatorPriority ENUM

8

mbmsServiceAreaIdentities

Array of String

Status

colour	Green
title	NO

9

mbsfnSubframeInfos

Array of Object

Status

colour	Green
title	NO

Refer to mbsfn Subframe Object

10

multibandInfos

Array of Integer

Status

colour	Green
title	NO

11

neighbourInfos

Array of Object

Status

colour	Green
title	NO

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

colour	Red
title	YES

Refer to TransmissionBandwidth ENUM

2

dlearFcn

Integer

Status

colour	Red
title	YES

3ulTransmissionBandwidth

ENUM

Status

colour

Red

title
Green

YES

NO

Refer to

TransmissionBandwidth

numberOfAntennaPorts ENUM

4

13

ulearFcn#Parameter

Data Type

Required?Value Rules1

additionalSpecialSubframeExtensionInfo

pci

Integer

Status

colour	Red
title	YES

TDD Info

Contains information of the TDD Cell


14	prachConfiguration

Object

Status

colour	Green
title	NO

Refer

to Additional Special Subframe Extension Info

to prach Configuration Object
15	Tac	String

2

additionalSpecialSubframeInfo

Object

Status

colour

Green

title
Red

NO

Refer to Additional Special Subframe Info

3

earFcn

Integer

Status

colour	Red
title	YES

4

specialSubframeInfo

Object

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

#

Parameter

Data Type

Required?

Value Rules

1

dlTransmissionBandwidth

ENUM

Status

colour	Red
title	YES

Refer to

Special Subframe Info

TransmissionBandwidth ENUM
2	dlearFcn	Integer

5

subframeAssignment

ENUM

Status

colour	Red
title	YES

6

3

transmissionBandwidth

ulTransmissionBandwidth

ENUM

Status

colour	Red
title	YES

...

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

additionalSpecialSubframePatternsExtension

additionalSpecialSubframeExtensionInfo

ENUM

Object

Status

colour

Red

title
Green

YES

NO

Refer to Additional Special Subframe

Patterns 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

2

cyclicPrefixDl

ENUM

Status

colour	Red
title	YES

Refer to

CyclicPrefix ENUM3cyclicPrefixUl

Special Subframe Info

5

subframeAssignment

ENUM

Status

colour	Red
title	YES

Refer to CyclicPrefix ENUM

6

transmissionBandwidth

ENUM

Status

colour	Red
title	YES

Additional Special Subframe Extension Info

Contains information of the Sub Frame

#	Parameter	Data Type	Required?	Value Rules
1

additionalSpecialSubframePatterns

additionalSpecialSubframePatternsExtension

ENUM

Status

colour	Red
title	YES

Refer 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 ENUM

Additional Special Subframe Info

Contains information of the Sub Frame

#

Parameter

Data Type

Required?

Value Rules

1

additionalSpecialSubframePatterns

ENUM

Status

colour	Red
title	YES

Refer to Additional Special Subframe ENUM

2

cyclicPrefixDl

ENUM

Status

colour	Red
title	YES

Refer to CyclicPrefix ENUM

3

cyclicPrefixUl

ENUM

Status

colour	Red
title	YES

Refer to CyclicPrefix ENUM

Special Subframe Info

...

#

Parameter

Data Type

Required?

Value Rules

1

servedNrCells

Array of Object

Status

colour	Red
title	YES

Refer to served NR Cells object

2

ranFunctions

Array of Object

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 Rules
1	nrFreqInfo	Object		Refer to nr Freq Info Object
2	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)

...

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

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)

...

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)

5. Get All NodeB

States

Request

(Changed, Stretch Goal)

Resource	Resource for this interface /v#/nodeb/statesids
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

HTTP Method	GET
Supported Representation Formats	Request: Request	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/statesids

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/states ids
accept: application/json

Response Data Details

In case 200 OK, this is the payload

...

#

Parameter

Data Type

Required?

Value Rules

1

inventoryName

String

Status

colour	Red
title	YES

Name of the RAN

2

globalNbId

Object

Status

colour	Red
title	YES

ID of the RAN - Refer globalNbId object

3

healthCheckTimestampSent

Long

Status

colour	Green
title	NO

The Unix epoch (The number of nanoseconds that have elapsed since January 1, 1970) when the Health Check (RIC Service Query) was sent

4

healthCheckTimestampReceived

Long

Status

colour	Green
title	NO

Timestamp (Unix epoch) when the Health Check (RIC Service Update) was received

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)

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

...

#

...

Parameter

...

Location

...

Data Type

...

Required?

...

Description and Value Rules

...

accept

...

Header

...

String

...

YES

...

Refer to - Standard API Request Headers

...

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

...

content-type

...

Header

...

String

...

YES

...

ran

...

Body

...

Object

...

YES

...

See nodebIdentity

...

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

Code Block

language	java
theme	Confluence

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

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

...

RANs

...

Body

...

Array of strings

...

Status

colour	Green
title	NO

...

Code Block

language	java
theme	Confluence

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

accept: application/json

Response Data Details

202 Accepted or error.

...

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

...

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

...

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

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

Response Data Details

Request Data Details

Response Data Details

ENB

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

Special Subframe Info

Served NR Cells

RAN Function

3. Update GNB

Request

Request Data Details

Response Data Details

Request Data Details

Response Data Details

5. Get All NodeB

Request

Request Data Details

Response Data Details

globalNbId

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

Request Data Details

Response Data Details

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

Request Data Details

Response Data Details

Reset nodeb Request (Deprecated)

Request Data Details

Response Data Details

6. Get All E2T Request

Request Data Details

Response Data Details