Eden Net Son Nbi Guide

EdenNet 21
SON Northbound Interface Guide

DN09252603
Issue: 1-0
SON Northbound Interface Guide DN09252603 1-0 Disclaimer
The information in this document applies solely to the hardware/software product (“Product”) specified herein, and only as specified herein.
This document is intended for use by Nokia' customers (“You”) only, and it may not be used except for the purposes defined in the agreement
between You and Nokia (“Agreement”) under which this document is distributed. No part of this document may be used, copied, reproduced,
modified or transmitted in any form or means without the prior written permission of Nokia. If you have not entered into an Agreement
applicable to the Product, or if that Agreement has expired or has been terminated, You may not use this document in any manner and You
are obliged to return it to Nokia and destroy or delete any copies thereof.
The document has been prepared to be used by professional and properly trained personnel, and You assume full responsibility when using
it. Nokia welcome Your comments as part of the process of continuous development and improvement of the documentation.
This document and its contents are provided as a convenience to You. Any information or statements concerning the suitability, capacity,
fitness for purpose or performance of the Product are given solely on an “as is” and “as available” basis in this document, and Nokia reserves
the right to change any such information and statements without notice. Nokia has made all reasonable efforts to ensure that the content of
this document is adequate and free of material errors and omissions, and Nokia will correct errors that You identify in this document. But,
Nokia' total liability for any errors in the document is strictly limited to the correction of such error(s). Nokia does not warrant that the use of
the software in the Product will be uninterrupted or error-free.
N O WA RRA NT Y O F AN Y KI ND , EI T HER EXPR ES S OR I M P L I E D , I N C L U D I N G B U T N O T L I M I T E D TO A N Y

WARR ANT Y OF AVA IL ABI LI T Y, AC CU RAC Y, R EL I A B I L IT Y, T I T L E , N O N - I N F R I N G E M E N T, M E R C H A N TA B I L I TY
OR F IT NE SS FO R A PA RT ICU LAR PU RPO SE, I S M A D E IN R E L AT I O N TO T H E C O N T E N T O F T H I S D O C U M E N T.
IN NO EVEN T WI L L NOK IA B E LI ABLE F OR AN Y DA M A G E S , I N C L U D I N G B U T N O T L I M I T E D TO S P E C I A L ,
D IRE CT, IN D IRECT, I NCI DE NTAL OR C ON SEQ UE N T IA L OR A N Y L O S S E S , S U C H A S B U T N O T L I M I T E D TO LO SS
OF PRO F IT, REVE NU E, B US IN ESS IN T ER RU PT I ON , B U S I NE S S O P P O RT U N I T Y O R D ATA T H AT M AY A R I S E
FRO M T HE USE O F TH IS DO CU M EN T O R T HE IN F OR M AT IO N I N I T, E V E N I N T H E C A S E O F E R R O R S I N O R
OM IS SI O NS FRO M T HI S DOC UM EN T O R IT S CO NT E N T.
This document is Nokia’ proprietary and confidential information, which may not be distributed or disclosed to any third parties without the
prior written consent of Nokia.
Nokia is a registered trademark of Nokia Corporation. Other product names mentioned in this document may be trademarks of their
respective owners, and they are mentioned for identification purposes only.
Copyright © 2021 Nokia. All rights reserved.
Important Notice on Product Safety

This product may present safety risks due to laser, electricity, heat, and other sources of danger.
Only trained and qualified personnel may install, operate, maintain or otherwise handle this product and only after having carefully read the
safety information applicable to this product.
The safety information is provided in the Safety Information section in the “Legal, Safety and Environmental Information” part of this
document or documentation set.
Nokia is continually striving to reduce the adverse environmental effects of its products and services. We would like to encourage you
as our customers and users to join us in working towards a cleaner, safer environment. Please recycle product packaging and follow the
recommendations for power use and proper disposal of our products and their components.
If you should have questions regarding our Environmental Policy or any of the environmental services we offer, please contact us at Nokia for
any additional information.
SON Northbound Interface Guide DN09252603 1-0 Table of Contents
Contents
1 Summary of changes...................................................................................................................................... 5
2 SON Northbound Interface overview............................................................................................................ 8
3 SON NBI execution........................................................................................................................................11

3.1 SON NBI prerequisites............................................................................................................................11
3.1.1 License details................................................................................................................................ 12
3.1.2 API versioning.................................................................................................................................12
3.2 API authentication................................................................................................................................... 12
3.2.1 API authentication example............................................................................................................ 13
3.3 Module management endpoints..............................................................................................................14
3.3.1 Retrieve a list of pre-installed SON modules................................................................................. 14
3.3.1.1 Examples................................................................................................................................ 14
3.3.2 Retrieve details about a specific SON module.............................................................................. 15
3.3.2.1 Examples................................................................................................................................ 16
3.3.3 Create a SON module instance..................................................................................................... 18
3.3.3.1 Examples................................................................................................................................ 18
3.3.4 Retrieve execution status of multiple module instances................................................................ 23
3.3.4.1 Available parameters..............................................................................................................23
3.3.4.2 Examples................................................................................................................................ 24
3.3.5 Retrieve execution status of multiple module instances result.......................................................25
3.3.5.1 Example.................................................................................................................................. 25
3.3.6 Retrieve status of a specific module instance................................................................................27
3.3.6.1 Example.................................................................................................................................. 27
3.3.7 Retrieve the list of output files produced by a specific SON module instance...................... 28
3.3.7.1 Examples................................................................................................................................ 29
3.3.8 Retrieve specific output file produced by a SON module instance.........................................31
3.3.8.1 Examples................................................................................................................................ 31
3.3.9 Start a SON module....................................................................................................................... 32
3.3.10 Stop a module instance................................................................................................................34
3.4 Cell selection endpoints.......................................................................................................................... 34
3.4.1 Retrieve a list of cells.....................................................................................................................34
3.4.1.2 Example.................................................................................................................................. 37
3.4.2 Retrieve a list of cells response..................................................................................................... 39
3.4.2.1 Example.................................................................................................................................. 40
3.5 Cluster management............................................................................................................................... 41
3.5.1 Retrieve a list of pre-defined clusters............................................................................................ 42
3.5.1.1 Example.................................................................................................................................. 42
3.6 Measurements for Radio Access Network............................................................................................. 43
3.6.1 Read performance metrics for cells request.................................................................................. 43
3.6.1.1 Example.................................................................................................................................. 44
3.6.2 Read performance metrics for cells result..................................................................................... 46
EdenNet 21 © 2021 Nokia 3

SON Northbound Interface Guide DN09252603 1-0 Table of Contents
3.6.2.1 Example.................................................................................................................................. 47
3.7 Configuration management for Radio Access Network..........................................................................55
3.7.1 Read neighbor list information of cells request.............................................................................. 55
3.7.1.2 Example.................................................................................................................................. 57
3.7.2 Read neighbor list information of cells result................................................................................. 58
3.7.2.1 Example.................................................................................................................................. 59
3.7.3 Read configuration management data for descendant managed objects request......................... 63
3.7.3.2 Example.................................................................................................................................. 64
3.7.4 Read configuration management data for descendant managed objects result.............................66
3.7.4.1 Example.................................................................................................................................. 67
3.7.5 Read distinguished names of the root level managed objects.......................................................69
3.7.5.1 Example.................................................................................................................................. 70
3.7.6 Read configuration management data for individual managed objects request............................. 70
3.7.6.2 Example.................................................................................................................................. 72
3.7.7 Read configuration management data for individual managed objects result................................ 73
3.7.7.1 Example.................................................................................................................................. 73
3.7.8 Write configuration management data to managed objects request.............................................. 75
3.7.8.2 Example.................................................................................................................................. 77
3.7.9 Write configuration management data to managed objects response........................................... 80
3.7.9.1 Example.................................................................................................................................. 81
3.7.10 Check status of cache for configuration management data request............................................ 84
3.7.10.1 Available parameters............................................................................................................84
3.7.10.2 Example................................................................................................................................ 85
4 General API responses................................................................................................................................. 88
5 Swagger .yml file........................................................................................................................................... 91

SON Northbound Interface Guide DN09252603 1-0 Summary of changes
1 Summary of changes
Release Change description
EdenNet 21 Added sections:
• Retrieve the list of output files produced by a specific SON module

instance
• Retrieve specific output file produced by a SON module instance
Updated sections:
• SON NBI execution - additional information is added about IPv4

and IPv6 address of the GUI Server.
• Available parameters - tacs parameter is added, and the tac
parameter is deprecated.
• Example - updated with launched_time and updated_time
parameters.
• Example - updated with launched_time and updated_time
parameters.
EdenNet 20 FP 2011 No change.
EdenNet 20 Updated sections:
• Example - updated the supported resolutions by EdenNet.

• Available parameters - updated the description of technology pa-
rameter.
EdenNet 19A FP 2004 No change.
EdenNet 19A FP 2002 Updated section:
• Examples - added cgi as a target type.

EdenNet 19A Updated section:
• Swagger .yml file - updated the wheel file name.
EdenNet 19 Updated section:
• Example - updated the description
EdenNet 18 SP1 1901 No changes.
EdenNet 18 SP1 1812 No changes.
EdenNet 18 SP1 1811 Added section:
• Swagger .yml file
EdenNet 18 SP1 Updated sections:
Added a note in following sections:
• Retrieve execution status of multiple module instances result

• Retrieve a list of cells response
• Read neighbor list information of cells result
• Read performance metrics for cells result
• Read configuration management data for descendant managed
objects result
• Read configuration management data for individual managed ob-
jects result
EdenNet 18 Added sections:
• Check status of cache for configuration management data request

section is added.
• License details section is added.
EdenNet 17 SP1 FP1 Added sections:
• Write configuration management data to managed objects request

• Write configuration management data to managed objects re-
sponse
EdenNet 17 SP1 Added sections:

• Read neighbor list information of cells request

• Read neighbor list information of cells result
objects request
objects result
• Read distinguished names of the root level managed objects
• Read configuration management data for individual managed ob-
jects request
EdenNet 17 FP1 Added sections:
• Create a SON module instance

• Retrieve execution status of multiple module instances
• Retrieve execution status of multiple module instances result
• Retrieve status of a specific module instance
• Start a SON module
• Stop a module instance
EdenNet 17 New document.
Table 1: Summary of changes

SON Northbound Interface Guide DN09252603 1-0 SON Northbound Interface overview
2 SON Northbound Interface overview
The EdenNet SON Northbound Interface (SON NBI) is a REST API that allows external applications
to interact with EdenNet services in a common standardized way. The SON NBI exposes the EdenNet
framework capabilities outside the current EdenNet GUI. SON NBI is a versioned interface. The avail-
able capabilities improve from version to version and a particular capability always belongs to a partic-
ular SON NBI version.
The SON NBI performs the following functionalities:
• Encrypts all the traffic between the EdenNet product and the external applications. The API
allows external applications to interact with the SON Modules and is controlled by EdenNet user
permission capabilities.
• Provides access to RAN CM and PM data for external applications.
• Provides access to SON execution information (for example, logs and reports).
• Provides access to EdenNet's advanced SON capabilities.
The communication between EdenNet and external systems is encrypted using HTTPS. Before calling
any API, an external system must be first authenticated and a security token should be obtained. The
external system is authenticated via a user name and password. This user name and password must
correspond to a valid and active user account in EdenNet.
Table 2: API summary describes the available API endpoints.
Relative URL Method Category Description
API versioning GET API Versioning Queries the supported API version at
the server.
API authentication POST User Authentication Authenticates an external system.
Retrieve a list of pre-in- GET SON Module Man- Allows to retrieve a list of pre-installed
stalled SON modules agement SON modules.
Retrieve details about a GET SON Module Man- Allows to retrieve details such as sup-
specific SON module agement ported technologies, version, descrip-
tion, and configurable parameters
about the SON module.
Create a SON module in- POST SON Module Man- Allows to create the SON module in-
stance agement stances on the EdenNet server.
Retrieve execution sta- GET SON Module Man- Allows to retrieve the status of the
tus of multiple module in- agement SON module instances based on cer-
stances tain filtering criteria specified in the re-
quest payload.

