...
| 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",
"ncnrb": "NRB11" 3
}
}
}]
},
"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"
},
"ulTransmissionBandwidth": {
"nrCgi": "string",
"choiceNrModenrscs": {1,
"fdd": {
"ulFreqInfoncnrb": {1
"nrArFcn": "100",
},
"frequencyBands": [
"dlTransmissionBandwidth": {
{
"nrFrequencyBandnrscs": 91,
"supportedSulBandsncnrb": [1
9}
}
]
},
}
"nrMode": 1,
]
}"nrPci": 1,
"dlFreqInfoservedPlmns": {[
"nrArFcn": "100demo",
]
"frequencyBands": [
}
},
{
"servedNrCellInformation": {
"nrFrequencyBand": 9,
"cellId": "demo2",
"supportedSulBandschoiceNrMode": [{
"fdd": {
9
"ulFreqInfo": ]{
}
"nrArFcn": 1,
]
},
"sulInformation": {
"ulTransmissionBandwidth": {
"nrscssulArFcn": "SCS15"2,
"ncnrb "sulTransmissionBandwidth": "NRB11"
{
},
"dlTransmissionBandwidthnrscs": {1,
"nrscs": "SCS15",
"ncnrb": "NRB11"1
}
}
},
"configuredStac": "string" },
"nrPci": 201,
"nrModefrequencyBands": "FDD",[
"stac5g": "string"
}
]{
},
{
"servedNrCellInformation": {
"nrPcinrFrequencyBand": 1013,
"cellId": "02f829:0007ab0120",
"servedPlmns": [
"02f829supportedSulBands": [
],
"nrMode": "FDD",
"choiceNrMode": {
1,
"fdd": {
"ulFreqInfo": {
"nrArFcn": "100" 2,
"frequencyBands": [
{
3
"nrFrequencyBand": 9,
"supportedSulBands": []
9
}
]
}]
]
},
},
"dlFreqInfo": {
"nrArFcn": "100"1,
"frequencyBands": [
"sulInformation": {
{
"nrFrequencyBandsulArFcn": 92,
"supportedSulBands": [
"sulTransmissionBandwidth": {
9
]
"nrscs": 1,
}
]
},"ncnrb": 1
"ulTransmissionBandwidth": {
"nrscs": "SCS15",
}
"ncnrb": "NRB11"
},
"dlTransmissionBandwidth": {
"nrscsfrequencyBands": "SCS15",[
"ncnrb": "NRB11"
}{
}
}
},
"nrNeighbourInfosnrFrequencyBand": [3,
{
"nrCgi": "string",
"choiceNrModesupportedSulBands": {[
"fdd": {
"ulFreqInfo": {
1,
"nrArFcn": "100",
"frequencyBands": [
2,
{
"nrFrequencyBand": 9,
3
"supportedSulBands": [
9]
]
}
}
]
},
},
"dlFreqInfo": {
"nrArFcnulTransmissionBandwidth": "100",{
"frequencyBands": [
"nrscs": 1,
{
"nrFrequencyBandncnrb": 9,1
"supportedSulBands": [
},
"dlTransmissionBandwidth": 9{
]
"nrscs": 1,
}
"ncnrb": 1
]
},
"ulTransmissionBandwidth": {
}
"nrscs": "SCS15" },
"ncnrbnrMode": "NRB11"1,
"nrPci": }2,
"dlTransmissionBandwidthservedPlmns": {[
"nrscs": "SCS15whatever2",
]
"ncnrb": "NRB11"
},
}
"nrNeighbourInfos": [
}
{
},
"configuredStacnrCgi": "stringdemo1",
"nrPcichoiceNrMode": 300,{
"nrMode": "FDD",
"stac5gfdd": "string"
{
"ularFcnFreqInfo": {
}
"nrArFcn": 1,
"sulInformation": ]
{
}
]
}
|
Response Data Details
In case 200 OK, the payload is identical to Get NodeB <RAN Name>.
"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 } } ] } } |
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 |
Response Data Details
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
no need in Request Body
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.
| # | Parameter | Location | Data Type | Required? | Description and Value Rules | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | accept | Header | String |
| 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)
8. Get All NodeB States Request |
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 |
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
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
...
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
{ "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 } } ] } } |
...
PUT http://<serverBaseURL>/v#/nodeb/enb/<ranName>
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. Delete ENB Request
...
Resource
...
Resource for this interface - /v#/nodeb/enb
...
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
...
DELETE http://<serverBaseURL>/v#/nodeb/enb/<ranName>
Request Data Details
no need in Request Body
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.
...
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)
8. Get All NodeB States Request
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
GET http://<serverBaseURL>/v#/nodeb/statesRequest Data Details
Listed below are the key elements included in the request.
...