Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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


PUT http://<serverBaseURL>/v#/nodeb/<ran name>/reset
(See remark above about changing the Endpoint)

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

cause

Body

String


Reason of the Reset (Cause enum). If not provided - E2M  will send misc:om-intervention

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

...

In case 200 OK, the payload is identical to Get NodeB <RAN Name>.

3

4. Insert ENB Request  


Resource

 

Resource for this interface

/v#/nodeb

Description

For storing new nodeb data 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

1acceptHeaderString

YES

Refer to Standard API Request Headers
2

content-type

Header

String

YES

Refer to Standard API Request Headers

3enbNodeBodyObjectYESPlease refer to ENB Node
4servedCellsBodyArray of ObjectYESPlease 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


3globalNbIdObjectNORefer 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>.

4

5. Update ENB 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>/updateenb

Request Data Details

#

Parameter

Location

Data Type

Required?

Value Rules

1acceptHeaderString

YES

Refer to Standard API Request Headers
2

content-type

Header

String

YES

Refer to Standard API Request Headers

3enbNodeBodyObjectYESPlease refer to ENB Node
4servedCellsBodyArray of ObjectYESPlease 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>.

...