Retrieve execution sta- GET SON Module Man- Allows to retrieve the status of SON
tus of multiple module in- agement module instances based on certain fil-
stances result tering criteria specified in the request
payload.
Retrieve status of a spe- GET SON Module Man- Allows to retrieve the status of a spe-
cific module instance agement cific SON module instances.
Start a SON module PUT SON Module Man- Allows to start the SON module on the
agement EdenNet server.
Stop a module instance PUT SON Module Man- Allows to stop SON module instances
agement on the EdenNet server.
Retrieve a list of cells POST Cell Selection Allows to retrieves a list of cells based
on specified criteria.
Retrieve a list of pre-de- GET Cell Selection Allows to retrieves a list of pre-defined
fined clusters clusters.
Retrieve a list of cells re- GET Cell Selection Allows to retrieves a list of cell re-
sponse sponses.
Read performance met- POST Radio Access Net- Allows to reads performance metrics,
rics for cells request work Measurement both individual and handover related,
for cells.
Read performance met- POST Radio Access Net- Allows to reads performance metrics,
rics for cells result work Measurement both individual and handover related,
for cells.
Read neighbor list infor- POST Configuration man- Allows to read neighbor list informa-
mation of cells request agement for Radio tion of the cells and to define a filter
Access Network of neighbor types and direction to be
read.
Read neighbor list infor- GET Configuration man- Allows to read neighbor list informa-
mation of cells result agement for Radio tion of the cells.
Access Network
Read configuration man- POST Configuration man- Allows to read CM data from MO that
agement data for de- agement for Radio are descendant of a given MO in the
scendant managed ob- Access Network MO hierarchy.
jects request
Read configuration man- GET Configuration man- Allows to read CM data from MO that
agement data for de- agement for Radio are descendant of a given MO in the
Access Network MO hierarchy.

scendant managed ob-

jects result
Read distinguished GET Configuration man- Allows to retrieve the distinguished

names of the root level agement for Radio names of all the root level managed
managed objects Access Network objects.
Read configuration man- POST Configuration man- Allows to read CM data from any
agement data for individ- agement for Radio MOs. MOs are identified by DNs.
ual managed objects re- Access Network
quest
Write configuration man- POST Configuration man- Allows to write CM data to MO.
agement data to management for Radio
aged objects request Access Network
Write configuration man- GET Configuration man- Allows to write CM data to MO.
agement data to management for Radio
aged objects response Access Network
Check status of cache for POST Configuration man- Allows to check status of cache for
configuration manage- agement for Radio configuration management (CM) data.
ment data request Access Network
Table 2: API summary

SON Northbound Interface Guide DN09252603 1-0 SON NBI execution
3 SON NBI execution
The SON NBI specifications are as follows:
• All the relative endpoints described in the following sections are prefixed with:
https://<EdenNet GUI_SERVERS IP>/son-nbi/<API version>
EdenNet GUI_SERVERS IP can be IPv4 or IPv6 based on the EdenNet deployment mode.
If EdenNet is installed in IPv6 dual mode, then either GUI_SERVERS_IP or gui_external_ip is

used. The gui_external_ip is an IPv4 address, while GUI_SERVERS_IP is an IPv6 address.
• If the API returns a URL to the actual result, the user should not make any assumptions on how
the URL constructed nor try to use its sub-parts while implementing own business logic.
• Whenever a resource ID is mentioned (module_id, instance_id, uid, and so on) the user
should not make any assumptions about how it is constructed. It is guaranteed that it is a string
and it is unique.
• Each URL to the actual result is valid only for 12 hours or until it is used (which happens first).
• Each parameter that represents time is in UTC and follows the ISO 8601 format. For example,
2015-12-11T13:47:40Z, where Z represents the UTC time.
• For each API that requires a security token, the 401 error code is returned if the token is missing.
• For each API that requires authorization, the 403 error code is returned if the user does not have
sufficient rights to use this particular API.
• If the API returns an error, it is presented in the following JSON format:
{
"error_type":"<general type of an error, i.e. bad request>",
"error_details": [
"<error detail1>",
"<error detail2>",
...
]
}
3.1 SON NBI prerequisites

SON NBI prerequisites include:
• License details
• API versioning

3.1.1 License details
Table 3: SON NBI license lists the license required to access SON NBI in EdenNet.
Licensed feature compo- Licensed feature

LK item code LK item object name
nent code component name
ENSW7084CLK EdenNet SON NBI CLK 0000032188 EdenNet SON North-

bound API
Table 3: SON NBI license
For more details about licensing, see the License management section in the EdenNet User and Ad-
ministration Guide.
3.1.2 API versioning
SON NBI is versioned and its capabilities differ between versions.
Before using a particular capability, the user has to specify the version.
To check the available versions, make a HTTP GET call to:
https://<EdenNet GUI_SERVERS IP>/son-nbi/versions
where <EdenNet GUI_SERVERS IP> is the IPv4 or IPv6 address of the GUI Server.
The expected output is:
{
"version": ["v1"]
}
All further calls to SON NBI should contain the version prefix inside the URL to indicate which version
is used.
For example, to retrieve the list of installed SON Modules, make a HTTP GET call to:
https://<EdenNet GUI_SERVERS IP>/son-nbi/v1/modules
Note: Currently, only v1 version is supported.
3.2 API authentication

SON NBI is a secured interface. Before using any SON NBI capability, the user has to acquire a
security token that is used for further SON NBI operations. The /login endpoint allows an external
system to log in and obtain the security token which is used for subsequent API calls.

Table 4: /login resource information describes the /login endpoint resource information.
Resource URL /login
Method POST
Required header attribute Authorization: Basic <CREDENTIALS>
Table 4: /login resource information
1. In the address field of your Internet browser, type the following URL:
https://<EdenNet GUI_SERVERS IP>/son-nbi/<version>/login
For <version> component, see API versioning.
2. Make a HTTP POST request using the username and password embedded in the following
authentication header:
Authorization: Basic <CREDENTIALS>
where <CREDENTIALS> is Base64 encoded with <USER_NAME>:<PASSWORD>.
Note: The user name and password that are provided with basic authentication must be
valid (not expired).
3. To use the other resources available in the SON NBI, issue the HTTP header into the request:
Authorization: Bearer <TOKEN>
where <TOKEN> contains the value from the access_token field retrieved after successful
authentication.
For the /login endpoint payload and response examples, see API authentication example.
3.2.1 API authentication example
The response payload:
{
"access_token":"<token>",
"token_type":"bearer",
"expires_in":<expiration time in seconds>,
}
The user obtains the following responses if:
• Authentication is successful:
{
"access_token":"2YotnFZFEjr1zCsicMWpAA",
"token_type":"bearer",

"expires_in":3600,
}
• The request is missing a required parameter or includes an unsupported parameter value, no cre-
dentials, multiple credentials or malformed credentials:
{
"error_type":"invalid_request",
"error_details": [
"<error detail1>",
"<error detail2>"
]
}
• The user is not authorized:
{
"error_type":"invalid_client",
"error_details": [
"Invalid username or password"
]
}
3.3 Module management endpoints
3.3.1 Retrieve a list of pre-installed SON modules
The /modules endpoint allows an external system to retrieve a list of pre-installed SON module, so
that an external system can subsequently invoke them.
The endpoint requirements are:
• User authentication. For more information, see API authentication.
• The endpoint should be prefixed with:
https://<EdenNet GUI_SERVERS IP>/son-nbi/<API version> URL
Table 5: /modules resource information describes the /modules endpoint resource.
Resource URL /modules
Method GET
Required header attribute Authorization: Bearer <TOKEN>
Table 5: /modules resource information
For the /modules endpoint payload and response examples, see Examples.

3.3.1.1 Examples
Code 200
Content type application/json; charset=utf-8
Description Based on the security token generated by a given pair of user name and
password, EdenNet identifies the user and returns the list of the SON mod-
ules visible to the user. The same list is shown in the EdenNet GUI.
Note: The module ID is guaranteed to be unique, and might be

not only a number.
Privileges:
Users can see only the modules where they have open loop or closed loop
privileges. The privilege is assigned on a module basis.
Table 6: /modules endpoint response information
List of pre-installed SON modules request payload is presented in the format:
<module id>:<module name>
{
"45" : "ANR",
"18" : "CoverageCapacity",
"33" : "CrossedAntenna",
"48" : "LMSEnforcement",
"490" : "LTE_ANR_Cleanup",
"134" : "NeighborReports",
"578" : "ParamConsistChk",
"342" : "PCIReuse",
"987" : "SCReuse",
"487" : "SleepingCellResolution"
}
Code 403
Content type N/A
Description Forbidden if the user corresponding to the security token has only SON
Monitor privilege.
Table 7: /modules endpoint response information

3.3.2 Retrieve details about a specific SON module
The /modules/<module id> endpoint allows an external system to retrieve the version,
description, supported technologies, recurring type, and customizable parameters of a specified SON
module.

Table 8: modules/<module id> endpoint resource information describes the modules/<module id>
endpoint resource.
Resource URL /modules/<module id>
Method GET
Table 8: modules/<module id> endpoint resource information
For the /modules/<module id> endpoint payload and response examples, see Examples.
3.3.2.1 Examples
Code 200
Description The supported parameter types are described in the EdenNet

SON Module Development Guide.
Note: If the SON module privilege assigned to the

user for the requested module is Open Loop only, the
possible values for the SON Operation Mode para-
meter will contain only Open Loop.
Table 9: modules /<module id> endpoint response information
The /modules/<module id> request payload example:
{
"name": <name of the module>,
"version": <version number in string>,
"description": <Description text provided by the SON module>,
"technology": [<list of supported technology, e.g. GSM, UMTS and/or
LTE>],

"recurring": <Yes or No>,

"parameters": [<list of supported parameters, with each in a
dictionary format that describes all the necessary fields when defining
a SON module parameter.>]
}
The /modules/<module id> response example:
{
"name": "SCReuse",
"version": "4.2.1",
"description": "This module optimizes network cell neighbor relation.
",
"technology": ["GSM", "UMTS"],
"recurring": "Yes",
"parameters": [
{ "name": "Outperform_Multiplier",
"type": "ENET_PARAM_TYPE_FLOAT_RANGE",
"description": "The amount a cell has to outperform another
before it will be replaced.",
"unit": null,
"default_value": 2.0,
"possible_values": [1.50, 1.60, 1.70, 1.80, 1.90, 2.00]
},
{
"name": "Supported_Feature",
"type": "ENET_PARAM_TYPE_STRING",
"description": "The supported feature.",
"unit": null,
"default_value": "Optimization",
"possible_values": null
},
{ "name": "SON Operation Mode",
"type": "ENET_PARAM_TYPE_STRING",
"description": "SON Operation Mode.",
"unit": null,
"default_value": "Open Loop",
"possible_values": ["Open Loop", "Closed Loop"]
}]
}
Code 403
Content type N/A
Description Forbidden in following conditions:
• If the user corresponding to the security token has only SON

Monitor privilege.

• If the user does not have at least Open Loop privilege to this
module.
Table 10: modules /<module id> endpoint response information
3.3.3 Create a SON module instance
The /module-instances endpoint allows an external system to create SON module instances on
the EdenNet server.
https://<EdenNet-server-IP>/son-nbi/<API version> URL
Table 11: /module-instances endpoint resource information describes the /module-instances

