...
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | ranFunctionId | Integer |
| |||||||
| 2 | ranFunctionDefinition | Object |
| See Ran Function Definition | ||||||
| 3 | ranFunctionRevision | Integer |
|
Ran Function Definition
# | Parameter | Data Type | Required? | Value Rules | ||||||
1 | e2smGnbNrtRanFunctionDefinition | Object |
| See E2 SM GNB NRT Ran Function Definition |
E2 SM GNB NRT Ran Function Definition
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | ranFunctionName | Object |
| See Ran Function Name | ||||||
| 2 | ricEventTriggerStyles | Array of Object |
| See RIC Event Trigger Styles | ||||||
| 3 | ricReportStyles | Array of Object |
| See RIC Report Styles | ||||||
| 4 | ricInsertStyles | Array of Object |
| See RIC Insert Styles | ||||||
| 5 | ricControlStyles | Array of Object |
| See RIC Control Styles |
Ran Function Name
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | ranFunctionShortName | String |
| |||||||
| 2 | ranFunctionE2smOid | String |
| |||||||
| 3 | ranFunctionDescription | String |
| |||||||
| 4 | ranFunctionInstance | Integer |
|
RIC Event Trigger Styles
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | ricEventTriggerStyleType | Integer |
| |||||||
| 2 | ricEventTriggerStyleName | String |
| |||||||
| 3 | ricEventTriggerFormatType | Integer |
|
RIC Report Styles
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | ricReportStyleType | Integer |
| |||||||
| 2 | ricReportStyleName | String |
| |||||||
| 3 | ricReportActionFormatType | Integer |
| |||||||
| 4 | ricReportRanParameterDefs | Array of Object |
| See RIC Report RAN Parameter Defs | ||||||
| 5 | ricIndicationHeaderFormatType | Integer |
| |||||||
| 6 | ricIndicationMessageFormatType | Integer |
|
RIC Report RAN Parameter Defs
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | ranParameterId | Integer |
| |||||||
| 2 | ranParameterName | String |
| |||||||
| 3 | ranParameterType | ENUM |
| String or Integer |
RIC Insert Styles
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | ricInsertStyleType | Integer |
| |||||||
| 2 | ricInsertStyleName | String |
| |||||||
| 3 | ricInsertActionFormatType | Integer |
| |||||||
| 4 | ricInsertRanParameterDefs | Array of Object |
| See RIC Report RAN Parameter Defs | ||||||
| 5 | ricIndicationHeaderFormatType | Integer |
| |||||||
| 6 | ricIndicationMessageFormatType | Integer |
| |||||||
| 7 | ricCallProcessIdFormatType | Integer |
|
RIC Control Styles
| # | Parameter | Data Type | Required? | Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | ricControlStyleType | Integer |
| |||||||
| 2 | ricControlStyleName | String |
| |||||||
| 3 | ricControlHeaderFormatType | Integer |
| |||||||
| 4 | ricControlMessageFormatType | Integer |
| |||||||
| 5 | ricCallProcessIdFormatType | Integer |
|
Setup Failure
Contains information of the error
...
|
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) |
...
|
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) |
...
In case 200 OK, the payload is identical to Get NodeB <RAN Name>.
6. Delete ENB Request |
Resource | Resource for this interface - /v#/nodeb |
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 |
|
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 success - 204 No Content
7. 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 |
Request Data Details
Listed below are the key elements included in the request.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
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)
78. 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 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 |
...
|
Request Data Details
Listed below are the key elements included in the request.
...
|
Response Data Details
In case 200 OK, this is the payload
...
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 |
| 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
...
There is no Body in case 204 No Content, and with 202 Accepted with error details in case failure such as Routing Manager (511)
89. 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.
...
|
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 |
910. 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.
...
|
Response Data Details
202 Accepted or error.
1011. 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"]
}
]
|
1112. 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 |
...
|
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