Versions Compared

Key

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

...

#APIResource After base URIHTTP Verb

X2 Setup Request Message Request  (deprecated)

/v#/nodeb/x2-setup

POST


ENDC Setup Request Message Request   (deprecated)

/v#/nodeb/endc-setup

POST


Reset nodeb Request  (deprecated)/v#/nodeb/<ranName>/reset *PUT
1

Health Check Request 

/v#/health

GET

2

Get nodeb data Request  

/v#/nodeb/<ranName>

GET

3Update GNB Request  /v#/nodeb/<ranName>/updatePUT
4Insert ENB Request  /v#/nodeb/<ranName>/enbPOST
5Update ENB Request  /v#/nodeb/<ranName>/enbPUT
6Delete ENB Request /v#/nodeb/<ranName>/enbDELETE
7

Shut Down Request 

/v#/nodeb/shutdown

PUT

8

Get All nodeb States Request (Changed, Stretch Goal)

/v#/nodeb/states

GET
9Get NodeB State Request (New, Stretch Goal)/v#/nodeb/states/<ranName>GET
10RAN Health Check Request  (New, Stretch Goal)/v#/nodeb/healthPUT
11Get All E2T Request /v#/e2t/listGET
12E2M set parameters (New)/v#/nodeb/parametersPUT

...

#Attribute TypeLegal Values
1Connection Status

UNKNOWN_CONNECTION_STATUS = 0;

CONNECTED = 1;

DISCONNECTED  = 2;

CONNECTED_SETUP_FAILED = 3;

CONNECTING = 4;

SHUTTING_DOWN = 5;

SHUT_DOWN = 6;

2Failure TypeUNKNOWN_TYPE = 0;
X2_SETUP_FAILURE = 1;
ENDC_X2_SETUP_FAILURE = 2;
3

Node Type

UNKNOWN = 0;
ENB = 1;
GNB = 2;
4Radio Network Layer Cause

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;

5Transport Layer Cause

UNKNOWN = 0;

TRANSPORT_RESOURCE_UNAVAILABLE = 1;

UNSPECIFIED = 2;

6Protocol Cause

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;

7Miscellaneous Cause

UNKNOWN = 0;

CONTROL_PROCESSING_OVERLOAD =  1;

HARDWARE_FAILURE =  2;

OM_INTERVENTION =  3;

NOT_ENOUGH_USER_PLANE_PROCESSING_RESOURCES =  4;

UNSPECIFIED =  5;

8Time To Wait

UNKNOWN_TIMEOUT = 0;

V1S = 1;

V2S = 2;

V5S = 3;

V10S = 4;

V20S = 5;

V60S = 6;

9Type Of Error

UNKNOWN_ERROR = 0;

NOT_UNDERSTOOD = 1;

MISSING = 2;

10Triggering Message

UNKNOWN_MESSAGE = 0;

INITIATING_MESSAGE = 1;

SUCCESSFUL_OUTCOME = 2;

UNSUCCESSFUL_OUTCOME = 3;

11Criticality

UNKNOWN_CRITICALITY = 0;

REJECT = 1;

IGNORE = 2;

NOTIFY = 3;

12Bandwidth Reduced SI

UNKNOWN_BANDWIDTH_REDUCED_SI = 0;

SCHEDULED = 1;

13

Eutra Mode / Nr Mode

UNKNOWN = 0;

FDD = 1;

TDD = 2;

14Freq Band Indicator Priority

UNKNOWN_FREQ_BAND_INDICATOR_PRIORITY = 0;

NOT_BROADCASTED = 1;

BROADCASTED = 2;

15Number Of Antenna Ports

UNKNOWN_NUMBER_OF_ANTENNA_PORTS = 0;

AN1 = 1;

AN2 = 2;

AN4 = 3;

16Transmission Bandwidth

UNKNOWN_TRANSMISSION_BANDWIDTH = 0;

BW6 = 1;

BW15 = 2;

BW25 = 3;

BW50 = 4;

BW75 = 5;

BW100 = 6;

BW1 = 7;

17Subframe Allocation Type

UNKNOWN_SUBFRAME_ALLOCATION_TYPE = 0;

ONE_FRAME = 1;

FOUR_FRAME = 2;

18Radio frame Allocation Period

UNKNOWN_RADIOFRAME_ALLOCATION_PERIOD = 0;

N1 = 1;

N2 = 2;

N4 = 3;

N8 = 4;

N16 = 5;

N32 = 6;

19Enb Type

UNKNOWN_ENB_TYPE = 0;

MACRO_ENB = 1;

HOME_ENB = 2;

SHORT_MACRO_ENB = 3;

LONG_MACRO_ENB = 4;

20Additional Special Subframe

UNKNOWN = 0;

SSP0 = 1;

SSP1 = 2;

SSP2 = 3;

SSP3 = 4;

SSP4 = 5;

SSP5 = 6;

SSP6 = 7;

SSP7 = 8;

SSP8 = 9;

SSP9 = 10;

21Special Subframe

UNKNOWN = 0;

SSP0 = 1;

SSP1 = 2;

SSP2 = 3;

SSP3 = 4;

SSP4 = 5;

SSP5 = 6;

SSP6 = 7;

SSP7 = 8;

SSP8 = 9;

22Subframe Assignment

UNKNOWN_SUBFRAME_ASSIGNMENT = 0;

SA0 = 1;

SA1 = 2;

SA2 = 3;

SA3 = 4;

SA4 = 5;

SA5 = 6;

SA6 = 7;

23Cyclic Prefix

UNKNOWN_CYCLIC_PREFIX = 0;

NORMAL = 1;

EXTENDED = 2;

24Additional Special Subframe Patterns

UNKNOWN = 0;

SSP10 = 1

25nrscs

UNKNOWN_NRSCS = 0;

SCS15 = 1;

SCS30 = 2;

SCS60 = 3;

SCS120 = 4;

26ncnrb

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;

27cause

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) 

ENDC Setup Request (Deprecated)

Reset nodeb Request  (Deprecated)

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

...

200 OK with the list of All parameters or error


X2 Setup Request (Deprecated) 


ENDC Setup Request (Deprecated)


Reset nodeb Request  (Deprecated)