endpoint resource.
Resource URL /module-instances
Method POST
Request payload type JSON
Table 11: /module-instances endpoint resource information
The payload should contain all the input parameters that the module needs before it can be run. For
the /module-instances endpoint payload and response examples, see Examples.
3.3.3.1 Examples
The /module-instances request payload example:
{
"module_id": <module id>,
"target": {
"type": <the selected target type: cell_uid, cluster_key, or cgi>,
"value": [<a list of cell uids, a cluster key, or a list of
cgi#technology>],
},
"parameters": {
<a dictionary of parameter names and their corresponding value>
},
"attachments": {

<a dictionary of attachment names and their corresponding base64-

encoded content>
},
"configurations": [
{
"type": <type of configuration, id or name>,
"category": <category of the configuration file>,
"config_id": <configuration id of the imported file if 'id' is
given as type >
"config_name": <configuration name of the imported file if 'name'
is given as type>
}
]
}
The /module-instances request example to specify a list of the cell UIDs as the target:
{
"module_id": "some_module_id",
"target": {
"type": "cell_uid",
"value": ["18", "29", "3432", "54522"]
},
"parameters": {
"Maximum number of SC retunes per sector per iteration": 50,
"Minimum SC collision score for SC retune": 30,
"HO Attempts maximum": 150,
"Cosector retune": "True",
"Allowable SC": "0:511",
"SON Operation Mode": "Open Loop"
}
}
The /module-instances request example to specify a cluster as the target:
{
"target": {
"type": "cluster_key",
"value": "module-targets.LTECCO_123.misc-cells"
},
"parameters": {
}

The /module-instances request example to specify a cgi as the target:
{
"target": {
"type": "cgi",
"value": [
"403-231-303-97#GSM",
"719-612-401-110#LTE"
]
},
"parameters": {
}
}
The /module-instances request example to create the module instance with an attachment. The
file content is encoded in base64 format:
{
"module_id": "some_other_module_id",
"target": {
"type": "cell_uid",
"value": ["18", "29", "3432", "54522"]
},
"parameters": {
"Market Level Configuration File (Optional)": "ParameterCheck_
template.xlsx",
"Maintenance Window Start Time": "1 AM",
"Report Prefix": "Parameter Consistency Check"
},
"attachments": {
"ParameterCheck_template.xlsx":
"b250ZW50IHRyYW5zZmVyIGVuY29kaW5nLg0KDQpCYXNlNjQgZW5jb2Rpbmcgc2NoZW1lcy
BhcmUgY29tbW9ubHkgdXNlZ"
}
}
The /module-instances request example to create the module instance by passing the config id of
the imported file.

"target": {
"type": "cell_uid",
"value": [
"403-231-303-97#GSM",
"719-612-401-110#LTE"
]
},
"configurations": [
{
"type": "id",
"category": "lms",
"config_id": 123
}
]
}
The /module-instances request example to create the module instance by passing the name of
the imported file.
{
"target": {
"type": "cell_uid",
"value": [
"403-231-303-97#GSM",
"719-612-401-110#LTE"
]
},
"configurations": [
{
"type": "name",
"category": "lms",
"config_name": "lms_all_pass.json"
}
]
}
Table 12: /module-instances response information describes the response information for different
codes.
Code Response payload Description
200 The /module-instances response payload: A new instance for the

selected module is creat-
{ ed.
"instance_id": <string text of the system
generated id forthe instance>,


"owner": <user name of the corresponding
user>,
"module": <Name of the SON module>
}
Response example:
{
"instance_id": "some_instance_id",
"owner": "johnd",
"module": "SCReuse"
}
400 The /module-instances response payload: The parameter names

are wrong or the re-
{ quired attachments part
"error_type": "invalid_request",
is missing.
"error_details": [
"<error detail1>",
"<error detail2>"
]
}
403 N/A Forbidden in the follow-

ing conditions:
• If the user corre-

sponding to the se-
curity token has on-
ly SON Monitor privi-
lege.
• If the user does not
have at least Open
Loop privilege to this
module.
• If the Closed Loop
is chosen and user
does not have the
Closed Loop privi-
lege to the module.
412 The /module-instances response payload: It is not allowed to create

module instance if there
{
"error_type": "precondition_failed",


"error_details": [ is no license installed for
"Module is not allowed to be it.
created / run.
Please check if license for it
is installed and valid."
]
}
Table 12: /module-instances response information
To start a SON module instance, continue with Start a SON module.
3.3.4 Retrieve execution status of multiple module instances
The /module-instances endpoint allows an external system to retrieve the status of SON module
instances based on certain filtering criteria specified in the request payload.

Table 13: /module-instances endpoint resource information describes the /module-instances

endpoint resource.
Resource URL /module-instances
Method GET
Table 13: /module-instances endpoint resource information
For the /module-instances endpoint payload and response examples, see Examples.
3.3.4.1 Available parameters

SON NBI parameters that are used as an operation and data filter.
Table 14: /module-instances available parameters describes the available parameters for the /
module-instances endpoint.
Parameter name Possible values Description
state created, scheduled, start- Indicates the current state of a SON

ed, active, idle, completed, module instance. If state filter is not
failed, stop_requested, stop-

Parameter name Possible values Description

ping, stopped, awaiting_user_ provided, only module instances that
input, provision_partial_suc- are in active state will be retrieved.
cess, provision_waiting, pro-
vision_ongoing
owner Any valid login name of an EdenNet Login name of an EdenNet user.
user.
module_id Any valid ID of a SON module. ID of a SON module. IDs of available

SON modules can be retrieved via /
modules endpoint.
time_range_start Time in UTC with format following the Retrieve instances which were cre-
ISO 8601 standard. ated after specific time in the past. If
not provided it will be set to 24 hours
before time_range_end. If time_
range_end is not provided it will last
for 24 hours.
time_range_end Time in UTC with format following the Retrieve instances which were creat-
ISO 8601 standard. ed before specific time in the past.
Table 14: /module-instances available parameters
3.3.4.2 Examples
The /module-instances request payload example:
?state=active&owner=johnd&module_id=some_module_id&time_range_start=2015-
11-26T13:54:03Z&time_range_end=2015-12-11T13:47:40Z
Table 15: /module-instances endpoint response information describes the /module-instances

response endpoint.
Code 200
Description OK.
Note: The user should use the resultURL provided to re-

trieve response data.
Payload content Response payload:
{
"resultURL": "<relative URL of where the next
set of data can be retrieved.>"

Response example:
{
"resultURL": "/module-instances/data/
53c1289727a69ae3bf1b52711d22647a"
}
Table 15: /module-instances endpoint response information
3.3.5 Retrieve execution status of multiple module instances result

The /module-instances/data/<result_id> endpoint allows an external system to retrieve the
status of SON module instances based on certain filtering criteria specified in the request payload. The
<result_id> is obtained from the API response described in Retrieve execution status of multiple
module instances section.
Table 16: /module-instances/data/<result_id> endpoint resource information describes the /module-

instances/data/<result_id> endpoint resource.
Resource URL /module-instances/data/<result_id>
Method GET
Table 16: /module-instances/data/<result_id> endpoint resource information
For the /module-instances/data/<result_id> endpoint payload and response examples, see

Example.
Note: This API gives a paginated response and maximum of 1000 module instances will be
returned per page based on the requested filters.
3.3.5.1 Example
Code 200

Description OK.
Note:
• The user should use the next URL provided to retrieve addi-
tional data.
• The next URL is not present if there is no next set of data to
be retrieved.
Table 17: /module-instances/data/<result_id> endpoint response information
The /module-instances/data/<result_id> response payload:
{
"data": [
{
"instance_id": <string text of the system generated
id forthe instance>,
"start_time": <UTC time following ISO 8601format,
indicating when the module instance is started>,
"launched_time": <UTC time following ISO 8601format,
indicating when the module instance executed first>,
"updated_time": <UTC time following ISO 8601 format,
indicating when the module instance state changed>,
"state": <state of the instance, e.g. active, idle,
completed, failed>,
"owner": <user name of the corresponding user>,
"module_id": <ID of the SON module>
},
...
],
"next": "<relative URL of where the next set of data can be retrieved.
>"
}
The /module-instances/data/<result_id> response example:
{
"data": [
{
"instance_id": "some_instance_id_1",
"start_time": "2015-12-11T13:47:40Z",
"launched_time" : "2015-12-11T13:57:40Z",
"updated_time" : "2015-12-11T14:47:40Z",
"state": "active",
"owner": "johnd",
"module_id": "some_module_id_1"
},

{
"instance_id": "some_instance_id_2",
"start_time": "2015-11-26T13:54:03Z",
"launched_time" : "2015-12-11T13:57:40Z",
"updated_time" : "2015-12-11T14:47:40Z",
"state": "completed",
"owner": "admin",
"module_id": "some_module_id_2"
],
"next": "/module-instances/data/94yc310927a69ae3bf1b52711d83211"
}
3.3.6 Retrieve status of a specific module instance
The /module-instances/<instance id>/status endpoint allows an external system to retrieve

the status of a specific SON module instances.
Table 18: /module-instances/<instance id>/status endpoint resource information describes the /

module-instances/<instance id>/status endpoint resource.
Resource URL /module-instances/<instance id>/status
Method GET
Table 18: /module-instances/<instance id>/status endpoint resource information
For the /module-instances/<instance id>/status endpoint payload and response examples,

see Example.
3.3.6.1 Example
Code 200
Description OK. Status of the particular module instance is shown.

Table 19: /module-instances/<instance id>/status endpoint response information
The /module-instances/<instance id>/status response payload:
{
"instance_id": <string text of the system generated id forthe
instance>,
"start_time": <UTC time following ISO 8601format, indicating when
the module instance is started>,
"launched_time": <UTC time following ISO 8601format, indicating when
the module instance executed first>,
"updated_time": <UTC time following ISO 8601 format, indicating when
the module instance state changed>,
"state": <state of the instance, e.g. created, active, idle,
completed, failed>,
"owner": <user name of the corresponding user>,
"module_id": <ID of the SON module>
}
The /module-instances/<instance id>/status response example:
{
"instance_id": "some_instance_id",
"start_time": "2015-12-11T13:47:40Z",
"launched_time" : "2015-12-11T13:57:40Z",
"updated_time" : "2015-12-11T14:47:40Z",
"state": "active",
"owner": "johnd",
"module_id": "some_module_id"
}
3.3.7 Retrieve the list of output files produced by a specific SON module instance
The /module-instances/<instance id>/output endpoint allows an external system to retrieve
the list of output files produced by a specific SON module instance based on certain filtering criteria
specified in the request payload.

Table 20: /module-instances/<instance id>/output endpoint resource information describes the /

module-instances/<instance id>/output endpoint resource.
Resource URL /module-instances/<instance id>/output

Method POST
Required header attribute Authorization: Bearer <TOKEN>X-HTTP-Method-

Override: GET
Table 20: /module-instances/<instance id>/output endpoint resource information
For the /module-instances/<instance id>/output endpoint payload and response examples,

see Examples.
3.3.7.1 Examples
The /module-instances/<instance id>/output request payload:
{
"name_pattern" : [<list of file name patterns>],
"age": <number of hours that has been passed since the output files
were created>
"limit": Limit on number of entries to fetch .
}
Note: The name_pattern, age, and limit fields are optional. By default, 1000 entries are
returned.
The /module-instances/<instance id>/output request payload example:
{
"name_pattern" : ["resu*.xlsx", "issue*.csv"],
"age" : 0,
"limit" : 1000
}
Note:
• Only wild card (*) is supported for file name pattern.

• Age '0' means files that have been created in less than an hour. Number of hours is
always rounded down. If 1.7 is given as the value for age, then it is considered as 1.
• The file names are displayed based on descending order of time.
Code 200
Payload content {"resultURL": "/module-instances/output/data/

e9cc018f9fee6af8e6f9ed09cd8d5309"}

Note: The client must use the resultURL URL to retrieve the re-
sponse data.
The /module-instances/<instance id>/output response payload:
{
"data": {
"<file ID 1>" : {
"name": "<File_Name>",
"creation_time": "<File
Creation Time"
},
"<file ID 2>" : {
"name": "<File_Name>",
"creation_time": "<File
Creation Time"
},
...
},
"next": "<relative URL of where the next set of
data can be retrieved>"
}
The /module-instances/<instance id>/output response example:
{
"data": {
"bd1ab4d0-6a01-4193-b71b-e241545f2413": {
"name": "MLB_LTE_20201125200838.xlsx",
"creation_time": "2020-11-25T18:08:40.
78103Z"
},
"16a116de-684f-4795-a078-4464eae5a2e6": {
"name": "MLB_LTE_20201125202339.xlsx",
"creation_time": "2020-11-25T18:23:42.
157619Z"
}
},
"next": "/module-instances/output/data/
4ffbb62b7ef044058a5c5776b8e11aa4"
}
Description OK.
Performing GET on resultURL returns the actual result.
Note:
• The file IDs are temporary, which expires after one hour.

• The client should use the next URL to retrieve additional data.
• The next URL will not be present if there is no next set of data
to be retrieved.
• The data URL is relative to the original API path (https:/
/<Eden-NET-server-IP>/son-nbi/v1/module-
instances/<instance id>/output).
Table 21: /module-instances/<instance id>/output response information
3.3.8 Retrieve specific output file produced by a SON module instance
The /module-instances/<instance id>/output/<output file id> endpoint allows an

external system to retrieve a specific output file produced by a specific SON module instance.
Table 23: /module-instances/<instance id>/output/<output file id> response information describes the /
module-instances/<instance id>/output/<output file id> endpoint resource.
Resource URL /module-instances/<instance id>/output/<output

file id>
Method GET
Table 22: /module-instances/<instance id>/output/<output file id> endpoint resource information
For the /module-instances/<instance id>/output/<output file id> endpoint payload

and response examples, see Examples.
3.3.8.1 Examples
Table 23: /module-instances/<instance id>/output/<output file id> response information describes the
response information for different codes.
Code Content type Response payload Description
200 The content of the output file OK.

application/
octet-stream The content type
or of the file can be
application/

Code Content type Response payload Description

text/ octet-stream
html;charset=utf- or text/
8
html;charset=utf-8,
or
depending on the
application/
json; output file.
charset=utf-8
or
application/
xml;
charset=utf-8
404 The module-instances/<instance As the file ID returned

application/
id>/output/<output file id> re- from the /module-in-
json;
sponse payload: stances/<instance
charset=utf-8
id>/output API is
{ temporary, the file ID
"error_type": "not_
can expire and the cor-
found",
responding file can be
"error_details": [
"<Error message not found.
indicating that the file
for the requested file ID
is not found>"
]
}
The module-instances/<instance
id>/output/<output file id> re-
sponse example:
{
"error_type": "not_
found",
"error_details": [
"File for file ID
25x00xj674kbpqwt is not
found."
]
}
]
}
Table 23: /module-instances/<instance id>/output/<output file id> response information

3.3.9 Start a SON module
The /module-instances/<instance id>/start endpoint allows an external system to start

a previously created SON module instance on the EdenNet server. For information on creation of
module instances, see Create a SON module instance.
Table 24: /module-instances/<instance id>/start endpoint resource information describes the /

module-instances/<instance id>/start endpoint resource.
Resource URL /module-instances/<instance id>/start
Method PUT
Table 24: /module-instances/<instance id>/start endpoint resource information
Table 25: /module-instances/<instance id>/start response information describes the response

information with different codes.
Code Description
200 Start of the instance for the selected module is successfully requested. It starts as
soon as possible but the exact time is unknown.
403 Not allowed if:
• The user corresponding to the security token is different from the one who cre-
ated the instance, unless the user has Super User or Administrator role.
• The user has only SON Monitor privilege.
• The user does not have at least open loop privilege to this module.
• The closed loop is chosen and the user does not have the closed loop privi-
lege to the module (SON Operation Mode parameter).
412 If the module instance is not started and the license is not installed, then the API
call sends the following response:
{
"error_type": "precondition_failed",
"error_details": [
"Module is not allowed to be created / run.
Please check iflicense forit is installed and
valid."

Code Description
]
}
Table 25: /module-instances/<instance id>/start response information
3.3.10 Stop a module instance
The /module-instances/<instance id>/stop endpoint allows an external system to stop SON

module instances on the EdenNet server.
• The following are the endpoint should be prefixed with:
Table 26: /module-instances/<instance id>/stop endpoint resource information describes the /

module-instances/<instance id>/stop endpoint resource.
Resource URL /module-instances/<instance id>/stop
Method PUT
Table 26: /module-instances/<instance id>/stop endpoint resource information
Code Description
200 Instance stopped.
403 Forbidden if:
• The user corresponding to the security token is different than the one who
created the instance, unless the user has Super User or Administrator role.
• The user has only SON Monitor privilege.
Table 27: /module-instances/<instance id>/stop response information
3.4 Cell selection endpoints

3.4.1 Retrieve a list of cells
The /cells endpoint allows an external system to retrieve a list of cells and the selected parameters
of these cells based on a set of filtering criteria specified in the request payload. The list of cells can be
used as the SON module execution target.
The endpoint execution requirements are:
Table 28: /cells endpoint resource information describes the /cells endpoint resource.
Resource URL /cells
Method POST
Required header attribute Authorization: Bearer <TOKEN> X-HTTP-Method-

Override: GET
Required parameters For more information, see Available parameters
Table 28: /cells endpoint resource information
For the /cells endpoint payload and response examples, see Example.

Table 29: /cells available parameters describes the available parameters for the /cells endpoint.
Parameter name Description Data type
uid Unique identifier for a cell that should stay string

the same across rehomes.
dn Distinguished name of the cell. string
label Cell label, or the cell name. string
mcc MCC of the cell. integer
mnc MNC of the cell. integer
cell_id Cell ID integer
oss_name Name of the OSS where the cell is an inter- string

nal cell, if known.

lac LAC of a GSM cell. integer
lac_umts LAC of a UMTS cell. integer
bcc BCC of a GSM cell. integer
ncc NCC of a GSM cell. integer
bcch_frequency BCCH frequency of a GSM cell. integer
bsc_name Name of the cell's BSC. string
bsc_dn DN of the cell's BSC. string
uarfcn UARFCN of a UMTS cell. integer
pri_scr_code Primary scrambling code of a UMTS cell. integer
rnc_name Name of the cell's RNC. string
rnc_dn DN of the cell's RNC. string
tac TAC of the LTE cell. integer
Note: The tac parameter is dep-

recated from EdenNet 21 release
onwards.
tacs Tracking Area Code (TAC) for LTE, 4G- list

NBIoT, and NR cells. There can be multiple
tac values for a 5G cell. Response format:
[{"tac":<tac value>, "tac_type": <type>}]
tac_type:
0 - indicates tac towards 4G core
1 - indicates tac towards 5G core
earfcn EARFCN of an LTE cell. integer
pci PCI of an LTE cell. integer
latitude Latitude of the cell. decimal degree between -90.

00 and 90.00. Maximum dec-
imal precision is 7 digits, for
example, 20.1234567.
longitude Longitude of the cell. decimal degree between

-180.00 and 180.00. Max-
imum decimal precision is


7 digits, for example, 120.
1234567.
site_name Name of the cell site. string
technology Cell technology ("GSM", "UMTS", "LTE", string

"4G-NBIoT", or "NR").
azimuth Cell azimuth integer degree between 0

and 360
ran_version Version of a network element. string
Applicable only for Nokia (it contains adap-

tation version).
managing_oss Name of the OSS which manages this cell. string
rsi Root Sequence Index of an LTE cell. integer
Supported only for Nokia vendor.
Table 29: /cells available parameters
3.4.1.2 Example
The /cells request payload:
{
"lookup_filters": {
"parameters": {
"<parameter name 1>": [list and/or ranges of values],
"<parameter name 2>": [list and/or ranges of values],
...
},
"bounds": {
"top":<latitude value in decimal degree>,
"left":<longitude value in decimal degree>,
"bottom":<latitude value in decimal degree>,
"right":<longitude value in decimal degree>
}
},
"result_filters": [<list of parameters to be retrieved for each
cell>]
}

Note: All parameters are optional. If result_filters is omitted all supported parameters
are returned. For available parameters that can be used as a lookup filter and/or a return
value, see Available parameters .
The /cells request example:
{
"lookup_filters": {
"parameters": {
"lac": 17,
"pci": [315,316],
"earfcn": {"from": 2225, "to": 2350}
},
"bounds": {
"top": 41.70,
"left": -87.78,
"bottom": 41.69,
"right": -87.73
}
},
"result_filters": ["uid", "pci","earfcn","lac","latitude",
"longitude", "dn", "label"]
}
Note:
• The bounds filter parameter is for defining a bounding box on the map. The filter
parameter top and left form the latitude and longitude of the top-left corner of the
bounding box, while the filter parameter bottom and right form the latitude and
longitude of the bottom-right corner of the bounding box. All cells returned from the
queried must be within the bounding box.
• The values used for the bounds filter parameters are in decimal degree. It means that
they are decimal numbers between -90.00 and 90.00 latitude value and between -180.00
and 180.00 longitude value.
• In lookup_filters, all parameter names are joined with a logical AND operator, while
the list of values specified for each parameter name are joined with a logical OR operator.
It means that all cells returned must fulfill at least one of the values specified for each
parameter. If the API is called with the provided example payload, only cells returned
must fulfill the criteria:
– The cells are within the defined bounds (top-left: latitude: 41.70, longitude: -87.78,
bottom-right: latitude: 41.69, longitude: -87.73) AND
– the cells' PCI is either 315 or 316, AND
– the cells' earfcn is between 2225 (inclusive) and 2350 (inclusive).
• When the information of the cells are returned, only information for pci, earfcn, lac,
latitude, longitude are returned. The cell UID is returned by default.

Code 200
Description OK.
Note:
• The response URL is relative to https://<EdenNet-serv-

er-IP>/son-nbi/v1
• The user should use the resultURL URL provided to retrieve re-
sponse data.
Payload content The /cells response payload:
{
"resultURL": "<relative URL of where the result can
be retrieved.>"
{
The /cells response example:
{
"resultURL": "/cells/data/
53c1289727a69ae3bf1b52711d22647a"
}
where 53c1289727a69ae3bf1b52711d22647a is a request ID to be used in

the Retrieve a list of cells response endpoint.
Note: The format of the resultURL is the same as the API. The user
should use the resultURL URL provided to retrieve response data.
Table 30: /cells endpoint response information
3.4.2 Retrieve a list of cells response
The /cells/data/<request_id> endpoint allows to retrieve a list of cells response following the
call to the Retrieve a list of cells endpoint.

Table 31: /cells/data/<request_id> endpoint resource information describes the /cells/data/

<request_id> endpoint resource.
Resource URL /cells/data/<request_id>
Method GET
Table 31: /cells/data/<request_id> endpoint resource information
For the /cells/data/<request_id> endpoint payload and response examples, see Example.
Note: This API gives a paginated response and maximum of 1000 cells per page will be
returned with the requested attributes.
3.4.2.1 Example
Code 200
Description OK. All the cells that fulfill the filtering criteria, along with the requested cell
parameters.
Table 32: The /cells/data/<request_id> endpoint response information
The /cells/data/<request_id> response payload:
{
"data": [
<dictionary of parameter name and value pairs for cell
1>,
<dictionary of parameter name and value pairs for cell
2>,
...
],
>"
{
The /cells/data/<request_id> request example:
{
"data": [
{
"uid": "19525",
"pci": 316,
"earfcn": 2350,

"lac": null,
"latitude": 41.6957,
"longitude": -87.76053,
"oss_data": [
{
"oss_name": "c2oss",
"dn": "PLMN-PLMN/MRBTS-21321/LNBTS-21321/LNCEL-2",
"label": "LCH45726A21"
},
{
"oss_name": "syooss",
"dn": "PLMN-PLMN/EXCC-1/EWCE-22582",
"label": "some_other_label"
}
]
},
{
"uid": "19526",
"pci": 315,
"earfcn": 2350,
"lac": null,
"longitude": -87.76053,
"oss_data": [
{
"oss_name": "c2oss",
"dn": "PLMN-PLMN/MRBTS-21321/LNBTS-21321/LNCEL-1",
"label": "LCH45726A11"
}
]
}
],
"next": "/cells/data/94yc310927a69ae3bf1b52711d83211"
}
Note:
• Since lac is not applicable to LTE cells, null is returned.

• The user should use the next URL provided to retrieve additional data.
• The next URL is not present if there is no next set of data to be retrieved.
• The next URL is valid for 12 hours since requesting data. Then, it is removed due to
purging feature.
• When dn or label is requested oss_data section is added which represents OSS
specific information of a cell. oss_data might contain information from several OSSes if
a particular cell (identified by UID) was found in those OSSes.

3.5 Cluster management
3.5.1 Retrieve a list of pre-defined clusters
The /clusters endpoint allows an external system to retrieve a set of predefined clusters so that
external system can subsequently use one of the clusters as the SON module execution target.
Table 33: /clusters endpoint resource information describes the /clusters endpoint resource
information.
Resource URL /clusters
Method GET
Table 33: /clusters endpoint resource information
For the /clusters endpoint payload and response examples, see Example.
3.5.1.1 Example
Code 200
Description OK.
Based on the security token generated by a given pair of user

name and password, EdenNet identifies the user, and returns all
the shared clusters irrespective of the user and private clusters
for a particular user.
The cluster ID is guaranteed to be unique.
Table 34: Example of the /clusters endpoint response information
The /clusters response payload:
{
"<cluster key 1>": "<cluster name 1>",


....
}
The /clusters response example:
{
"10": "My sub-urban cluster",
"8": "My seashore cluster",
"some-cluster-key": "My city cluster",
}
Also, the response can be empty:
{ }
3.6 Measurements for Radio Access Network
3.6.1 Read performance metrics for cells request
The /cells/pm endpoint allows an external system to read performance counters, both individual
and handover, related to the cells. This also includes reading performance counters derived from
Ericsson GPEH data by EdenNet, as well as KPIs derived from raw performance counters by
EdenNet.
Table 35: /cells/pm endpoint resource information describes the /cells/pm endpoint resource.
Resource URL /cells/pm
Method POST

Override: GET

Table 35: /cells/pm endpoint resource information
For the /cells/pm endpoint payload and response examples, see Example.
3.6.1.1 Example
The /cells/pm request payload:
{
"cells": {
"type": <the selected type of cell grouping. cell_uid or cluster_
key>,
"value": [<a list of cell UIDs or a cluster_key>]
},
"pm": [<comma separated list of performance metrics(cell or handover
related raw counters, KPI or GPEH derived counters) identified by
names>],
"time_range": { "start": <start time(older) of the time range>,
"end": <end time(more recent) of the time range> }, // defining the
time range of the data. Time is in UTC with format following ISO 8601
standard.
"resolution": <One of the resolutions supported by EdenNet.
Supported resolutions: 1(15-minute), 2(Hourly), 3(Daily), 4(5-minute),
5(30-minute)>,
"aggregation": "<One of the aggregation type: 0(No aggregation),
1(Aggregation acrosstime for individual cells), 2(Aggregation across
cells for each timestamp)>"
}
Note:
• The list of cell UIDs or a cluster_key must be present in the request.

• The list of performance metrics must be present.
• The value for time range is optional. If it is not provided, the default time range is the
recent 24 hours.
• The value for resolution is optional. If it is not provided, default resolution is hourly.
• The value for aggregation is optional. If it is not provided, the default is no
aggregation. Also, aggregation across the cells is only valid when all the cells
represented by the UIDs are from the same RAN vendor and the same RAN version.
Example 1: The /cells/pm request
{
"cells": {
"type": "cell_uid",
"value": ["24","4234","980"]
},

"pm": ["pmTotNoRrcConnectReq", "Voice Dropped Call Rate",

"pmAverageRssi", "Intra_HO_Attempts"],
"time_range": { "start": "2015-11-26T13:54:03Z", "end": "2015-12-
11T13:47:40Z"},
"resolution": 1,
"aggregation": 1
}
Example 2: The /cells/pm request
{
"cells": {
"type": "cluster_key",
"value": "23423"
},
"pm": ["pmTotNoRrcConnectReq", "Voice Dropped Call Rate",
"pmAverageRssi", "Intra_HO_Attempts"],
"time_range": { "start": "2015-11-26T13:54:03Z", "end": "2015-12-
11T13:47:40Z"},
"resolution": 1,
"aggregation": 1
}
Limitations:
• The cell UIDs have to be under one region. If the cells or a cluster are not from one region, the
request is rejected with status code 400 and a message. If the cells have no region information
available, they are filtered out from the request. Information about filtered out UIDs is returned in
the service response. If all the cells are filtered out, the status code 400 and a message with the
reasoning appears.
Note: Currently, a region contains the data only from one OSS.
• In case of aggregation over the cells (example 2), all the cells must have the same RAN version,
and the service responses are the same as non-aggregated requests, as shown below.
Code 200
Description OK.
The user should use the resultURL URL provided to retrieve result data.
The resultURL is valid only for 12 hours since requesting data due to
purging feature.

Table 36: /cells/pm endpoint response information
The /cells/pm response payload:
{
"resultURL": "<an URL for the client to read result of the request>",
"warnings": {
"missing_region_info": [<list of skipped uids forwhich region
information is missing>],
"missing_ran_version": [<list of skipped uids forwhich ran
version is missing>],
"invalid_uids": [<list of skipped uids which are forother reasons
invalid>]
}
}
The /cells/pm response example:
{
"resultURL": "/cells/pm/data/3553",
"warnings": {
"missing_region_info": ["11", "137"],
"missing_ran_version": ["456"],
"invalid_uids": []
}
}
3.6.2 Read performance metrics for cells result
The /cells/pm/data/<request_id> endpoint allows an external system to retrieve data made by

the previous requests, for example, by the /cells/pm request.
Table 37: /cells/pm/data/<request_id> endpoint resource information describes the /cells/pm/

data/<request_id> endpoint resource.
Resource URL /cells/pm/data/<request_id>
Method GET

Table 37: /cells/pm/data/<request_id> endpoint resource information
For the /cells/pm/data/<request_id> endpoint payload and response examples, see Example.
Note: This API gives a paginated response and maximum of 5000 PM data samples per
page will be returned. Number of data samples in the given time range multiplied number of
requested KPIs should be less than 5000.
3.6.2.1 Example
The user gets the following responses if:
• In general:
{
"status": "<One of the available status strings: completed, waiting,
timeout, error>",
"error_message": "<Detail of the error if the status is error.>",
"data": "<data object in a format depending on aggregation type -
see below>",
"next": "<relative URL of where the next set of data can be
retrieved.>"
}
Note: The error_message field is present only when there is an error retrieving the
status. The data is present only when the status is completed. The next is present
only when the status is completed and there is next page of data available.
• The data is not yet available:
Result code 202
Content Type application/json; charset=utf-8
Description Request is accepted. When the service expects to take longer

than usual to process the request, it returns status 202 and
the user should check for the result later.
Table 38: /cells/pm/data/<request_id> response information
The /cells/pm/data/<request_id> response if the data is not available yet:
{
"status": "waiting"
}
• The data is available:
Result code 200

Description The requested performance metric data.
Table 39: /cells/pm/data/<request_id> response information
The /cells/pm/data/<request_id> response payload if there is no aggregation or aggregation

across time for individual cells:
Note: Aggregation over time does not have multiple data points.
{
"status": "completed",
"data": {
"oldest_sample_time": "<UTC time of the oldest sample in the data
with format following ISO 8601 format>",
"newest_sample_time": "<UTC time of the newest sample in the data
Supported resolutions: 1(15-minute), 2(Hourly), 3(Daily)>,
"number_of_samples": <number of sample in the data>,
"aggregation": <0(No aggregation) or 1(Aggregation across time
forindividual cells)>,
"result": {
"<cell UID 1>": {
"<metric name 1>": {
"type": <Type of the PM data returned, 1: single
number, 2: Probability Distribution Function, 3: Handover, 4: Detected
Set Report>,
"data": [<an ordered list of sample data with
each sample corresponding to a timestamp, starting from the oldest
timestamp>],
"missing_pegs_detail": [<an ordered list of
dictionaries formissing peg counts, starting from the oldest timestamp>]
},
Set Report>,
timestamp>],
},
...
},

"<cell UID 2>": {

Set Report>, [<an ordered list of sample data with each sample
corresponding to a timestamp, starting from the oldest timestamp>],
"missing_pegs_detail": [<an ordered list of dictionaries
formissing peg counts, starting from the oldest timestamp>]
}, "<metric name 2>": { "type": <Type
of the PM data returned, 1: single number, 2: Probability Distribution
Function, 3: Handover, 4: Detected Set Report>,
timestamp>],
},
...
},
...
}
},
retrieved.>"
}
The /cells/pm/data/<request_id> response example if there is no aggregation or aggregation

across time for individual cells:
{
"data": {
"oldest_sample_time": "<2015-11-26T13:00:00Z>",
"newest_sample_time": "<2015-11-26T14:00:00Z>",
"resolution": 1,
"number_of_samples": 5,
"aggregation": 0,
"result": {
"24": {
"pmTotNoRrcConnectReq": {
"type": 1,
"data": [45,234,847,100,null],
"missing_pegs_detail": [{},{},{},{},
{pmTotNoRrcConnectReq:100}]
},
"Voice Dropped Call Rate": {
"type": 1,
"data": [0.045,null,0.02,null,0.011],

"missing_pegs_detail": [{},{pmAverageRssi:100},{},{},
{}]
},
"pmAverageRssi": {
"type": 2
"data": [ [1,3,0,5], null, [1,3,0,5], [1,3,10,15], [11,
31,0,5] ],
{}]
"Intra_HO_Attempts": {
"type": 2,
"data": [ {"234":100, "576":200}, {"234":100,
"376":200}, null, {"234":100, "576":200}, null],
"missing_pegs_detail": [{},{},{pmIAFAtt:100},{},
{pmIAFAtt:100}]
}
},
"4234": {
"type": 1,
"data": [45,234,847,null,100],
"missing_pegs_detail": [{},{},{},
{pmTotNoRrcConnectReq:100},{}]
},
"type": 1,
"data": [0.045,null,0.02,0.011,null],
"missing_pegs_detail": [{},{pmNumDrop:100},{},{},
{pmNumDrop:100}]
},
"pmAverageRssi": {
"type": 2,
"data": [ [1,3,0,5], [1,3,0,5], null, [1,3,10,15],
[11,31,0,5] ],
"missing_pegs_detail": [{},{},{pmAverageRssi:100},{},
{}]
},
"type": 2,
"data": [ {"234":100, "576":200}, {"234":100,
"376":200}, {"234":100, "576":200}, null, null],
"missing_pegs_detail": [{},{},{},{pmIAFAtt:100},
{pmIAFAtt:100}]
}
},
"980": {
"type": 1,
"data": [45,234,847,100,null],

"missing_pegs_detail": [{},{},{},{},
{pmTotNoRrcConnectReq:100}]
},
"type": 1,
"data": [0.045,null,0.02,null,0.011],
"missing_pegs_detail": [{},{pmNumDrop:100},{},
{pmNumDrop:100, pmNumCall:100},{}]
},
"pmAverageRssi": {
"type": 2,
"data": [ [1,3,0,5], null, [1,3,0,5], [1,3,10,15],
[11,31,0,5] ],
{}]
},
"type": 2,
"data": [ {"234":100, "576":200}, {"234":100,
"376":200}, null, {"234":100, "576":200}, null],
"missing_pegs_detail": [{},{},{pmIAFAtt:100},{},
{pmIAFAtt:100}]
}
}
}
},
retrieved.>"
}
The /cells/pm/data/<request_id> response if aggregation across cells is used:
{
"data": {
"oldest_sample_time": "<UTC time of the oldest sample in the data
"newest_sample_time": "<UTC time of the newest sample in the data
Supported resolutions: 1(15-minute), 2(Hourly), 3(Daily)>,
"number_of_samples": <number of sample in the data>,
"aggregation": 2,
"result": {
"type": <Type of the PM data returned, 1: single number,
2: Probability Distribution Function, 3: Handover, 4: Detected Set
Report>,

"data": [<an ordered list of sample data with each sample

},
"type": <Type of the PM data returned, 1: single number,
2: Probability Distribution Function, 3: Handover, 4: Detected Set
Report>,
"data": [<an ordered list of sample data with each sample
},
...
}
},
retrieved.>"
}
The /cells/pm/data/<request_id> response example with aggregation across cells for each
timestamp:
{
"data": {
"oldest_sample_time": "2015-11-26T13:00:00Z",
"newest_sample_time": "2015-11-26T14:00:00Z",
"resolution": 1,
"number_of_samples": 5,
"aggregation": 0,
"result": {
"type": 1,
"data": [135,702,2541,200,100],
"missing_pegs_detail": [{},{},{},
{pmTotNoRrcConnectReq:33},{pmTotNoRrcConnectReq:67}]
},
"type": 1,
"data": [0.045,null,0.02,0.011,0.011],
"missing_pegs_detail": [{},{pmNumDrop:100},{},
{pmNumDrop:67, pmNumCall:67},{pmNumDrop:33, pmNumCall:33}]
},
"pmAverageRssi": {
"type": 2,
"data": [ [3,9,0,15], [1,3,0,5], [2,6,0,10], [3,9,30,45],
[33,93,0,15] ],

"missing_pegs_detail": [{},{pmAverageRssi:67},
{pmAverageRssi:33},{},{}]
},
"type": 2,
"data": [ { "24":{"234":100, "576":200}, "980":{"234":100,
"576":200}, "4234":{"234":100, "576":200} }, { "24":{"234":100,
"376":200}, "980":{"234":100, "376":200}, "4234":{"234":100, "376":200}
}, {"4234":{"234":100, "576":200}}, { "24":{"234":100, "576":200}, "980":
{"234":100, "576":200} }, null],
"missing_pegs_detail": [{},{},{pmIAFAtt:67},{pmIAFAtt:33},
{pmIAFAtt:100}]
}
}
},
retrieved.>"
}
Note:
• Depending on the time range and the resolution specified in the request payload, the
service calculates the appropriate start time of the data samples and the number of
samples returned in the response. To make sure that all samples are within the specified
time range, the following conditions must be applied:
– T0 is the start of the time_range in the request payload.

