Versions Compared

Key

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

...

This API is used by a PCI Handler Microservice as envisioned in the solution for theĀ Casablanca 5G OOF-PCI Use Case


Table of Contents


Expand

Table of Contents


...

Interface DefintionDescription

URI

https://{host}:{port}/api/oof/pci/v1/pci

Operation Type

POST

Content-Type

application/json

...

AttributeRequired?CardinalityContentValuesDescription

networkId

Y

1

String


Id of network requiring PCI optimization

cellIdList

Y

1..N

List of Strings


List of cellIds triggering need for PCI optimization (e.g. potential confusion)

anrInputListY1..NList of ANR Info objects
ANR inputs (list of 'removable' cells)
fixedPCICellsN1..NList of Strings
List of cellIds whose PCI values are not allowed to be changed during PCI optimization
priorityTreatmentCellsN1..NList of Strings
List of cellIds requiring priority/special treatment during PCI optimization

trigger

N1StringNbrListChange

Type of trigger causing need for PCI optimization

...

AttributeRequired?CardinalityContentValuesDescription

CellId

Y

1

String


Cell identity

ANRInfo Object

CellIds triggering need for PCI optimization (e.g. potential confusion)
AttributeRequired?CardinalityContentValuesDescription

CellId

Y

1

String


Cell Identity

RemovableNeighborsY1..N

String

List of strings
List of removable neighbor cells

Synchronous Response Body

...

AttributeRequired?CardinalityContentValuesDescription

networkId

Y

1

String


Id of network requiring PCI optimization

pciSolutionspciANRSolutions

Y

1

List of PCI Solutions PCIANRSolution Object contents


A list of cellIds in the networkId with modified PCI values, and optionally a list of neighbors to be blacklisted

PCIANRSolution Object

Attribute

...

Required?CardinalityContentValuesDescription

cellId

Y

1

String


cellId with modified PCI value

pciSolutions

Y

1..N

List of pciSolution object


New PCI value for cellId

anrSolutionsY1..NList of ANRInfoobject
ANR solutions

pciSolution Object

AttributeRequired?CardinalityContentValuesDescription

cellId

Y

1

String


cellId with modified PCI value

pci

Y

1

integerInteger


New PCI value for cellId

ANRInfo Object

AttributeRequired?CardinalityContentValuesDescription

cellId

Y

1

String


cellId with modified PCI value

removableNeighbors

Y

1..N

List of Strings


List of neighbors to be blacklisted


HTTP Response Code

HTTP CodeResponse PhraseDescription

201

Created

An optimization solution is found.

202

Accepted

An optimization request is accepted.

400

Bad request

Bad request.

401

Unauthorized

Request body is not compliant with the API definition.

404

Not found

The server cannot find the requested URI.

405

Method not found

The requested method is not supported by a server.

500

Internal server error

The server encountered an internal server error or timed out.

520Solver errorRequested number of solutions cannot be found.

...