...
HTTP 202 Accepted | HTTP Error 400 Bad Request | HTTP Error 404 Not Found | HTTP Error 500 Internal Server Error | HTTP Error 503 Service Unavailable | |
|---|---|---|---|---|---|
| Get nodeb data | 404 | 500, 501 | |||
Update GNB, Insert ENB, Update GNB | 401, 402 | 404 | 500, 501 | ||
| Shut Down | 405 | 500, 501, 502 | 511 | ||
| Get All nodeb | 500, 501 | ||||
| Get All E2T | 500, 501 | ||||
| E2M Set Parameters | 401 |
...
|
Response Data Details
There is no Body in case 204 No Content, and with error details in case failure
...
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 | ||||
|---|---|---|---|---|
| ||||
GET http://<serverBaseURL>/v#/nodeb/<ranName> |
...
In case 200 OK, the payload is identical to Get NodeB <RAN Name>.
4. Insert ENB Request |
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 |
|
Request Data Details
# | 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 | enbNode | Body | Object | YES | Please refer to ENB Node |
| 4 | servedCells | Body | Array of Object | YES | Please refer to Served Cells array inside the eNB Object (In the Get NodeB Response) |
ENB Node
# | Parameter | Data Type | Required? | Value Rules |
|---|---|---|---|---|
| 1 | enbType | ENUM | YES | |
| 2 | ranName | String | YES | |
| 3 | globalNbId | Object | NO | Refer to object globalNbId |
| 4 | ip | String | NO | |
| 5 | port | Integer | NO | |
| 6 | 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 |
Resource |
Resource for this interface |
- /v#/nodeb | |
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 |
|
Request Data Details
# | 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 | enbNode | Body | Object | YES | Please refer to ENB Node |
| 4 | servedCells | Body | Array of Object | 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>.
6. Shut Down Request |
Resource |
Resource for this interface |
- /v#/nodeb | |
Description | E2 Manager is requested to Shut Down all the RANs |
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 | ||||
|---|---|---|---|---|
| ||||
PUT http://<serverBaseURL>/v#/nodeb/shutdown |
...
{ "parameters": [ { "key": "enableRic", "value": "True" true }] } |
Response Data Details
200 OK with the list of All parameters or error
...