– T1 is the end of the time_range in the request payload.
– R is the resolution in the request payload.
– T2 is the oldest_sample_time in the response payload.
– T3 is the oldest_sample_time in the response payload that is calculated
according to the formula:
T3 = T2 + ( resolution x (number_of_samples-1) ).
– The condition T0 <= T2 <= T3 <= T1 must be true.
• Depending on the performance metrics requested, multiple data types can be returned:
– Single value: each sample is a number within the applicable range of the
performance metric requested. The number might or might not have decimals.
– Probability Distribution Function (PDF): each sample is a list of numbers within the
applicable range of the performance metric requested. The number may or may not
have decimals. The size of the list depends on the performance metrics requested.
The format is [val_1, val_2, val_3,....].
For example, data: [5, 56, 48,....].
– Handover: each sample is a dictionary with the cell UIDs of the handover targets as
keys and the handover metric towards a target cell as values.

The format is {uid_1:val_1 , uid_2:val_2, uid_3:val_3,....}.
For example, data: {354:2, 5453:10, 834:8452}.
– Detected Set Report (DSR): this is a data type that is specific to the 3G detected set
report. Each sample is a dictionary with scrambling codes as keys and detected set
report measurement data against a scrambling code as values.
The format is: {sc_1:val_1, sc_2:val_2, sc_3:val_3,....}.
It looks similar to the handover type, except that the keys of the dictionary are
scrambling code instead of the cell UIDs.
For example, data: {34:2, 54:10, 83:8452}.
• The field data contains an ordered list of samples. Each sample corresponds to a
timestamp within the specified time range. The timestamp of each sample is aligned with
the resolution.
For example, if the value for data is [5, 56, 48], the oldest_sample_time is
2015-11-26T13:00:00Z and the resolution is 15-minute, the numbers 5, 56 and 48
correspond to the sample at 2015-11-26T13:00:00Z, 2015-11-26T13:15:00Z, and
2015-11-26T13:30:00Z respectively.
• If the performance metric corresponding to the particular timestamp is missing, not
available yet, or cannot be calculated, the entry corresponding to the timestamp in data
is a JSON null value or zero, depending on the KPI type. For example, the data will look
like [5, 56, null, 98,...].
• The missing_pegs_detail field allows the user to evaluate the data quality
of the samples. The value for this field is an ordered list of dictionaries, with each
dictionary corresponding to a particular timestamp in the same manner as the samples
corresponding to the timestamps in data.
The dictionary is in the format {peg_1:%_missing_1, peg_2:%_missing_2, peg_3:

%_missing_3,....}.
For example, the dictionary for one timestamp may look like {"peg_1":50, "peg_2":25,
"peg_3":100,....}. It implies that peg_1 is missing data 50% of the time, or 1 out of
every 2 samples during the specified time range. Peg_2 is missing data 1 out of every
4 samples and peg_3 has no data at all. If the aggregation type is 0, meaning no
aggregation, any missing peg will have a value of 100 because for the given timestamp,
the peg is missing. If the aggregation type is across time, it is possible that the % missing
is between 0 and 100. If a peg count does not have missing data, it is not shown in the
dictionary. If no missing peg is shown for a particular timestamp, the dictionary for that
timestamp is empty.
• If the aggregation type specified in the request payload is 1 (aggregation across time
for individual cells), the number_of_samples is 1, and the size of the lists for data and
missing_pegs_detail are equals to 1. Otherwise, the size of the lists is the value
specified in number_of_samples.

