...
Revision History
R5 Release
Revision Description | Time | Swagger Ready |
---|---|---|
Adding new methods - Insert, Update and Delete ENB. Added Additional Cell Information for both eNB and gNB (in the Insert eNB Request, Update eNB) Changing the response of Get NodeB - adding more information to the Cell Object | TBD | |
Changing the end point of Update GNB. Adding more information to the Cell Object like Update eNB | TBD | |
Supporting E2M Set Parameter (New method) with Enable RIC parameter | May 2020 | Ready |
Get All NodeB States Request changed its End-Point URL Adding Connection Status in RAN object in Get All NodeB States Response | TBD | |
RAN Definition in the RAN List table turn to be Array of bytes (We don't decode the ASN.1) | June 2020 | Ready |
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. |
...
# | API | Resource After base URI | HTTP Verb | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| /v#/nodeb/x2-setup | POST | |||||||||
| /v#/nodeb/endc-setup | POST | |||||||||
/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/gnb/<ranName> | PUT | ||||||||
4 | Insert ENB Request | /v#/nodeb/enb | POST | ||||||||
5 | Update ENB Request | /v#/nodeb/enb/<ranName> | PUT | ||||||||
6 | Delete ENB Request | /v#/nodeb/enb/<ranName> | DELETE | ||||||||
7 | Shut Down Request | /v#/nodeb/shutdown | PUT | ||||||||
8 | Get All nodeb States Request (Changed, Stretch Goal)Request | /v#/nodeb/states | GET | ||||||||
9 | Get NodeB State Request (New, Stretch Goal) | /v#/nodeb/states/<ranName> | GET | 10 | RAN Health Check Request (New, Stretch Goal) | /v#/nodeb/health | PUT11 | Get All E2T Request | /v#/e2t/list | GET | |
1210 | E2M set parameters (New)parameters | /v#/nodeb/parameters | PUT |
Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb-reset/<ranName>.
...
In case 200 OK, the payload is identical to Get NodeB <RAN Name>.
4. Insert ENB Request(new) |
Resource | Resource for this interface - /v#/nodeb/ |
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 |
...
# | 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 | ranName | Body | String | YES | The Key to the RAN. Can't be Updated. | |||||
4 | globalNbId | Body | Object | YES | The Key to the RAN. Can't be Updated. Refer to object globalNbId | |||||
5 | enbNodeip | Body | Object | YES | Please refer to ENB Node | 6 | String | NO | ||
6 | port | Body | Integer | NO | ||||||
7 | enb | servedCellsBody | Array ofObject | YES | Please refer to | Served Cells array inside the eNB Object (In the Get NodeB Response)
ENB Node
...
#
...
Parameter
...
Data Type
...
Required?
...
Value Rules
ENB Object |
Example (TBD)
Response Data Details
In case 201 CREATED, the payload is identical to Get NodeB
...
enbType
...
ENUM
...
YES
...
ip
...
String
...
NO
...
port
...
Integer
...
NO
...
guGroupIds
...
Array of String
...
NO
Example (TBD)
Response Data Details
In case 201 CREATED, the payload is identical to Get NodeB <RAN Name>.
5. Update ENB Request (new) |
...
# | 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 | enbNodeenb | Body | Object | YES | Please refer to ENB Node | 4 | servedCells | Body | Array ofObject | 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>.
...
There is no Body in case 204 No Content, and with 202 Accepted with error details in case failure such as Routing Manager (511)
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 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 |
...
# | Parameter | Data Type | Required? | Value Rules |
---|---|---|---|---|
1 | inventoryName | String | YES | Name of the RAN |
2 | globalNbId | Object | YES | ID of the RAN - Refer globalNbId object |
3 | connectionStatus | ENUM | YES | Status of RAN |
4 | healthCheckTimestampSent | Long | NO | The Unix epoch (The number of nanoseconds that have elapsed since January 1, 1970) when the Health Check (RIC Service Query) was sent |
5 | healthCheckTimestampReceived | Long | 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
...
nbId
...
String
...
yes
...
ID of the RAN. Different ID for eNB or gNB. In case eNB it is according the eNB Type.
...
plmnId
...
String
...
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)
...
9. 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
...
10. 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
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 | String | 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)
9 |
|
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
...
content-type
...
Header
...
String
...
See above - Standard API Request Headers
...
RANs
...
Body
...
Array of strings
...
NO
...
|
Response Data Details
202 Accepted or error.
11. 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 |
...
|
Request Data Details
Listed below are the key elements included in the request.
...
|
Response Data Details
In case 200 OK, this is the payload
...
Code Block | ||||
---|---|---|---|---|
| ||||
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"] } ] |
1210. E2M Set Parameter |
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 |
...
|
Request Data Details
Listed below are the key elements included in the request.
...
{ "enableRic": true, } |
Response Data Details
200 OK with the list of All parameters or error
...