...
| Revision Description | Time | Swagger Ready |
|---|---|---|
Adding new methods - Insert, Update and Delete ENB. Add new errors. 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 | July 2020 | ReadyTBD |
| Changing the end point of Update GNB. Adding more information to the Cell Object like Update eNB | July 2020 | TBD Ready |
| 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 |
| AD SDL Notification Description | June 2020 | NA |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
PUT http://localhost:3800/v1/nodeb/gnb/test1
accept: application/json
{
"servedNrCells": [
{
"servedNrCellInformation": {
"nrPci": 100,
"cellId": "02f829:0007ab0178demo1",
"servedPlmns": [
"02f829choiceNrMode": {
],
"nrModefdd": "FDD",{
"choiceNrMode": {
"fddulFreqInfo": {
"ulFreqInfo": {
"nrArFcn": "100"1,
"frequencyBands": [
"sulInformation": {
{
"nrFrequencyBandsulArFcn": 92,
"supportedSulBands": [
"sulTransmissionBandwidth": {
9
]
"nrscs": 1,
}
]
},"ncnrb": 1
"dlFreqInfo": {
"nrArFcn": "100",
}
"frequencyBands": [
},
{
"nrFrequencyBandfrequencyBands": 9,[
"supportedSulBands": [
{
9
]
"nrFrequencyBand": 3,
}
]
"supportedSulBands": [
},
"ulTransmissionBandwidth": {
"nrscs": "SCS15" 1,
"ncnrb": "NRB11"
},
2,
"dlTransmissionBandwidth": {
"nrscs": "SCS15",
3
"ncnrb": "NRB11"
}
}
]
}
},
"nrNeighbourInfos": [
{}
"nrCgi": "string",
"choiceNrMode": {
]
"fdd": {
},
"ulFreqInfo": {
"nrArFcndlFreqInfo": "100",{
"frequencyBands": [
"nrArFcn": 1,
{
"nrFrequencyBandsulInformation": 9,{
"supportedSulBands": [
"sulArFcn": 2,
9
"sulTransmissionBandwidth": {
]
}
"nrscs": 1,
]
},
"dlFreqInfoncnrb": {1
"nrArFcn": "100",
}
"frequencyBands": [
{
},
"nrFrequencyBandfrequencyBands": 9,[
"supportedSulBands": [
{
9
]"nrFrequencyBand": 3,
}
"supportedSulBands": [
]
},
"ulTransmissionBandwidth": {
1,
"nrscs": "SCS15",
"ncnrb": "NRB11"
2,
},
"dlTransmissionBandwidth": {
3
"nrscs": "SCS15",
"ncnrb": "NRB11"
}]
}
},
}
"configuredStac": "string",
"nrPci": 200,
]
"nrMode": "FDD",
"stac5g": "string"
},
{
"nrCgiulTransmissionBandwidth": "string",{
"choiceNrMode": {
"fddnrscs": {
1,
"ulFreqInfo": {
"nrArFcnncnrb": "100",1
"frequencyBands": [
},
{
"dlTransmissionBandwidth": {
"nrFrequencyBand": 9,
"nrscs": 1,
"supportedSulBands": [
"ncnrb": 1
9
]}
}
},
]
}"nrMode": 1,
"dlFreqInfonrPci": {1,
"nrArFcnservedPlmns": "100",[
"frequencyBandsdemo": [
{]
}
"nrFrequencyBand": 9},
{
"supportedSulBandsservedNrCellInformation": [{
"cellId": "demo2",
9
"choiceNrMode": {
]
"fdd": {
}
"ulFreqInfo": {
]
},
"nrArFcn": 1,
"ulTransmissionBandwidth": {
"nrscssulInformation": "SCS15",{
"ncnrb": "NRB11"
}"sulArFcn": 2,
"dlTransmissionBandwidth": {
"nrscssulTransmissionBandwidth": "SCS15",{
"ncnrb": "NRB11"
}
"nrscs": 1,
}
},
"configuredStacncnrb": "string",1
"nrPci": 201,
"nrMode": "FDD",
}
"stac5g": "string"
}
]},
},
{
"servedNrCellInformation "frequencyBands": {[
"nrPci": 101,
"cellId": "02f829:0007ab0120",
{
"servedPlmns": [
"02f829"
],
"nrModenrFrequencyBand": "FDD"3,
"choiceNrMode": {
"fdd": {
"ulFreqInfosupportedSulBands": {
[
"nrArFcn": "100",
"frequencyBands": [
1,
{
"nrFrequencyBand": 92,
"supportedSulBands": [
93
]
]
}
]
},
"dlFreqInfo": {
]
"nrArFcn": "100",
"frequencyBands": [
},
"dlFreqInfo": {
"nrFrequencyBandnrArFcn": 91,
"supportedSulBands "sulInformation": [{
9
"sulArFcn": 2,
]
}
"sulTransmissionBandwidth": {
]
},
"ulTransmissionBandwidthnrscs": {1,
"nrscs": "SCS15",
"ncnrb": "NRB11"1
},
"dlTransmissionBandwidth": {}
"nrscs": "SCS15",
},
"ncnrb": "NRB11"
}
"frequencyBands": [
}
}
},
"nrNeighbourInfos": [{
{
"nrCgi": "string",
"choiceNrModenrFrequencyBand": {3,
"fdd": {
"ulFreqInfosupportedSulBands": {[
"nrArFcn": "100",
"frequencyBands": [ 1,
{
2,
"nrFrequencyBand": 9,
"supportedSulBands": [
3
9
]
}
}
]
},
]
"dlFreqInfo": {
},
"nrArFcn": "100",
"frequencyBandsulTransmissionBandwidth": [{
{
"nrscs": 1,
"nrFrequencyBand": 9,
"supportedSulBandsncnrb": [1
9},
]
"dlTransmissionBandwidth": {
}
"nrscs": 1,
]
},
"ncnrb": 1
"ulTransmissionBandwidth": {
"nrscs": "SCS15",
}
"ncnrb": "NRB11" }
},
"dlTransmissionBandwidthnrMode": {1,
"nrscsnrPci": "SCS15"2,
"ncnrbservedPlmns": "NRB11"
[
}"whatever2"
}]
},
"configuredStacnrNeighbourInfos": "string",
[
"nrPci": 300,
{
"nrModenrCgi": "FDDdemo1",
"stac5g "choiceNrMode": "string"
{
"fdd": {
}
"ularFcnFreqInfo": ]{
}
]
}
|
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/enb
...
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
"nrArFcn": 1,
"sulInformation": {
"sulArFcn": 2,
"sulTransmissionBandwidth": {
"nrscs": 1,
"ncnrb": 1
}
},
"frequencyBands": [
{
"nrFrequencyBand": 3,
"supportedSulBands": [
1,
2,
3
]
}
]
},
"dlarFcnFreqInfo": {
"nrArFcn": 1,
"sulInformation": {
"sulArFcn": 2,
"sulTransmissionBandwidth": {
"nrscs": 1,
"ncnrb": 1
}
},
"frequencyBands": [
{
"nrFrequencyBand": 3,
"supportedSulBands": [
1,
2,
3
]
}
]
}
}
},
"nrMode": 1,
"nrPci": 1
}
]
}
]
}
|
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/ |
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 |
accept: application/json { "ranName": "test4", "globalNbId": { "nbId": "abc", "plmnId": "def" }, "ip": "10.2.3.1", "port": 1234, "enb": { "enbType": 1, "guGroupIds": [ "ghi" ], "servedCells": [ { "broadcastPlmns": [ "jkl" ], "cellId": "mnop", "choiceEutraMode": { "fdd": { "dlearFcn": 1, "ulearFcn": 1 }, "tdd": { "additionalSpecialSubframeExtensionInfo": { "additionalSpecialSubframePatternsExtension": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 }, "additionalSpecialSubframeInfo": { "additionalSpecialSubframePatterns": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 }, "earFcn": 4, "specialSubframeInfo": { "specialSubframePatterns": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 } } }, "eutraMode": 1, "csgId": "string", "mbmsServiceAreaIdentities": [ "sds" ], "mbsfnSubframeInfos": [ { "radioframeAllocationOffset": 3, "subframeAllocation": "jhg" } ], "multibandInfos": [ 4 ], "neighbourInfos": [ { "earFcn": 4, "ecgi": "klj", "pci": 5, "tac": "wew" } ], "pci": 2, "prachConfiguration": { "highSpeedFlag": true, "prachConfigurationIndex": 5, "prachFrequencyOffset": 6, "rootSequenceIndex": 7, "zeroCorrelationZoneConfiguration": 6 }, "tac": "asd", "additionalCellInformation": { "cellLatitude": 1, "cellLongitude": 1, "antennaHeight": 1, "antennaAzimuthDirection": 2, "antennaTiltAngle": 3, "antennaMaxTransmit": 4, "antennaMaxGain": 5, "sectorId": 6 } }, { "broadcastPlmns": [ "jkl" ], "cellId": "qrst", "choiceEutraMode": { "fdd": { "dlearFcn": 4, "ulearFcn": 2 }, "tdd": { "additionalSpecialSubframeExtensionInfo": { "additionalSpecialSubframePatternsExtension": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 }, "additionalSpecialSubframeInfo": { "additionalSpecialSubframePatterns": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 }, "earFcn": 4, "specialSubframeInfo": { "specialSubframePatterns": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 } } }, "eutraMode": 1, "csgId": "string", "mbmsServiceAreaIdentities": [ "sds" ], "mbsfnSubframeInfos": [ { "radioframeAllocationOffset": 5, "subframeAllocation": "jhg" } ], "multibandInfos": [ 4 ], "neighbourInfos": [ { "earFcn": 2, "ecgi": "klj", "pci": 4, "tac": "wew" } ], "pci": 3, "prachConfiguration": { "highSpeedFlag": true, "prachConfigurationIndex": 4, "prachFrequencyOffset": 3, "rootSequenceIndex": 3, "zeroCorrelationZoneConfiguration": 2 }, "tac": "asd", "additionalCellInformation": { "cellLatitude": 3, "cellLongitude": 3, "antennaHeight": 3, "antennaAzimuthDirection": 3, "antennaTiltAngle": 4, "antennaMaxTransmit": 4, "antennaMaxGain": 5, "sectorId": 5 } } ] } |
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 | 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 | ip | Body | String | NO | |
| 6 | port | Body | Integer | NO | |
| 7 | enb | Body | Object | YES | Please refer to ENB Object |
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 |
accept: application/json { "enb": { "enbType": 1, "guGroupIds": [ "ghi" ], "servedCells": [ { "broadcastPlmns": [ "jkl" ], "cellId": "mnop", "choiceEutraMode": { "fdd": { "dlearFcn": 1, "ulearFcn": 1 }, "tdd": { "additionalSpecialSubframeExtensionInfo": { "additionalSpecialSubframePatternsExtension": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 }, "additionalSpecialSubframeInfo": { "additionalSpecialSubframePatterns": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 }, "earFcn": 4, "specialSubframeInfo": { "specialSubframePatterns": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 } } }, "eutraMode": 1, "csgId": "string", "mbmsServiceAreaIdentities": [ "sds" ], "mbsfnSubframeInfos": [ { "radioframeAllocationOffset": 3, "subframeAllocation": "jhg" } ], "multibandInfos": [ 4 ], "neighbourInfos": [ { "earFcn": 4, "ecgi": "klj", "pci": 5, "tac": "wew" } ], "pci": 2, "prachConfiguration": { "highSpeedFlag": true, "prachConfigurationIndex": 5, "prachFrequencyOffset": 6, "rootSequenceIndex": 7, "zeroCorrelationZoneConfiguration": 6 }, "tac": "asd", "additionalCellInformation": { "cellLatitude": 1, "cellLongitude": 1, "antennaHeight": 1, "antennaAzimuthDirection": 2, "antennaTiltAngle": 3, "antennaMaxTransmit": 4, "antennaMaxGain": 5, "sectorId": 6 } }, { "broadcastPlmns": [ "jkl" ], "cellId": "qrst", "choiceEutraMode": { "fdd": { "dlearFcn": 4, "ulearFcn": 2 }, "tdd": { "additionalSpecialSubframeExtensionInfo": { "additionalSpecialSubframePatternsExtension": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 }, "additionalSpecialSubframeInfo": { "additionalSpecialSubframePatterns": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 }, "earFcn": 4, "specialSubframeInfo": { "specialSubframePatterns": 1, "cyclicPrefixDl": 1, "cyclicPrefixUl": 1 } } }, "eutraMode": 1, "csgId": "string", "mbmsServiceAreaIdentities": [ "sds" ], "mbsfnSubframeInfos": [ { "radioframeAllocationOffset": 5, "subframeAllocation": "jhg" } ], "multibandInfos": [ 4 ], "neighbourInfos": [ { "earFcn": 2, "ecgi": "klj", "pci": 4, "tac": "wew" } ], "pci": 3, "prachConfiguration": { "highSpeedFlag": true, "prachConfigurationIndex": 4, "prachFrequencyOffset": 3, "rootSequenceIndex": 3, "zeroCorrelationZoneConfiguration": 2 }, "tac": "asd", "additionalCellInformation": { "cellLatitude": 3, "cellLongitude": 3, "antennaHeight": 3, "antennaAzimuthDirection": 3, "antennaTiltAngle": 4, "antennaMaxTransmit": 4, "antennaMaxGain": 5, "sectorId": 5 } } ] } } |
...
POST http://<serverBaseURL>/v#/nodeb/enb
Request Data Details
...
#
...
Parameter
...
Location
...
Data Type
...
Required?
...
Value Rules
...
YES
...
content-type
...
Header
...
String
...
YES
...
Refer to Standard API Request Headers
...
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/enb
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/enb/<ranName> |
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 | enb | Body | Object | YES | Please refer to ENB Object |
...
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 |
accept: application/json |
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 |
GET http://localhost:3800/v1/nodeb/statesaccept: application/json
Response Data Details
In case 200 OK, this is the payload
...
# | 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) |
...
Example ... |
9. 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 |
...
|
Response Data Details
In case 200 OK, this is the payload
...
{ "enableRic": true, } |
Response Data Details
200 OK with the list of All parameters or error
...
|
SDL Notification
when When a new NodeB RAN (eNB or gNB) is added, Updated updated or deleted in RNIB, or when a state of NodeB RAN is changed, the following SDL Notification generated.
E2M supports 2 types of SDL Notification, the client can subscribe to each of them:
- RAN Manipulation - The Notification specifies the RAN Name + the action (Added, Updated, Deleted)
- RAN Connection Status Changed - The Notification specifies the RAN Name + its Status
- NodeB Modification
- NodeB State Change
In the following scenarios E2M generates SDL Notification:
| Issue |
|---|
| RAN Connection Status Changed | RAN Manipulation |
|---|
| Comments | |||
|---|---|---|---|
Setup Request from RAN | + (Connected) | Only in case |
the NodeB was previously Disconnected or it is a new RAN Note that the Function might be changed. In case new RAN - In most of the cases the status changed to Connected, n the rare case where the Routing Manager is down - E2M generate SDL RAN Connection Status Changed to Disconnected. | |||
| + (Updated) | In case the NodeB was already Connected and there was some changes | ||
| Insert eNB API | + (Added) | ||
Update eNB API, Update gNB API | + (Updated) | ||
| RIC Service Update | + (Updated) |
| Only in case there was some changed (Function Added / Modified / Deleted) | |||
Lost Connection, Red Button (Shut Down) | + (Disconnected) | Only in case the NodeB was previously Connected | |
E2T Restart, Keep Alive decides this E2T Instance is dead | + (Disconnected) | Only in case this NodeB was under the control of this E2T Instance and it was previously Connected | |
| Delete eNB API | + |
Example of NodeB State Change
| (Deleted) |
Here are the values:
| Channel | Events |
RAN_CONNECTION_STATUS_CHANGE |
<RAN_NAME>_CONNECTED | |
RAN_MANIPULATION | <RAN_NAME>_ADDED |