...
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/idsstates |
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 |
...
| language | java |
|---|---|
| theme | Confluence |
|
...
|
...
|
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 |
colour | Red | title | YES | Refer to - Standard API Request Headers |
...
...
|
...
|
...
|
...
|
...
Response Data Details
In case 200 OK, this is the payload
# | Parameter | Location | Data Type | Required? | Value Rules | ||||
|---|---|---|---|---|---|---|---|---|---|
| 1 | content-type | Header | String |
colour | Red | title | YES | ||
| 2 | rans | Body | List of Object Status | | |||||
| colour | Red | YES | Can be empty in case no RANs. See nodebIdentity |
...
Contains information of the eNodeb
# | 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 |
globalNbId
Contains information of the eNodeb
| 3 | 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 |
| 4 | healthCheckTimestampReceived | Long | NO | Timestamp (Unix epoch) when the Health Check (RIC Service Update) was received |
globalNbId
Contains information of the eNodeb
| # | Parameter | Data Type | ||
|---|---|---|---|---|
# | 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/ |
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 |
|
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 | YES | Refer to - Standard API Request Headers |
|
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. 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 |
|
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 | YES | Refer to - Standard API Request Headers |
| 2 | content-type | Header | String | See above - Standard API Request Headers | |
| 3 | RANs | Body | Array of strings | NO | Optional - Array of RANs name to check connectivity. If missing - All connected RANs. |
|
Response Data Details
202 Accepted or error.
8. 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
...