Versions Compared

Key

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

...

  • Adding RAN Function Definition object in RAN Function Object in gNB Object (Response of several methods)
  • Supporting E2M Set Parameter (New method) with Enable RIC parameter
  • Get All NodeB States Request changed its End-Point URL
  • Adding Connection Status in RAN object in Get All NodeB States RequestResponse

API Request Overview

Info

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

...

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

4. Insert ENB

Request  

Request (new)  


Resource

Resource for this interface - /v#/nodeb/<ranName>

Description

For storing new nodeb from eNB type  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

...

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

5. Update ENB

Request  

Request (new)

 


Resource

Resource for this interface - /v#/nodeb/<ranName>

Description

For Updating nodeb from eNB type 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

...

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

6. Delete ENB

Request  

Request  (New)


Resource

Resource for this interface - /v#/nodeb/<ranName>

Description

For Deleting nodeb from eNB type to Redis, the client should send DELETE request

HTTP Method

DELETE

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


DELETE http://<serverBaseURL>/v#/nodeb/<ranName>/enb

Request Data Details

#

Parameter

Location

Data Type

Required?

Value Rules

1acceptHeaderString

YES

Refer to Standard API Request Headers
2

content-type

Header

String

YES

Refer to Standard API Request Headers

3enbNodeBodyObjectYESPlease refer to ENB Node
4servedCellsBodyArray of ObjectYESPlease refer to Served Cells array inside the eNB Object (In the Get NodeB Response)

Response Data Details

In case success -  204 No Content

...

8. 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 End point 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

...

Code Block
languagejava
themeConfluence
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"]
    }
]



12. 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://localhost:3800/v1/nodeb/parameters
 accept: application/json

{

  "enableRic": true,

}


Response Data Details

200 OK with the list of All parameters or error


X2 Setup Request (Deprecated) 


ENDC Setup Request (Deprecated)


Reset nodeb Request  (Deprecated)