• If the aggregation type specified in the request payload is 1 (aggregation across time
for individual cells) and the value for data is [null/zero], there is no data for the particular
performance metric of the particular cell during the specified time range.
• If the aggregation type is 2 (aggregation across cells for each timestamp), handover
and DSR type of data are aggregated by combining the dictionaries, instead of
aggregating the values in the dictionaries.
• If the aggregation type is 2 (aggregation across cells for each timestamp), the %
missing in missing_pegs_detail should be interpreted as % of cells out of the
specified UIDs that are missing data for the peg count.
Limitations:
• missing_pegs_detail node of the response, contains the missing pegs names, yet
the percentage indicator is not valid yet. The value is always 100, so it does not reflect
how much data is actually missing and should not be used.
• type of a metric has the value -1 (instead of regular 1-4 values) for raw peg counters.
3.7 Configuration management for Radio Access Network
3.7.1 Read neighbor list information of cells request
The /cells/neighbors endpoint allows an external system to read neighbor list information of the
cells. The API also allows to define a filter of neighbor types and direction to be read.
Table 40: /cells/neighbors endpoint resource information describes the /cells/neighbors endpoint
resource.
Resource URL /cells/neighbors
Method POST

Override: GET
Required parameters See Available parameters

Table 40: /cells/neighbors endpoint resource information
For the /cells/neighbors endpoint payload and response examples, see Example.

