...
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 |
NO
NO
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
...
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)
...
8. 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
...
9. 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
...
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.
...
10. 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
...
GET http://<serverBaseURL>/v#/e2t/list
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/e2t/list 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
...
Body
...
List of Object
...
YES
...
Can be empty in case no E2T. See e2tIdentity
e2tIdentity
Contains information of the E2T instance
...
#
...
Parameter
...
Data Type
...
Required?
...
Value Rules
...
e2tAddress
...
String
...
yes
...
Address of the E2T Instance
...
ranNames
...
List of string
...
no
...
List of the RAN Names associated with this Instance. Can be empty
| 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"]
}
]
|
...
11. 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://<serverBaseURL>/v#/nodeb/parameters
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
...
Parameters
...
Object
...
Object
...
YES
...
parameter
Contains information of the eNodeb. At least one parameter must exist in this Object
...
True meaning - Future Setup from RAN will be supported
False meaning - Future Setup from RAN will be rejected
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
...
| Status | ||
|---|---|---|
|
...
...
+972-54-2891166, ab600d@intl.att.com
| Table of Contents | ||
|---|---|---|
|
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. |
Standard API Request Headers
Approved Standard Headers are documented at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
...
Required?
...
| Status | ||||
|---|---|---|---|---|
|
...
Specifies the format of the response message body.
...
| Status | ||||
|---|---|---|---|---|
|
...
RESTful Web Services Interface Specification
...
X2 Setup Request Message Request (deprecated)
...
/v#/nodeb/x2-setup
...
POST
...
ENDC Setup Request Message Request
...
/v#/nodeb/endc-setup
...
POST
...
Health Check Request
...
/v#/health
...
GET
...
Get nodeb data Request
...
/v#/nodeb/<ranName>
...
GET
...
Shut Down Request
...
/v#/nodeb/shutdown
...
PUT
...
Get All nodeb States Request (Changed, Stretch Goal)
...
/v#/nodeb/states
...
Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb-reset/<ranName>.
Error Handling
Note that, in some scenarios, Client may receive error responses that originate from the network layers. The content of these responses will not conform to the exception schema specified here.
...
Required?
...
errorCode
...
| Status | ||||
|---|---|---|---|---|
|
...
Code which identifies the error
...
errorMessage
...
| Status | ||||
|---|---|---|---|---|
|
...
Human readable text
Error Example:
| Code Block | ||
|---|---|---|
| ||
{
"errorCode": 402,
"errorMessage": “Mandatory fields are missing”
} |
Here is the list of HTTP status code:
...
Currently there is connectivity to the Routing Manager. E2M will try later.
...
404 Not Found
...
500 Internal Server Error
...
Here is the list of HTTP status code and list of the error codes for our APIs:
...
HTTP
202 Accepted
...
HTTP Error
400 Bad Request
...
HTTP Error
404 Not Found
...
HTTP Error
500 Internal Server Error
...
HTTP Error
503 Service Unavailable
...
Update GNB,
Insert ENB,
Update GNB
...
In addition, there are 2 Basic HTTP error happens before the handlers are calling:
- HTTP Error 404 Not Found (Body is empty) - The Resource name isn't found (e.g.: Call /v#/nodec instead of /v#/nodeb)
- HTTP Error 405 Method Not Allowed (Body is empty) - Wrong HTTP VERB to known resource name *e.g.: Call HTTP GET v#/nodeb/x2-setup)
Table 1 – Common Type, Enum values
...
UNKNOWN_CONNECTION_STATUS = 0;
CONNECTED = 1;
DISCONNECTED = 2;
CONNECTED_SETUP_FAILED = 3;
CONNECTING = 4;
SHUTTING_DOWN = 5;
SHUT_DOWN = 6;
...
Node Type
...
UNKNOWN = 0;
HANDOVER_DESIRABLE_FOR_RADIO_REASONS = 1;
TIME_CRITICAL_HANDOVER = 2;
RESOURCE_OPTIMISATION_HANDOVER = 3;
REDUCE_LOAD_IN_SERVING_CELL = 4;
PARTIAL_HANDOVER = 5;
UNKNOWN_NEW_ENB_UE_X2AP_ID = 6;
UNKNOWN_OLD_ENBME_UE_X2AP_ID = 7;
UNKNOWN_PAIR_OF_UE_X2AP_ID = 8;
HO_TARGET_NOT_ALLOWED = 9;
TX2_RELOC_OVERALL_EXPIRY = 10;
T_RELOC_PREP_EXPIRY = 11;
CELL_NOT_AVAILABLE = 12;
NO_RADIO_RESOURCES_AVAILABLE_IN_TARGET_CELL = 13;
INVALID_MME_GROUP_ID = 14;
UNKNOWN_MME_CODE = 15;
ENCRYPTION_INTEGRITY_PROTECTION_ALGORITHMS_NOT_SUPPORTED = 16;
REPORT_CHARACTERISTICS_EMPTY = 17;
NO_REPORT_PERIODICITY = 18;
EXISTING_MEASUREMENT_ID = 19;
UNKNOWN_ENB_MEASUREMENT_ID = 20;
MEASUREMENT_TEMPORARILY_NOT_AVAILABLE = 21;
UNSPECIFIED = 22;
LOAD_BALANCING = 23;
HANDOVER_OPTIMISATION = 24;
VALUE_OUT_OF_ALLOWED_RANGE = 25;
MULTIPLE_E_RAB_ID_INSTANCES = 26;
SWITCH_OFF_ONGOING = 27;
NOT_SUPPORTED_QCI_VALUE = 28;
MEASUREMENT_NOT_SUPPORTED_FOR_THE_OBJECT = 29;
TDC_OVERALL_EXPIRY = 30;
TDC_PREP_EXPIRY = 31;
ACTION_DESIRABLE_FOR_RADIO_REASONS = 32;
REDUCE_LOAD = 33;
RESOURCE_OPTIMISATION = 34;
TIME_CRITICAL_ACTION = 35;
TARGET_NOT_ALLOWED = 36;
NO_RADIO_RESOURCES_AVAILABLE = 37;
INVALID_QOS_COMBINATION = 38;
ENCRYPTION_ALGORITHMS_NOT_SUPPORTED = 39;
PROCEDURE_CANCELLED = 40;
RRM_PURPOSE = 41;
IMPROVE_USER_BIT_RATE = 42;
USER_INACTIVITY = 43;
RADIO_CONNECTION_WITH_UE_LOST = 44;
FAILURE_IN_THE_RADIO_INTERFACE_PROCEDURE = 45;
BEARER_OPTION_NOT_SUPPORTED = 46;
MCG_MOBILITY = 47;
SCG_MOBILITY = 48;
COUNT_REACHES_MAX_VALUE = 49;
UNKNOWN_OLD_EN_GNB_UE_X2AP_ID = 50;
PDCP_OVERLOAD = 51;
...
UNKNOWN = 0;
TRANSPORT_RESOURCE_UNAVAILABLE = 1;
UNSPECIFIED = 2;
...
UNKNOWN = 0;
TRANSFER_SYNTAX_ERROR = 1;
ABSTRACT_SYNTAX_ERROR_REJECT = 2;
ABSTRACT_SYNTAX_ERROR_IGNORE_AND_NOTIFY = 3;
MESSAGE_NOT_COMPATIBLE_WITH_RECEIVER_STATE = 4;
SEMANTIC_ERROR = 5;
UNSPECIFIED = 6;
ABSTRACT_SYNTAX_ERROR_FALSELY_CONSTRUCTED_MESSAGE = 7;
...
UNKNOWN = 0;
CONTROL_PROCESSING_OVERLOAD = 1;
HARDWARE_FAILURE = 2;
OM_INTERVENTION = 3;
NOT_ENOUGH_USER_PLANE_PROCESSING_RESOURCES = 4;
UNSPECIFIED = 5;
...
UNKNOWN_TIMEOUT = 0;
V1S = 1;
V2S = 2;
V5S = 3;
V10S = 4;
V20S = 5;
V60S = 6;
...
UNKNOWN_ERROR = 0;
NOT_UNDERSTOOD = 1;
MISSING = 2;
...
UNKNOWN_MESSAGE = 0;
INITIATING_MESSAGE = 1;
SUCCESSFUL_OUTCOME = 2;
UNSUCCESSFUL_OUTCOME = 3;
...
UNKNOWN_CRITICALITY = 0;
REJECT = 1;
IGNORE = 2;
NOTIFY = 3;
...
UNKNOWN_BANDWIDTH_REDUCED_SI = 0;
SCHEDULED = 1;
...
Eutra Mode / Nr Mode
...
UNKNOWN = 0;
FDD = 1;
TDD = 2;
...
UNKNOWN_FREQ_BAND_INDICATOR_PRIORITY = 0;
NOT_BROADCASTED = 1;
BROADCASTED = 2;
...
UNKNOWN_NUMBER_OF_ANTENNA_PORTS = 0;
AN1 = 1;
AN2 = 2;
AN4 = 3;
...
UNKNOWN_TRANSMISSION_BANDWIDTH = 0;
BW6 = 1;
BW15 = 2;
BW25 = 3;
BW50 = 4;
BW75 = 5;
BW100 = 6;
BW1 = 7;
...
UNKNOWN_SUBFRAME_ALLOCATION_TYPE = 0;
ONE_FRAME = 1;
FOUR_FRAME = 2;
...
UNKNOWN_RADIOFRAME_ALLOCATION_PERIOD = 0;
N1 = 1;
N2 = 2;
N4 = 3;
N8 = 4;
N16 = 5;
N32 = 6;
...
UNKNOWN_ENB_TYPE = 0;
MACRO_ENB = 1;
HOME_ENB = 2;
SHORT_MACRO_ENB = 3;
LONG_MACRO_ENB = 4;
...
UNKNOWN = 0;
SSP0 = 1;
SSP1 = 2;
SSP2 = 3;
SSP3 = 4;
SSP4 = 5;
SSP5 = 6;
SSP6 = 7;
SSP7 = 8;
SSP8 = 9;
SSP9 = 10;
...
UNKNOWN = 0;
SSP0 = 1;
SSP1 = 2;
SSP2 = 3;
SSP3 = 4;
SSP4 = 5;
SSP5 = 6;
SSP6 = 7;
SSP7 = 8;
SSP8 = 9;
...
UNKNOWN_SUBFRAME_ASSIGNMENT = 0;
SA0 = 1;
SA1 = 2;
SA2 = 3;
SA3 = 4;
SA4 = 5;
SA5 = 6;
SA6 = 7;
...
UNKNOWN_CYCLIC_PREFIX = 0;
NORMAL = 1;
EXTENDED = 2;
...
UNKNOWN = 0;
SSP10 = 1
...
UNKNOWN_NRSCS = 0;
SCS15 = 1;
SCS30 = 2;
SCS60 = 3;
SCS120 = 4;
...
UNKNOWN_NCNRB = 0;
NRB11 =1;
NRB18 =2;
NRB24 =3;
NRB25 =4;
NRB31 =5;
NRB32 =6;
NRB38 =7;
NRB51 =8;
NRB52 =9;
NRB65 =10;
NRB66 =11;
NRB78 =12;
NRB79 =13;
NRB93 =14;
NRB106 =15;
NRB107 =16;
NRB121 =17;
NRB132 =18;
NRB133 =19;
NRB135 =20;
NRB160 =21;
NRB162 =22;
NRB189 =23;
NRB216 =24;
NRB217 =25;
NRB245 =26;
NRB264 =27;
NRB270 =28;
NRB273 =29;
...
misc:control-processing-overload,
misc:hardware-failure,
misc:om-intervention,
misc:not-enough-user-plane-processing-resources,
misc:unspecified
protocol:transfer-syntax-error,
protocol:abstract-syntax-error-reject,
protocol:abstract-syntax-error-ignore-and-notify,
protocol:message-not-compatible-with-receiver-state,
protocol:semantic-error,
protocol:unspecified,
protocol:abstract-syntax-error-falsely-constructed-message
transport:transport-resource-unavailable
radioNetwork:handover-desirable-for-radio-reasons,
radioNetwork:time-critical-handover,
radioNetwork:resource-optimisation-handover,
radioNetwork:reduce-load-in-serving-cell,
radioNetwork:partial-handover,
radioNetwork:unknown-new-eNB-UE-X2AP-ID,
radioNetwork:unknown-old-eNB-UE-X2AP-ID,
radioNetwork:unknown-pair-of-UE-X2AP-ID,
radioNetwork:ho-target-not-allowed,
radioNetwork:tx2relocoverall-expiry,
radioNetwork:trelocprep-expiry,
radioNetwork:cell-not-available,
radioNetwork:no-radio-resources-available-in-target-cell,
radioNetwork:invalid-MME-GroupID,
radioNetwork:unknown-MME-Code,
radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
radioNetwork:reportCharacteristicsEmpty,
radioNetwork:noReportPeriodicity,
radioNetwork:existingMeasurementID,
radioNetwork:unknown-eNB-Measurement-ID,
radioNetwork:measurement-temporarily-not-available,
radioNetwork:unspecified,
radioNetwork:load-balancing,
radioNetwork:handover-optimisation,
radioNetwork:value-out-of-allowed-range,
radioNetwork:multiple-E-RAB-ID-instances,
radioNetwork:switch-off-ongoing,
radioNetwork:not-supported-QCI-value,
radioNetwork:measurement-not-supported-for-the-object,
radioNetwork:tDCoverall-expiry,
radioNetwork:tDCprep-expiry,
radioNetwork:action-desirable-for-radio-reasons,
radioNetwork:reduce-load,
radioNetwork:resource-optimisation,
radioNetwork:time-critical-action,
radioNetwork:target-not-allowed,
radioNetwork:no-radio-resources-available,
radioNetwork:invalid-QoS-combination,
radioNetwork:encryption-algorithms-not-aupported,
radioNetwork:procedure-cancelled,
radioNetwork:rRM-purpose,
radioNetwork:improve-user-bit-rate,
radioNetwork:user-inactivity,
radioNetwork:radio-connection-with-UE-lost,
radioNetwork:failure-in-the-radio-interface-procedure,
radioNetwork:bearer-option-not-supported,
radioNetwork:mCG-Mobility,
radioNetwork:sCG-Mobility,
radioNetwork:count-reaches-max-value,
radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
radioNetwork:pDCP-Overload
...
X2 Setup Request (Deprecated)
...
Resource
...
Resource for this interface
/v#/nodeb
...
Description
...
E2 Manager exchange with this eNodeb RAN Setup Request and Response.
...
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
...
204 No Content
| Code Block | ||||
|---|---|---|---|---|
| ||||
POST http://<serverBaseURL>/v#/nodeb/x2-setup |
Request Data Details
Listed below are the key elements included in the request.
...
Location
...
accept
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Standard API Request Headers
...
content-type
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Standard API Request Headers
...
ranIp
...
Body
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
IP of the RAN
...
ranPort
...
Body
...
Int
...
| Status | ||||
|---|---|---|---|---|
|
...
Port of the RAN
...
ranName
...
Body
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Name of the RAN
| Code Block | ||||
|---|---|---|---|---|
| ||||
POST http://localhost:3800/v1/nodeb/x2-setup
accept: application/json
content-Type: application/json
{
"ranIp":"10.0.2.15",
"ranPort":5577,
"ranName": "test1"
} |
Response Data Details
The body is empty in case 204 No Content, and with specific HTTP code and error details in case failure
...
ENDC Setup Request (Deprecated)
...
Resource
...
Resource for this interface
/v#/nodeb
...
Description
...
E2 Manager exchange with this gNodeb RAN Setup Request and Response.
...
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
...
204 No Content
| Code Block | ||||
|---|---|---|---|---|
| ||||
POST http://<serverBaseURL>/v#/nodeb/endc-setup |
Request Data Details
Listed below are the key elements included in the request.
...
Location
...
accept
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Standard API Request Headers
...
content-type
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Standard API Request Headers
...
ranIp
...
Body
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
IP of the RAN
...
ranPort
...
Body
...
Int
...
| Status | ||||
|---|---|---|---|---|
|
...
Port of the RAN
...
ranName
...
Body
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Name of the RAN
| Code Block | ||||
|---|---|---|---|---|
| ||||
POST http://localhost:3800/v1/nodeb/endc-setup
accept: application/json
content-Type: application/json
{
"ranIp":"10.0.2.15",
"ranPort":5577,
"ranName": "test1"
} |
Response Data Details
The body is empty in case 204 No Content, and with specific HTTP code and error details in case failure
...
Reset nodeb Request (Deprecated)
...
Resource
...
Resource for this interface
/v#/nodeb/<ran name>/reset
Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb/<ran name>/reset
...
Description
...
E2 Manager is requested to Reset specific RAN
...
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
|
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
...
cause
...
Body
...
String
...
Note: Due to router problem we change the Endpoint of Reset nodeb to /v1/nodeb/<ranName>/reset.
...
PUT http://localhost:3800/v1/nodeb/NYC213123/reset
accept: application/json
{
"cause": “misc:om-intervention”
}
Response Data Details
There is no Body in case 204 No Content, and with error details in case failure
...
1. Health Check Request
...
Resource
...
Resource for this interface
/v#/health
...
Description
...
For simple health check the client should send GET request to /health endpoint. If client receives 200OK it means the server is up and running
...
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#/health |
Request Data Details
Listed below are the key elements included in the request.
...
Location
...
accept
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Standard API Request Headers
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://localhost:3800/v1/health
accept: application/json |
Response Data Details
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> |
Request Data Details
Listed below are the key elements included in the request.
...
Location
...
accept
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Standard API Request Headers
...
content-type
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Standard API Request Headers
...
ranIp
...
Body
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
IP of the RAN
...
ranPort
...
Body
...
Int
...
| Status | ||||
|---|---|---|---|---|
|
...
Port of the RAN
...
ranName
...
Body
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Name of the RAN
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://localhost:3800/v1/nodeb/NYC213123
accept: application/json
Content-Type: application/json |
Response Data Details
In case 200 OK, this is the payload
...
Location
...
content-type
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
connectionStatus
...
Body
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
ip
...
Body
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
port
...
Body
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
nodeType
...
Body
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
ranName
...
Body
...
String
...
enb (or gnb)
...
Body
...
Object
| Status | ||||
|---|---|---|---|---|
|
...
According the nodetype – ENB or GNB
Mandatory when the status is CONNECTED
...
failureType
...
Body
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Mandatory when the status is CONNECTED_SETUP_FAILED
...
setupFailure
...
Body
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Mandatory when the status is CONNECTED_SETUP_FAILED
...
| Status | ||||
|---|---|---|---|---|
|
...
Mandatory when the status is CONNECTED.
Refer to object globalNbId
ENB
Contains information of the eNodeb
...
Data Type
...
enbType
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to ENB Type ENUM
...
guGroupIds
...
Array of String
...
| Status | ||||
|---|---|---|---|---|
|
...
servedCells
...
Array of Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to served Cells object
Served Cells
Contains information of the cell
...
Data Type
...
bandwidthReducedSi
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to bandwidthReducedSi ENUM
...
broadcastPlmns
...
Array of String
...
| Status | ||||
|---|---|---|---|---|
|
...
Array of PLMNs
...
cellId
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
choiceEutraMode
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to choice Eutra Mode Object. One of them must appear
...
csgId
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
eutraMode
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to eutraMode ENUM
...
freqBandIndicatorPriority
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to freqBandIndicatorPriority ENUM
...
mbmsServiceAreaIdentities
...
Array of String
...
| Status | ||||
|---|---|---|---|---|
|
...
mbsfnSubframeInfos
...
Array of Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to mbsfn Subframe Object
...
multibandInfos
...
Array of Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
neighbourInfos
...
Array of Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to neighbour Information Object
...
numberOfAntennaPorts
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to numberOfAntennaPorts ENUM
...
pci
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
prachConfiguration
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to prach Configuration Object
...
Tac
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to tac Object
Choice Eutra Mode
Contains information of the Cell – It is either FDD or TDD - Only one should exist
...
Data Type
...
fdd
...
Object
...
Refer to FDD Info
...
tdd
...
Object
...
Refer to TDD Info
FDD Info
Contains information of the FDD Cell
...
Data Type
...
dlTransmissionBandwidth
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to TransmissionBandwidth ENUM
...
dlearFcn
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
ulTransmissionBandwidth
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to TransmissionBandwidth ENUM
...
ulearFcn
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
TDD Info
Contains information of the TDD Cell
...
Data Type
...
additionalSpecialSubframeExtensionInfo
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Additional Special Subframe Extension Info
...
additionalSpecialSubframeInfo
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Additional Special Subframe Info
...
earFcn
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
specialSubframeInfo
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Special Subframe Info
...
subframeAssignment
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
transmissionBandwidth
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
Additional Special Subframe Extension Info
Contains information of the Sub Frame
...
Data Type
...
additionalSpecialSubframePatternsExtension
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Additional Special Subframe Patterns ENUM
...
cyclicPrefixDl
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to CyclicPrefix ENUM
...
cyclicPrefixUl
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to CyclicPrefix ENUM
Additional Special Subframe Info
Contains information of the Sub Frame
...
Data Type
...
additionalSpecialSubframePatterns
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Additional Special Subframe ENUM
...
cyclicPrefixDl
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to CyclicPrefix ENUM
...
cyclicPrefixUl
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to CyclicPrefix ENUM
Special Subframe Info
Contains information of the Sub Frame
...
Data Type
...
SpecialSubframePatterns
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Special Subframe ENUM
...
cyclicPrefixDl
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to CyclicPrefix ENUM
...
cyclicPrefixUl
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to CyclicPrefix ENUM
mbsfn Subframe
Contains information of the Sub Frame
...
Data Type
...
radioframeAllocationOffset
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
radioframeAllocationPeriod
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
subframeAllocation
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
Neighbor Information
Contains information of the Neighbor
...
Data Type
...
ecgi
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
pci
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
earFcn
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
tac
...
String
...
| Status | ||||
|---|---|---|---|---|
|
Prach Configuration
Contains information of the Prach
...
Data Type
...
highSpeedFlag
...
Boolean
...
| Status | ||||
|---|---|---|---|---|
|
...
prachConfigurationIndex
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
prachFrequencyOffset
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
rootSequenceIndex
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
zeroCorrelationZoneConfiguration
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
Gnb
Contains information of the gnodeb
...
Data Type
...
servedNrCells
...
Array of Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to served NR Cells object
...
| Status | ||||
|---|---|---|---|---|
|
...
Served NR Cells
Contains information of the GNB cell
...
Data Type
...
nrNeighbourInfos
...
Array of object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to NrNeighbourInformation object
...
servedNrCellInformation
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to ServedNRCellInformation object
Nr Neighbour Information
Contains information of the Neighbor of this GNB Note it is quite similar to Served NR Cell Information
...
Data Type
...
nrCgi
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
choiceNrMode
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Choice NR Mode Object
...
configuredStac
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
nrMode
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to NR Mode ENUM
...
nrPci
...
Integer
...
stac5g
...
String
...
| Status | ||||
|---|---|---|---|---|
|
Served NR Cell Information
Contains information of the cell
...
Data Type
...
cellId
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
choiceNrMode
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to Choice NR Mode Object
...
configuredStac
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
nrMode
...
ENUM
...
Refer to NR Mode ENUM
...
nrPci
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
servedPlmns
...
Array of String
...
| Status | ||||
|---|---|---|---|---|
|
...
Array of PLMNs
...
stac5g
...
String
...
| Status | ||||
|---|---|---|---|---|
|
Choice NR Mode
Contains information of the TBD – Note – It is either FDD or TDD, one of them must exist
...
Data Type
...
fdd
...
Object
...
Refer to NR FDD Info
...
tdd
...
Object
...
Refer to NR TDD Info
NR FDD Info
Contains information of the NR FDD Cell
...
Data Type
...
dlFreqInfo
...
Object
...
Refer to dl Freq Info Object
...
dlTransmissionBandwidth
...
Object
...
Refer to dl Transmission Bandwidth Object
...
ulFreqInfo
...
Object
...
Refer to ul Freq Info Object
...
ulTransmissionBandwidth
...
Object
...
Refer to ul Transmission Bandwidth Object
dl Freq Info or ul Freq Info or nr Freq Info NR
Contains information of the Cell
...
Data Type
...
frequencyBands
...
Object
...
Refer to frequency Bands Object
...
nrArFcn
...
integer
...
| Status | ||||
|---|---|---|---|---|
|
...
sulInformation
...
Object
...
Refer to sul Information Object
Frequency Bands
Contains information of the Frequency Bands
...
Data Type
...
nrFrequencyBand
...
integer
...
| Status | ||||
|---|---|---|---|---|
|
...
supportedSulBands
...
Array of integer
...
| Status | ||||
|---|---|---|---|---|
|
sul Information
Contains information of the TBD
...
Data Type
...
sulArFcn
...
integer
...
sulTransmissionBandwidth
...
object
...
Refer to sul Transmission Bandwidth object
dl Transmission Bandwidth or ul Transmission Bandwidth or sul Transmission Bandwidth or Transmission Bandwidth
Contains information of the TBD
...
Data Type
...
ncnrb
...
ENUM
...
Refer to ncnrb ENUM
...
nrscs
...
ENUM
...
Refer to nrscs ENUM
NR TDD Info
Contains information of the NE Cell TDD
...
Data Type
...
nrFreqInfo
...
Object
...
Refer to nr Freq Info Object
...
transmissionBandwidth
...
Object
...
Refer to transmission Bandwidth Object
RAN Function
Contains information of the Function this RAN supports - Please refer to O-RAN Working Group 3, E2 Application Protocol (E2AP)
...
Data Type
...
ranFunctionId
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
See Ran Function Definition
...
| Status | ||||
|---|---|---|---|---|
|
Ran Function Definition
...
#
...
Parameter
...
Data Type
...
Required?
...
Value Rules
...
1
...
e2smGnbNrtRanFunctionDefinition
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
See E2 SM GNB NRT Ran Function Definition
E2 SM GNB NRT Ran Function Definition
...
Data Type
...
ranFunctionName
...
Object
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
Ran Function Name
...
Data Type
...
ranFunctionShortName
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
RIC Event Trigger Styles
...
Data Type
...
ricEventTriggerStyleType
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
RIC Report Styles
...
Data Type
...
ricReportStyleType
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
RIC Report RAN Parameter Defs
...
Data Type
...
ranParameterId
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
RIC Insert Styles
...
Data Type
...
ricInsertStyleType
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
RIC Control Styles
...
Data Type
...
ricControlStyleType
...
Integer
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
Setup Failure
Contains information of the error
...
Data Type
...
cause_group
...
ENUM
...
| Status | ||||
|---|---|---|---|---|
|
...
One of the following ENUM
- RadioNetworkLayerCause
- TransportLayerCause
- ProtocolCause
- MiscellaneousCause
...
TimeToWait
...
ENUM
...
Look on TimeToWait ENUM
...
CriticalityDiagnostics
...
Object
Criticality Diagnostics
Contains information of the error
...
Data Type
...
informationElementCriticalityDiagnostics
...
Object
...
·
...
procedureCode
...
Integer
...
procedureCriticality
...
ENUM
...
Refer to Criticality ENUM
...
triggeringMessage
...
ENUM
...
Refer to TriggeringMessage ENUM
Information Element Criticality Diagnostics
Contains information of the error
...
Data Type
...
ieCriticality
...
ENUM
...
Refer to Criticality ENUM
...
ieId
...
Integer
...
typeOfError
...
ENUM
...
Refer to TypeOfError ENUM
...
3. Update GNB Request
...
Resource
...
Resource for this interface
/v#/nodeb
...
Description
...
For storing nodeb data 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
...
PUT http://<serverBaseURL>/v#/nodeb/<ranName>/update
Request Data Details
...
#
...
Parameter
...
Location
...
Data Type
...
Required?
...
Value Rules
...
YES
...
content-type
...
Header
...
String
...
YES
...
Refer to Standard API Request Headers
...
Example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
PUT http://localhost:3800/v1/nodeb/test1/update
accept: application/json
{
"servedNrCells": [
{
"servedNrCellInformation": {
"nrPci": 100,
"cellId": "02f829:0007ab0178",
"servedPlmns": [
"02f829"
],
"nrMode": "FDD",
"choiceNrMode": {
"fdd": {
"ulFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"dlFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"ulTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
},
"dlTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
}
}
}
},
"nrNeighbourInfos": [
{
"nrCgi": "string",
"choiceNrMode": {
"fdd": {
"ulFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"dlFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"ulTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
},
"dlTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
}
}
},
"configuredStac": "string",
"nrPci": 200,
"nrMode": "FDD",
"stac5g": "string"
},
{
"nrCgi": "string",
"choiceNrMode": {
"fdd": {
"ulFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"dlFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"ulTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
},
"dlTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
}
}
},
"configuredStac": "string",
"nrPci": 201,
"nrMode": "FDD",
"stac5g": "string"
}
]
},
{
"servedNrCellInformation": {
"nrPci": 101,
"cellId": "02f829:0007ab0120",
"servedPlmns": [
"02f829"
],
"nrMode": "FDD",
"choiceNrMode": {
"fdd": {
"ulFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"dlFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"ulTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
},
"dlTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
}
}
}
},
"nrNeighbourInfos": [
{
"nrCgi": "string",
"choiceNrMode": {
"fdd": {
"ulFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"dlFreqInfo": {
"nrArFcn": "100",
"frequencyBands": [
{
"nrFrequencyBand": 9,
"supportedSulBands": [
9
]
}
]
},
"ulTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
},
"dlTransmissionBandwidth": {
"nrscs": "SCS15",
"ncnrb": "NRB11"
}
}
},
"configuredStac": "string",
"nrPci": 300,
"nrMode": "FDD",
"stac5g": "string"
}
]
}
]
}
|
Response Data Details
In case 200 OK, the payload is identical to Get NodeB <RAN Name>.
...
4. Insert ENB Request
...
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
...
POST http://<serverBaseURL>/v#/nodeb/<ranName>/insertenb
Request Data Details
...
#
...
Parameter
...
Location
...
Data Type
...
Required?
...
Value Rules
...
YES
...
content-type
...
Header
...
String
...
YES
...
Refer to Standard API Request Headers
...
ENB Node
...
#
...
Parameter
...
Data Type
...
Required?
...
Value Rules
...
enbType
...
ENUM
...
YES
...
ranName
...
String
...
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
...
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
...
PUT http://<serverBaseURL>/v#/nodeb/<ranName>/updateenb
Request Data Details
...
#
...
Parameter
...
Location
...
Data Type
...
Required?
...
Value Rules
...
YES
...
content-type
...
Header
...
String
...
YES
...
Refer to Standard API Request Headers
...
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 |
Request Data Details
Listed below are the key elements included in the request.
...
Location
...
accept
...
Header
...
String
...
| Status | ||||
|---|---|---|---|---|
|
...
Refer to - Standard API Request Headers
| 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)
...
7. 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.
...
#
...
Parameter
...
Location
...
Data Type
...
Required?
...
Description and Value Rules
...
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
...
content-type
...
Header
...
String
...
YES
...
rans
...
Body
...
List of Object
...
YES
...
Can be empty in case no RANs. See nodebIdentity
nodebIdentity
Contains information of the eNodeb
#
Parameter
Data Type
Required?
Value Rules
inventoryName
String
YES
Name of the RAN
globalNbId
Object
YES
ID of the RAN - Refer globalNbId object
| 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)
8. 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 |
9. 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.
10. 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
...
# | Parameter | Location | Data Type | Required? | Value Rules |
|---|---|---|---|---|---|
| 1 | content-type | Header | String | YES | |
| 2 | Body | List of Object | YES | Can be empty in case no E2T. See e2tIdentity |
e2tIdentity
Contains information of the E2T instance
...
| 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"]
}
]
|
11. 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.
# | 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 | Parameters | Object | Object | YES | At least one field in the Parameter Object |
parameter
Contains information of the eNodeb. At least one parameter must exist in this Object
...
{ "enableRic": true, } |
Response Data Details
200 OK with the list of All parameters or error