Table 41: /cells/neighbors available parameters describes the available parameters for the /cells/
neighbors endpoint.
Parameter Possible val-

Data type Description
name ues
source_ string cell_uid or The selected type of source cell grouping.

group_type cluster_key
Note: This is a mandatory parameter.
source_ list of A list of cell Defines the source cells and the neighbors that should
group_value strings or UIDs or a clus- be returned.
string ter key
Limitation:
Currently all the requested UIDs have to belong to

the same OSS. Similarly, if the request is related to
cluster_key then all cells in the requested cluster
have to belong to the same OSS.
Note: This is a mandatory parameter. For

more information on how to fetch the clus-
ter_key value, see Retrieve a list of pre-
defined clusters.
neighbor_ list of intra, inter, Types of the neighbors that should be returned:
type strings irat
• intra – Intra-Frequency, intra-technology (GSM-
>GSM, UMTS->UMTS, LTE->LTE)
• inter – Inter-Frequency, intra-technology (UMTS-
>UMTS, LTE->LTE)
• irat – Inter-technology (GSM->UMTS, GSM->LTE,
UMTS->GSM, UMTS->LTE, LTE->GSM, LTE-
>UMTS)

Parameter Possible val-

Data type Description
name ues
neighbor_di- list of in, out Neighbor direction:

rection strings
• out – outbound (source cell has an established
neighbor relation towards the neighbor cell.)
• in – inbound (neighbor cell has an established
neighbor relation towards the source cell.)
neighbor_pa- list of Any CM para- Defines the CM parameters that should be included in
rameters strings meter valid for the response for each neighboring cell.
cells
If not provided, all the neighbor parameters are
returned as a part of the result. The supported
parameters are the same as the one supported in the
result_filters of the /cells API. See Available
parameters for the /cells endpoint parameters.
Table 41: /cells/neighbors available parameters
3.7.1.2 Example
The /cells/neighbors request format:
{
"source_group_type": <cell_uid or cluster_key>,
"source_group_value": [<a list of cell UIDs or a cluster_key>],
"neighbor_type": [<a list of neighbor type, acceptable values:
"intra", "inter" or "irat">],
"neighbor_direction": [<a list of neighbor direction, acceptable
values: "in" or "out">],
"neighbor_parameters": [<a list of neighbor parameters>]
}
The /cells/neighbors request payload for cell UIDs:
{
"source_group_type": "cell_uid",
"source_group_value": ["24","4234","980"],
"neighbor_type": ["intra","inter"],
"neighbor_direction": ["in"],
"neighbor_parameters": ["pci","earfcn","lac","latitude","longitude"]
}

Note: neighbor_parameters is an optional filter.
The /cells/neighbors request payload for cluster key:
{
"source_group_type": "cluster_key",
"source_group_value": "module-targets.TestMod_admin_20170712_090534_
897",
"neighbor_type": ["irat"],
"neighbor_direction": ["out"]
}
Result code 200
Content Type JSON
Payload content Response payload format:
{
"resultURL": <A relative URL forthe client
to retrieve the result>
}
Response payload example:
{
"resultURL": "/cells/neighbors/data/3553"
}
Table 42: /cells/neighbors response information
3.7.2 Read neighbor list information of cells result
The /cells/neighbors/data/<request_id> endpoint allows an external system to read

neighbor list information of the cells.
Table 43: /cells/neighbors/data/<request_id> endpoint resource information describes the /cells/

neighbors/data/<request_id> endpoint resource.
Resource URL /cells/neighbors/data/<request_id>
Method GET

Table 43: /cells/neighbors/data/<request_id> endpoint resource information
For the /cells/neighbors endpoint payload and response examples, see Example.
Note: This API gives a paginated response and maximum of 500 queried source cell UIDs
per page will be returned with the requested neighbor parameters.
3.7.2.1 Example
The /cells/neighbors/data/<request_id> response format:
{
timeout, error>",
"data": "<data object in a format described below>",
retrieved.>"
}
Note:
• The error_message field is present only when there is an error retrieving the status.
• The data field is present only when the status is completed.
• The next field is present only when the status is completed and the next page of da-
ta is available.
The user gets the following responses:
• If the data is not available yet:
Result code 202
Description Request is accepted. When the service expects to take longer

than usual to process the request, it returns status 202 and
the user should check for the result later.
Table 44: /cells/neighbors/data/<request_id> response information
The /cells/neighbors/data/<request_id> response if the data is not available yet:
{
"status": "waiting"
}

• If the data is available:
Result code 200
Description OK. The neighbor list information according to the request.
Table 45: /cells/neighbors/data/<request_id> response information
The /cells/neighbors/data/<request_id> response format:
{
"data" {
"<uid of source cell 1>": {
"<neighbor direction: in>": {
"<neighbor type: intra>": {
"<neighbor cell UID 1>": {
"<neighbor cell parameter 1>": "<value 1>",
...
},
...
},
...
},
"<neighbor type: inter>": {
...
},
...
},
"<neighbor type: irat>": {
...
}
},
"<neighbor direction: out>": {
"<neighbor type: intra>": {
...
},
"<neighbor type: inter>": {
...
},
"<neighbor type: irat>": {
...
}

}
},
"<uid of source cell 2>": {
...
},
...
},
retrieved.>"
}
Note:
• The dictionaries neighbor direction: in or neighbor direction: out are

optional and depend on the request payload.
• The dictionaries neighbor type: intra, neighbor type: inter, or neighbor
type: irat are optional and depend on the request payload.
• The user should use the next URL provided to retrieve additional data.
• The next URL is not be present if there is no next set of data to be retrieved.
Example 1:/cells/neighbors/data/<request_id> response
{
"data" {
"24": {
"in": {
"intra": {
"19525": {
"pci": 316,
"earfcn": 2350,
"lac": null,
"longitude": -87.76053
},
"19526": {
"pci": 315,
"earfcn": 2350,
"lac": null,
}
},
"inter": {
"29525": {
"pci": 316,
"earfcn": 2225,
"lac": null,

},
"29526": {
"pci": 315,
"earfcn": 2225,
"lac": null,
}
}
}
},
"4234":
"in": {
"intra": {
"19525": {
"pci": 316,
"earfcn": 2350,
"lac": null,
},
"19526": {
"pci": 315,
"earfcn": 2350,
"lac": null,
"longitude": -87.76053 }
},
"inter": {
"29525": {
"pci": 316,
"earfcn": 2225,
"lac": null,
},
"29526": {
"pci": 315,
"earfcn": 2225,
"lac": null,
}
}
}
},
"next": "/cells/neighbors/data/4532572"
}

In the Example 1: /cells/neighbors/data/<request_id> response, the neighbor list

information for the cell with UID 980 is likely in the next set of result.
Response example 2 (assuming the cluster with id 23423 contains the cells with UID, 24, 4234 and
980):
{
"data"{
"24": {
"out": {
"irat": {
"30525": {},
"30526": {}
}
}
},
"4234":
"out": {
"irat": {
"30525": {},
"30526": {}
}
}
}
"980":
"out": {
"irat": {
"30525": {},
"30526": {}
}
}
}
}
}
3.7.3 Read configuration management data for descendant managed objects request
The /mo/descendant/cm endpoint allows an external system to read Configuration Management

(CM) data from Managed Objects (MO) that are descendant of a given MO in the MO hierarchy. The
API also allows defining a filter of what specific parameters of the descendant MOs to be read.

Table 46: /mo/descendant/cm endpoint resource information describes the /mo/descendant/cm

endpoint resource.
Resource URL /mo/descendant/cm
Method POST

Override: GET
Table 46: /mo/descendant/cm endpoint resource information
For the /mo/descendant/cm endpoint payload and response examples, see Example.

Table 47: /mo/descendant/cm available parameters describes the available parameters for the /mo/
descendant/cm endpoint.
Parameter
Data type Possible values Description
name
<request JSON map of Any valid descendant MO DN for which the descendant MOs
DN> type: string- MO type along with should be retrieved along with defined CM
>list of strings CM parameters or parameters. If the list of CM parameters is
null. null or empty list [ ] then all the available
CM parameters are returned.
Note: This is a mandatory parame-

ter and at least one request DN is
required.
oss_name string Valid name of the Indicates the OSS from which CM parame-
OSS connected to the ters should be retrieved. This parameter is
EdenNet instance. only required when there are more than one
OSS connected to the EdenNet instance. In
that case, parameter is required to avoid DN
clash between different OSSes.
Table 47: /mo/descendant/cm available parameters

3.7.3.2 Example
The /mo/descendant/cm request payload:
{
"<mo_dn_1>": {
"descendant MO type 1": [ "<descendant parameter a>",
"<descendant parameter b>",..],
"descendant MO type 2": null,
"descendant MO type 3": [],
},
"<mo_dn_2>": {
"descendant MO type 4": [ "<descendant parameter e>",
"<descendant parameter f>",..],
"descendant MO type 5": [ "<descendant parameter g>",
"<descendant parameter h>",..],
},
...
}
The /mo/descendant/cm request example:
{
"PLMN-PLMN/RNC-3/WBTS-7/WCEL-711": {
"ADJS":["AdjsSIB","TargetCellDN"],
"ADJI":["AdjiSIB","TargetCellDN"]
},
"PLMN-PLMN/RNC-3": {
"WCEL": ["AdminCellState"], //WCEL is not a direct child of RNC
"ADJS":["AdjsSIB","TargetCellDN"]
}
}
}
The request payload specifies the following criteria for CM data retrieval:
• The specific MOs identified by its Distinguished Name (DN)

• Their descendant MO types
• The CM parameters of the descendant MOs
If the list of parameters is empty, there is no parameter filtering. In such case, values for all parameters
of the descendant MOs of the specified MO types are retrieved.
The response is in the following format:
Result code 200

Payload content The response payload:
{
"resultURL": "<relative URL of where the result
can be retrieved.>"
}
Example:
{
"resultURL": "/mo/descendant/cm/data/45325"
}
Table 48: /cells/neighbors response information
3.7.4 Read configuration management data for descendant managed objects result
The /mo/descendant/cm/data/<request_id> endpoint allows an external system to read

Configuration Management (CM) data from Managed Objects (MO) that are descendant of a given MO
in the MO hierarchy.
Table 49: /mo/descendant/cm/data/<request_id> endpoint resource information describes the /mo/

descendant/cm/data/<request_id> endpoint resource.
Resource URL /mo/descendant/cm/data/<request_id>
Method GET
Table 49: /mo/descendant/cm/data/<request_id> endpoint resource information
For the /mo/descendant/cm/data/<request_id> endpoint payload and response examples,

see Example.
Note: This API gives a paginated response and maximum of 500 queried MO DNs will be
returned per page with the requested descendant MO attributes.

The page limit is applied on the specified MO DNs list and not on the number of descendants
of the given MO. Hence, it is advised not to give root MO DN to fetch all the descendant MO
attributes.
3.7.4.1 Example
The /mo/descendant/cm/data/<request_id> endpoint response in general:
{
timeout, error>",
>"
}
The /mo/descendant/cm/data/<request_id> endpoint when data is not yet available:
Result code 202
Description Request is accepted. When the service expects to take longer than usual to
process the request, it returns status 202 and the user should check the re-
sult later.
Table 50: /mo/descendant/cm/data/<request_id> response information
{
"status": "waiting"
}
If status 202 is returned, the user can poll the status of the request via the status URL provided in the
payload.
The result from polling the status URL is as follows:
{
"status": "<One of the available status string: completed, waiting,
timeout, error>",
"data": "<Relative URL from which the client can retrieve the result
of the request>"
}
The /mo/descendant/cm/data/<request_id> endpoint response when data is available:
Result code 200

Description OK. The CM data for the requested descendant MOs are returned.
Table 51: /mo/descendant/cm/data/<request_id> response information
{
"data": {
"<mo_dn_1>":{
"<descendant_mo_dn_1>": {
"<parameter a>": "<value a>",
"<parameter b>": "<value b>",
...
},
"<parameter c>": "<value c>",
"<parameter d>": "<value d>",
...
"<parameter e>": "<value e>",
"<parameter f>": "<value f>",
...
},
...
},
"<mo_dn_2>":{
"<parameter g>": "<value g>",
"<parameter h>": "<value h>",
...
},
"<parameter i>": "<value i>",
"<parameter j>": "<value j>",
...
},
...
},
...
retrieved.>"}
The /mo/descendant/cm/data/<request_id> endpoint response example:
{
"data": {
"PLMN-PLMN/RNC-3/WBTS-7/WCEL-711/ADJS-9": {

"AdjsSIB":"1",
"TargetCellDN":"PLMN-PLMN/RNC-1103/WBTS-1117/WCEL-111731"
},
"AdjsSIB":"2",
},
"PLMN-PLMN/RNC-3/WBTS-7/WCEL-711/ADJI-11": {
"AdjiSIB":"1",
}
},
"PLMN-PLMN/RNC-3": {
"AdminCellState":"Locked",
},
"AdjsSIB":"1",
}
}
},
"next": "/mo/descendant/cm/data/45325/2"
}
Note:
• The data is organized as nested dictionaries.
– The DNs of requested MOs are dictionary keys at the top level.
– The DNs of the descendant MOs are dictionary keys at sub levels. If no descendants
are found for the requested DN, this dictionary will be empty.
– The requested parameter names of the descendant MOs are dictionary keys at
deepest levels.
3.7.5 Read distinguished names of the root level managed objects
The /mo/roots endpoint allows an external system to retrieve the distinguished names of all the root
level managed objects.

Table 52: /mo/roots endpoint resource information describes the /mo/roots endpoint resource.
Resource URL /mo/roots
Method GET
Table 52: /mo/roots endpoint resource information
For the /mo/roots endpoint payload and response examples, see Example.
3.7.5.1 Example
The /mo/roots response information:
Result code 200
Description OK. A list of distinguished names.
Payload content The response format:
{
"status": "<One of the available status
strings: completed, waiting, timeout, error>",
"data":{
"<root_dn_1>",
"<root_dn_2>",
....
]
Example:
{
"data":{
"PLMN-PLMN",
"SubNetwork=ONRM_ROOT_MO_R",
"BSC6900GSMNE=SO1BSC1"
}
Table 53: /mo/roots response information

3.7.6 Read configuration management data for individual managed objects request
The /mo/cm endpoint allows an external system to read Configuration Management (CM) data from
any Managed Object (MO). MOs are identified by Distinguished Names (DNs). The API also allows
defining a filter of what specific parameters of the MO to be read.
Table 54: /mo/cm endpoint resource information describes the /mo/cm endpoint resource.
Resource URL /mo/cm
Method POST

Override: GET
Table 54: /mo/cm endpoint resource information
For the /mo/cm endpoint payload and response examples, see Example.

Table 55: /mo/cm available parameters describes the available parameters for the /mo/cm endpoint.
Parameter
name
dns list of strings Any valid Distin- DNs of MOs to be retrieved.

guished Name
Note: This is a mandatory parame-
(DN) of MO.
ter.
param_filter list of strings Any CM parame- List of parameters to be retrieved for each MO.
ter valid for the If this parameter is omitted, there in no para-
specified DN. meter filtering and values for all parameters of
the MOs specified by the DNs are retrieved.
oss_name string Valid name of the Indicates the OSS from which the CM parame-
OSS connected ters should be retrieved. This parameter is on-

Parameter
name
to the EdenNet ly required when there is more than one OSS
instance. connected to the EdenNet instance. In that
case, parameter is required to avoid DN clash
between different OSSes.
Table 55: /mo/cm available parameters
3.7.6.2 Example
The /mo/cm endpoint request payload:
{
"dns": [ "<mo_dn_1>", "<mo_dn_2>", "<mo_dn_3>", ... ],
"param_filter": [ "<parameter a>", "<parameter b>", ... ],
"oss_name": "<some_oss_name>"
}
Note: oss_name is an optional filter.
Example request payload:
{
"dns": ["PLMN-PLMN/RNC-3/WBTS-7/WCEL-711/ADJS-10", "PLMN-PLMN/RNC-
3/WBTS-70/WCEL-7000/ADJS-11"],
"param_filter": ["AdjsSIB","HSDPAHopsIdentifier",
"NrtHopsIdentifier","RTWithHSDPAHopsIdentifier","RtHopsIdentifier",
"TargetCellDN"]
}
The /mo/cm response:
Result code 200
{
"resultURL": "<relative URL of where the
result can be retrieved.>"
}

Example:
{
"resultURL": "/mo/cm/data/3553"
}
Table 56: /mo/cm response information
3.7.7 Read configuration management data for individual managed objects result
The /mo/cm/data/<request_id> endpoint allows an external system to read configuration

management (CM) data from any managed objects (MO).
Table 57: /mo/cm/data/<request_id> endpoint resource information describes the /mo/cm/data/

<request_id> endpoint resource.
Resource URL /mo/cm/data/<request_id>
Method GET
Table 57: /mo/cm/data/<request_id> endpoint resource information
For the /mo/cm/data/<request_id> endpoint payload and response examples, see Example.
Note: This API gives a paginated response and maximum of 500 queried DNs will be
returned per page with the requested parameters.
3.7.7.1 Example
The /mo/cm/data/<request_id> endpoint response in general:
{
timeout, error>",
>"
}

Note:
• The error_message field is present only when there is an error in retrieving the status.
• The data field is present only when the status is completed.
• The next field is present only when the status is completed and next page of data
available.
The /mo/cm/data/<request_id> endpoint response when data is not yet available:
Result code 202
process the request, it returns status 202 and the user should check the re-
sult later.
Table 58: /mo/cm/data/<request_id> response information
{
"status": "waiting"
}
The /mo/cm/data/<request_id> endpoint response when data is available:
Result code 200
Description OK. The neighbor list information according to the request.
Table 59: /mo/cm/data/<request_id> response information
{
"data": {
"<mo_dn_1>":{
...
},
"<_mo_dn_2>": {
"<parameter a>": "<value c>",
"<parameter b>": "<value d>",
...
},
...
},


retrieved.>"
}
The /mo/cm/data/<request_id> endpoint response example:
{
"data": {
"AdjsSIB":"1",
"HSDPAHopsIdentifier":"7",
"NrtHopsIdentifier":"1",
"RTWithHSDPAHopsIdentifier":"8",
"RtHopsIdentifier":"2",
},
"AdjsSIB":"1",
"HSDPAHopsIdentifier":"7",
"NrtHopsIdentifier":"1",
"RTWithHSDPAHopsIdentifier":"8",
"RtHopsIdentifier":"2",
}
},
"next": "/mo/cm/data/45325/2"
}
Note:
• The data is organized as nested dictionaries.
– The DNs of requested MOs are dictionary keys at the top level.
– The requested parameter names of the MOs are dictionary keys at deepest levels.
3.7.8 Write configuration management data to managed objects request
The /mo/cm/write endpoint allows an external system to write configuration management (CM) data
to managed objects (MO). This includes creating MO, updating MO parameters, and deleting MOs.

Table 60: /mo/cm/write endpoint resource information describes the /mo/cm/write endpoint
resource.
Resource URL /mo/cm/write
Method POST
Table 60: /mo/cm/write endpoint resource information
The endpoint requires one of the parameters, create, update, or delete indicating the requested
operation. For the list of the parameters, see Available parameters section.
For the /mo/cm/write endpoint payload and response examples, see Example.

Table 61: /mo/cm/write available parameters describes the available parameters for the /mo/cm/
write endpoint.
Note: At least one of the create, update, or delete parameters is required.
Parameter
Description Data type
name
create DNs of the MOs that should be created along with map of type: string -> map
CM parameters to be set. Request map should
contain DNs as keys and parameter maps as val-
ues.
Note:
• Map can be empty, in this case cre-

ate request is ignored.
• Parameters map can be empty, in
this case there is an attempt to cre-
ate an MO without any parameters.
update DNs of the MOs that should be updated along with map of type: string -> map
CM parameters to be set. Request map should
contain DNs as keys and parameter maps as val-
ues.

Parameter
Description Data type
name
Note:
• Map can be empty, in that case up-

date request is ignored.
• Parameters map can be empty, in
that case update request for this
particular MO is ignored.
delete Any valid Distinguished Name (DN). list of strings
oss_name Indicates the OSS that should be updated. This string

parameter is only required when there are more
than one OSS connected to the EdenNet instance.
In that case, parameter is required to avoid DN
clash between different OSSes.
Table 61: /mo/cm/write available parameters
3.7.8.2 Example
The /mo/cm/write endpoint request payload:
{
"create": { //The "create" dictionary is optional.
"<mo_dn_1>": {
...
},
"<mo_dn_2>": {
"<parameter c>": "<value c>",
"<parameter d>": "<value d>",
...
},
...
},
"update": { //The "update" dictionary is optional.
"<mo_dn_3>": {
"<parameter e>": "<value e>",
"<parameter f>": "<value f>",
...
},
"<mo_dn_4>": {
"<parameter g>": "<value g>",
"<parameter h>": "<value h>",
...

},
...
},
"delete": [ //The "delete" list is optional.
"<mo_dn_5>",
"<mo_dn_6>",
... ],
"oss_name": "name of the oss"
}
Example request payload:
{
"create": {
"AdjsSIB":"For SIB and CELL DCH meas",
"HSDPAHopsIdentifier":"7","NrtHopsIdentifier":"1",
"RTWithHSDPAHopsIdentifier":"8","RtHopsIdentifier":"2",
},
"AdjsSIB":"For SIB and CELL DCH meas",
"HSDPAHopsIdentifier":"7","NrtHopsIdentifier":"1",
"RTWithHSDPAHopsIdentifier":"8","RtHopsIdentifier":"2",
}
},
"update": {
"AdminCellState":"Locked"
}
},
"delete": [
"PLMN-PLMN/RNC-3/WBTS-700/WCEL-70000/ADJI-200"
],
"oss_name": "c2oss"
}
The request is accepted
Result code 200
Description Request is accepted. The user should use the resultURL provided to retrieve
the response data.

"resultURL": "<relative URL of where the result can

be retrieved.>"
}
Example:
{
"resultURL": "/mo/cm/write/data/
53c1289727a69ae3bf1b52711d22647a"
}
Table 62: /mo/cm/write response information for 200 result code
The request is invalid
Result code 400
Description Request is invalid.
Payload content • None of the create, update, delete parameters are provided.
Example of invalid request payload:
{
"oss_name": "c2oss"
}
Response payload:
{
"error_details": [
"At least one of 'create', 'update', 'delete'
parameters is required"
]
}
• Name of the OSS provided in the request can not be recognized:
{
"update": {
}
},
"oss_name": "invalid_oss_name"
}

Response payload:
{
"error_details": [
"Provided OSS (invalid_oss_name) does not exist.
Available OSSes: c2oss, syoss, wyoss"
]
}
• OSS name is not provided and more than one OSS is connected.
{
"update": {
}
}
}
Response payload:
{
"error_details": [
"More than 1 OSS connected and 'oss_name' not
provided. Available OSSes: c2oss, syoss, wyoss"
]
}
Access is forbidden
Result code 403
Description Access is forbidden. This occurs if the user corresponding to the security token
has only SON Monitor privilege.
3.7.9 Write configuration management data to managed objects response
The /mo/cm/write/data/<request_id> endpoint allows an external system to get the response

of write configuration management (CM) data.

Table 65: /mo/cm/write/data/<request_id> endpoint resource information describes the /mo/cm/

write/data/<request_id> endpoint resource.
Resource URL /mo/cm/write/data/<request_id>
Method GET
Table 65: /mo/cm/write/data/<request_id> endpoint resource information
For the /mo/cm/write/data/<request_id> endpoint payload and response examples, see

Example.
3.7.9.1 Example
The /mo/cm/write/data/<request_id> endpoint request payload format:
{
timeout, error>",
"data": "<data object in a format described below>"
}
Note:
• The error_message field is present only when there is an error retrieving the status.
• The data is present only when the status is completed.
Response when data is not yet available
Result code 202
process the request, it returns status 202 and the user should verify the result
later.
{
"status": "waiting"

Table 66: /mo/cm/write/data/<request_id> response information
Response when data is available
Result code 200
Description OK. The response will show the status of the modification to each managed ob-
ject.
Payload content Response payload format:
{
"data": {
"creates": { //Present only if there is a "create"
dictionary in the request"
"<mo_dn_1>": {
"status": "<succeeded, or failed>",
"error": "<Optional. Reasons for failure.>"
},
"<mo_dn_2>": {
},
...
},
"updates": { //Present only if there is an "update"
dictionary in the request"
"<mo_dn_3>": {
},
"<mo_dn_4>": {
},
...
},
"deletes": { //Present only if there is a "delete"
list in the request"
"<mo_dn_5>": {
},
"<mo_dn_6>": {


},
...
}
}
}
Note:
• Each of the creates, updates or deletes dictionaries are op-

tional. They are corresponding to what have been sent to the ser-
vice via the request payload.
• If the DN of an MO is not recognized by the target OSS, then re-
sult for this DN is also included as follows:
"some_unrecognized_dn": {
"status": "failed",
"error": "Unrecognized DN."
}
Response payload example:
{
"data": {
"creates":
"status": "succeeded"
},
"status": "failed",
"error": "Missing mandatory parameters."
}
},
"updates": {
"status": "failed",
"error": "CPICH power out of range."
}
},
"deletes": {
"PLMN-PLMN/RNC-3/WBTS-700/WCEL-70000/ADJI-200": {
"status": "failed",
"error": "MO does not exist."
}
}
}
}

Table 67: /mo/cm/write/data/<request_id> response information
3.7.10 Check status of cache for configuration management data request
The /mo/cm/cache/health endpoint allows an external system to check status of cache for
configuration management (CM) data. It provides information on how recent CM data is per each
managed object type (MO type) and when the next scheduled update is planned.
Table 68: /mo/cm/cache/health endpoint resource information describes the /mo/cm/cache/health

endpoint resource.
Resource URL /mo/cm/cache/health
Method GET
Required parameters See Available parameters.
Table 68: /mo/cm/cache/health endpoint resource information
For the /mo/cm/cache/health endpoint payload and response examples, see Example.
Note: The get_health API works for non-NAdC integrations only.

Table 69: /mo/cm/cache/health available parameters describes the available parameters for the /mo/
cm/cache/health endpoint.
Parameter
name
oss_names list of strings Valid names of the Comma-separated list of OSS names for which
OSSes connected CM cache health should be retrieved. If the pa-
to the EdenNet in- rameter is omitted, then health for all OSSes
stance. connected to the EdenNet instance is retrieved.

Parameter
name
properties list of strings cm_cache_sched- Defines which health properties should be re-
ule, blacklist- trieved. If parameter is omitted, then all health
ing_cache, cm_ properties are retrieved.
timeout_map,
retrieval_re- Each health property is explained below:
quest_queue • cm_cache_schedule: CM cache of

EdenNet keeps a schedule of when
different MO classes are to be exported
from the OSS. The cm_cache_schedule
shows for each MO type the schedule of
the next OSS export, the timestamp of the
last successful export and the last failure
timestamp.
• blacklisting_cache: CM cache of
EdenNet keeps a blacklist of MO types and
parent DNs that will not be attempted to
export from the OSS. The blacklist-
ing_cache shows all the known MO types
for the vendor and whether they have been
blacklisted or not.
• cm_timeout_map: The CM timeout stores
MO class update intervals for those class
names that are not defined in the default
MO update interval configuration.
• retrieval_request_queue: The re-
trieval request queue holds the requests
that the CM cache is to export from the
OSS.
Table 69: /mo/cm/cache/health available parameters
3.7.10.2 Example
The /mo/cm/cache/health endpoint request payload example:
?oss_names=some_oss,another_oss&properties=cm_cache_schedule,retrieval_
request_queue
Response
Result code 200

Description OK.
Payload con- Response format:

tent
{
"errors": {
"<name_of_the_oss>": {
"error": "Input is invalid",
"error_code": 400
}
},
"cm_cache_health": {
"<name_of_the_oss>": {
"cm_timeout_map": [
{
"mo_class": "<mo_type>",
"timeout": <integer>
},
...
],
"cm_cache_schedule": {
"<mo_type>": {
"schedule_time": "<utc_time>",
"update_time": "<utc_time>",
"failure_time": "<utc_time>"
},
...
},
"blacklisting_cache": {
"<mo_type>": <boolean_value>,
...
},
"retrieval_request_queue": {
"size": <integer>
}
},
...
}
}
Example response:
{
"errors": {
"unknown_oss": {
"error_code": 405,
"error": "405 Client Error: Method Not Allowed for
url: http://localhost:9600/region/unknown_oss/cache/health"

}
},
"cm_cache_health": {
"c2oss": {
"cm_timeout_map": {},
"cm_cache_schedule": {
"ADJS": {
"schedule_time": "2018-02-22T00:45:19Z",
"update_time": "2018-02-21T20:45:19Z",
"failure_time": null
},
"WCEL": {
"schedule_time": "2018-02-22T01:02:37Z",
"update_time": "2018-02-21T22:00:06Z",
"failure_time": "2018-02-22T00:02:37Z"
},
"ADJW": {
"schedule_time": "2018-02-22T00:56:09Z",
"update_time": "2018-02-21T20:56:09Z",
"failure_time": null
}
},
"blacklisting_cache": {
"LNBTS_TDD": true,
"BCF": true,
"APUCCH": true,
"APUCCH_TDD": true,
"RET": true,
"ADJI": true,
"SIB": true,
"WBTS": true,
},
"retrieval_request_queue": {
"size": 0
}
}
}
}
Table 70: /mo/cm/cache/health response information

SON Northbound Interface Guide DN09252603 1-0 General API responses
4 General API responses
Table 71: General API responses describes the API responses for different codes.
Content
Code Content Description
type
400 JSON JSON data format: Bad user request: invalid

request syntax, content, or
{
"error_type": "invalid_ incorrect token format.
request", For example, the error
"error_details": [
message is shown when
"<error detail1>",
calling the /cells/pm
"<error detail2>"
] API without providing the
} list of performance metrics
names.
Example:
{
"error_type": "invalid_
request",
"error_details": [
"Missing required
parameter \"pm\"."
]
}
401 JSON JSON data format: When the security token is

expired, revoked, or invalid
{
"error_type": "invalid_ for any reason, the user
token", should authenticate again
"error_details": [ before calling an API.
"<error detail1>",
"<error detail2>"
]
}
Example:
{
"error_type": "invalid_
token",
"error_details": [
"Security token expired"
]
}

Content
type
401 N/A The response without any payload, with the If the request is missing
following HTTP header: Authorization:
WWW-Authenticate: Bearer Bearer HTTP header
realm="EdenNet SON NBI" appears.
404 JSON JSON data format: Requested resource or data

are not found. The error is
{
"error_type": "not_found", also returned when the user
"error_details": [ waits too long before fetch-
"<error detail1>", ing the result set from the
"<error detail2>" result URL or next URL. In
] such cases, the result set is
}
removed from the server.
Example: For example, when an MO
{ corresponding to DN is not
"error_type": "not_found", found and the user calls
"error_details": [ one of the APIs for reading
"MO for "PLMN-PLMN/RNC-3/ or updating the CM data,
WBTS-700/WCEL-70000 not found."
the error is returned.
]
}
405 N/A N/A The method is not allowed.
413 N/A N/A The request payload is too

long.
429 N/A N/A Too many requests within a

given amount of time.
500 No content No payload or: In case of some unforeseen

or JSON problem or internal problem
{
with services or database.
"error_type": "internal_
server_error",
"error_details": [
"<error detail1>",
"<error detail2>"
]
}
501 N/A N/A An API for the request is

not implemented.

Content
type
503 N/A N/A The service serving the API

is temporary shut down for
maintenance.
504 N/A N/A The request is timed out be-

fore the service is able to
fulfill the API request.
Table 71: General API responses

SON Northbound Interface Guide DN09252603 1-0 Swagger .yml file
5 Swagger .yml file

The swagger .yml file explains the various APIs exposed by EdenNet SON NBI. The file is
packaged along with EdenNet installer at the location /installer/site-packages/
son_nbi_doc-1.0.0+<commit_id>-py2.py3-none-any.whl.
Note:
• The file is also available in the EdenNet Infobrowser at Help → Documentation →

Northbound interfaces → Appendix → Swagger .yml file.
• The user must change the host field in .yml file to the EdenNet GUI server IP.

Eden Net Son Nbi Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Eden Net Son Nbi Guide

Uploaded by

Copyright:

Available Formats

EdenNet 21

SON Northbound Interface Guide

N O WA RRA NT Y O F AN Y KI ND , EI T HER EXPR ES S OR I M P L I E D , I N C L U D I N G B U T N O T L I M I T E D TO A N Y

Copyright © 2021 Nokia. All rights reserved.

Important Notice on Product Safety

2 SON Northbound Interface overview............................................................................................................ 8

3 SON NBI execution........................................................................................................................................11

EdenNet 21 © 2021 Nokia 3

4 General API responses................................................................................................................................. 88

5 Swagger .yml file........................................................................................................................................... 91

EdenNet 21 © 2021 Nokia 4

Release Change description

EdenNet 21 Added sections:

• Retrieve the list of output files produced by a specific SON module

• SON NBI execution - additional information is added about IPv4

EdenNet 20 FP 2011 No change.

EdenNet 20 FP 2010 No change.

EdenNet 20 FP 2009 No change.

EdenNet 20 FP 2008 No change.

EdenNet 20 FP 2007 No change.

EdenNet 20 Updated sections:

• Example - updated the supported resolutions by EdenNet.

EdenNet 19A FP 2004 No change.

EdenNet 19A FP 2003 No change.

EdenNet 19A FP 2002 Updated section:

• Examples - added cgi as a target type.

EdenNet 19A FP 2001 No change.

EdenNet 19A FP 1912 No change.

EdenNet 19A FP 1911 No change.

EdenNet 21 © 2021 Nokia 5

Release Change description

EdenNet 19A Updated section:

• Swagger .yml file - updated the wheel file name.

EdenNet 19 FP 1907 No change.

EdenNet 19 FP 1906 No change.

EdenNet 19 FP 1905 No change.

EdenNet 19 FP 1904 No change.

EdenNet 19 Updated section:

• Example - updated the description

EdenNet 18 SP1 1901 No changes.

EdenNet 18 SP1 1812 No changes.

EdenNet 18 SP1 1811 Added section:

• Swagger .yml file

EdenNet 18 SP1 Updated sections:

Added a note in following sections:

• Retrieve execution status of multiple module instances result

EdenNet 18 Added sections:

• Check status of cache for configuration management data request

• License details section is added.

EdenNet 17 SP1 FP1 Added sections:

• Write configuration management data to managed objects request

EdenNet 17 SP1 Added sections:

EdenNet 21 © 2021 Nokia 6

Release Change description

• Read neighbor list information of cells request

EdenNet 17 FP1 Added sections:

• Create a SON module instance

EdenNet 17 New document.

Table 1: Summary of changes

EdenNet 21 © 2021 Nokia 7

2 SON Northbound Interface overview

The SON NBI performs the following functionalities:

Table 2: API summary describes the available API endpoints.

Relative URL Method Category Description