Starting TEIV with Docker Compose
To start TEIV navigate to the 'docker-compose' directory in the 'teiv' repo and run 'docker-compose up'. This will bring up 3 Kafka containers, Zookeeper, PostgreSQL using PostGIS, TEIV Exposure, TEIV Ingestion and an optional kafka-producer service that will populate the database automatically, allowing you to query the database straight away.
If the kafka-producer isn't needed you can comment it out in the docker-compose.yml file. If commented out database won't be populated with any topology data, but the 'cloudEventProducer.sh' script in 'docker-compose/cloudEventProducer' can be used to populate the database with sample data that will enable querying of the database.
Sample data can be found at docker-compose/cloudEventProducer/events
Sample API calls
To get a list of all API calls and details go to TEIV API documentation.
To get a list of supported domains click here.
Postman collection
Collection: Query TEIV.postman_collection.json
Environment: TEIV.postman_environment.json
Schema for "Create classifiers and decorators schema": classifiers-and-decorators-module.yang
Retrieving and using topology modules
Topology & Inventory provides APIs to enable users to query module data that can be used to understand the existing topology and inventory model, parse the modules, and understand what objects are supported over the R1 interface, so adequate queries can be made on topology and inventory data.
The API endpoints returning lists support pagination. The default value for number of items returned is 500, which is also the upper limit.
Sample request to fetch a list of all domains in TEIV:
GET https://<host>/topology-inventory/<API_VERSION>/domains
Response:
{
"items": [
{
"name": "CLOUD",
"entityTypes": {
"href": "/domains/CLOUD/entity-types"
},
"relationshipTypes": {
"href": "/domains/CLOUD/relationship-types"
}
},
{
"name": "EQUIPMENT",
"entityTypes": {
"href": "/domains/EQUIPMENT/entity-types"
},
"relationshipTypes": {
"href": "/domains/EQUIPMENT/relationship-types"
}
},
{
"name": "OAM",
"entityTypes": {
"href": "/domains/OAM/entity-types"
},
"relationshipTypes": {
"href": "/domains/OAM/relationship-types"
}
},
{
"name": "RAN",
"entityTypes": {
"href": "/domains/RAN/entity-types"
},
"relationshipTypes": {
"href": "/domains/RAN/relationship-types"
}
},
{
"name": "REL_CLOUD_RAN",
"entityTypes": {
"href": "/domains/REL_CLOUD_RAN/entity-types"
},
"relationshipTypes": {
"href": "/domains/REL_CLOUD_RAN/relationship-types"
}
},
{
"name": "REL_EQUIPMENT_RAN",
"entityTypes": {
"href": "/domains/REL_EQUIPMENT_RAN/entity-types"
},
"relationshipTypes": {
"href": "/domains/REL_EQUIPMENT_RAN/relationship-types"
}
},
{
"name": "REL_OAM_CLOUD",
"entityTypes": {
"href": "/domains/REL_OAM_CLOUD/entity-types"
},
"relationshipTypes": {
"href": "/domains/REL_OAM_CLOUD/relationship-types"
}
},
{
"name": "REL_OAM_RAN",
"entityTypes": {
"href": "/domains/REL_OAM_RAN/entity-types"
},
"relationshipTypes": {
"href": "/domains/REL_OAM_RAN/relationship-types"
}
},
{
"name": "TEIV",
"entityTypes": {
"href": "/domains/TEIV/entity-types"
},
"relationshipTypes": {
"href": "/domains/TEIV/relationship-types"
}
}
],
"self": {
"href": "/domains?offset=0&limit=500"
},
"first": {
"href": "/domains?offset=0&limit=500"
},
"prev": {
"href": "/domains?offset=0&limit=500"
},
"next": {
"href": "/domains?offset=0&limit=500"
},
"last": {
"href": "/domains?offset=0&limit=500"
},
"totalCount": 9
}
Sample request to fetch a list of all modules in TEIV:
GET https://<host>/topology-inventory/<API_VERSION>/schemas
Response:
{
"items": [
{
"name": "_3gpp-common-yang-extensions",
"domain": "",
"revision": "2019-06-23",
"content": {
"href": "/schemas/_3gpp-common-yang-extensions/content"
}
},
{
"name": "_3gpp-common-yang-types",
"domain": "",
"revision": "2022-07-26",
"content": {
"href": "/schemas/_3gpp-common-yang-types/content"
}
},
{
"name": "ietf-geo-location",
"domain": "",
"revision": "2022-02-11",
"content": {
"href": "/schemas/ietf-geo-location/content"
}
},
{
"name": "ietf-inet-types",
"domain": "",
"revision": "2013-07-15",
"content": {
"href": "/schemas/ietf-inet-types/content"
}
},
{
"name": "ietf-yang-types",
"domain": "",
"revision": "2013-07-15",
"content": {
"href": "/schemas/ietf-yang-types/content"
}
},
{
"name": "o-ran-smo-teiv-cloud",
"domain": "CLOUD",
"revision": "2024-05-02",
"content": {
"href": "/schemas/o-ran-smo-teiv-cloud/content"
}
},
{
"name": "o-ran-smo-teiv-common-yang-extensions",
"domain": "",
"revision": "2024-05-24",
"content": {
"href": "/schemas/o-ran-smo-teiv-common-yang-extensions/content"
}
},
{
"name": "o-ran-smo-teiv-common-yang-types",
"domain": "",
"revision": "2024-05-24",
"content": {
"href": "/schemas/o-ran-smo-teiv-common-yang-types/content"
}
},
{
"name": "o-ran-smo-teiv-equipment",
"domain": "EQUIPMENT",
"revision": "2024-05-24",
"content": {
"href": "/schemas/o-ran-smo-teiv-equipment/content"
}
},
{
"name": "o-ran-smo-teiv-oam",
"domain": "OAM",
"revision": "2024-05-24",
"content": {
"href": "/schemas/o-ran-smo-teiv-oam/content"
}
},
{
"name": "o-ran-smo-teiv-ran",
"domain": "RAN",
"revision": "2024-05-24",
"content": {
"href": "/schemas/o-ran-smo-teiv-ran/content"
}
},
{
"name": "o-ran-smo-teiv-rel-cloud-ran",
"domain": "REL_CLOUD_RAN",
"revision": "2024-05-02",
"content": {
"href": "/schemas/o-ran-smo-teiv-rel-cloud-ran/content"
}
},
{
"name": "o-ran-smo-teiv-rel-equipment-ran",
"domain": "REL_EQUIPMENT_RAN",
"revision": "2024-05-24",
"content": {
"href": "/schemas/o-ran-smo-teiv-rel-equipment-ran/content"
}
},
{
"name": "o-ran-smo-teiv-rel-oam-cloud",
"domain": "REL_OAM_CLOUD",
"revision": "2024-05-02",
"content": {
"href": "/schemas/o-ran-smo-teiv-rel-oam-cloud/content"
}
},
{
"name": "o-ran-smo-teiv-rel-oam-ran",
"domain": "REL_OAM_RAN",
"revision": "2024-05-24",
"content": {
"href": "/schemas/o-ran-smo-teiv-rel-oam-ran/content"
}
}
],
"self": {
"href": "/schemas?offset=0&limit=500"
},
"first": {
"href": "/schemas?offset=0&limit=500"
},
"prev": {
"href": "/schemas?offset=0&limit=500"
},
"next": {
"href": "/schemas?offset=0&limit=500"
},
"last": {
"href": "/schemas?offset=0&limit=500"
},
"totalCount": 15
}
Sample request to fetch a list of all modules related to the CLOUD domain:
To get a list of all modules for a specific domain, use a domain query parameter. The query parameter is case sensitive.
Note: - Partial matches are also supported in the query parameter using ’.*’ as a wild card. - If the specified domain does not exist, an empty list is returned.
GET https://<host>/topology-inventory/<API_VERSION>/schemas?domain=.*CLOUD.*
Response:
{
"items": [
{
"name": "o-ran-smo-teiv-cloud",
"domain": "CLOUD",
"revision": "2024-05-02",
"content": {
"href": "/schemas/o-ran-smo-teiv-cloud/content"
}
},
{
"name": "o-ran-smo-teiv-rel-cloud-ran",
"domain": "REL_CLOUD_RAN",
"revision": "2024-05-02",
"content": {
"href": "/schemas/o-ran-smo-teiv-rel-cloud-ran/content"
}
},
{
"name": "o-ran-smo-teiv-rel-oam-cloud",
"domain": "REL_OAM_CLOUD",
"revision": "2024-05-02",
"content": {
"href": "/schemas/o-ran-smo-teiv-rel-oam-cloud/content"
}
}
],
"self": {
"href": "/schemas?offset=0&limit=500&domain=.*CLOUD.*"
},
"first": {
"href": "/schemas?offset=0&limit=500&domain=.*CLOUD.*"
},
"prev": {
"href": "/schemas?offset=0&limit=500&domain=.*CLOUD.*"
},
"next": {
"href": "/schemas?offset=0&limit=500&domain=.*CLOUD.*"
},
"last": {
"href": "/schemas?offset=0&limit=500&domain=.*CLOUD.*"
},
"totalCount": 3
}
Sample request to fetch the module data for the o-ran-smo-teiv-oam module:
To get a specific module, supply a module name in the path parameter.
GET https://<host>/topology-inventory/<API_VERSION>/schemas/o-ran-smo-teiv-oam/content
Response:
module o-ran-smo-teiv-oam {
yang-version 1.1;
namespace "urn:o-ran:smo-teiv-oam";
prefix or-teiv-oam;
import o-ran-smo-teiv-common-yang-types {prefix or-teiv-types; }
import o-ran-smo-teiv-common-yang-extensions {prefix or-teiv-yext; }
organization "Ericsson AB";
contact "Ericsson first line support via email";
description
"RAN O&M topology model.
Copyright (c) 2023 Ericsson AB. All rights reserved.
This model contains the topology entities and relations in the
RAN O&M domain, which are intended to represent management systems
and management interfaces.";
revision "2024-05-02" {
description "Initial revision.";
or-teiv-yext:label 0.3.0;
}
or-teiv-yext:domain OAM;
list ManagedElement {
description "A Managed Element (ME) is a node into a telecommunication network
providing support and/or service to subscribers. An ME communicates
with a manager application (directly or indirectly) over one or more
interfaces for the purpose of being monitored and/or controlled.";
uses or-teiv-types:Top_Grp_Type;
key id;
container attributes {
leaf fdn {
description "This Full Distinguished Name (FDN) identifies
an instance of the ManagedElement MO. It contains
the full path from the Subnetwork to the
ManagedElement.";
type or-teiv-types:_3GPP_FDN_Type;
}
container cmId {
uses or-teiv-types:CM_ID;
}
}
}
}
Reading entities and relationships
Sample request to fetch the entities for EQUIPMENT:
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types
Response:
{
"items": [
{
"name": "AntennaModule",
"entities": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities"
}
},
{
"name": "PhysicalNF",
"entities": {
"href": "/domains/EQUIPMENT/entity-types/PhysicalNF/entities"
}
},
{
"name": "Site",
"entities": {
"href": "/domains/EQUIPMENT/entity-types/Site/entities"
}
}
],
"self": {
"href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
},
"first": {
"href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
},
"prev": {
"href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
},
"next": {
"href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
},
"last": {
"href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
},
"totalCount": 3
}
Sample request to fetch the AntennaModule entities from EQUIPMENT:
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities
Response:
{
"items": [
{
"o-ran-smo-teiv-equipment:AntennaModule": [
{
"id": "urn:oran:smo:teiv:AntennaModule=1"
}
]
},
{
"o-ran-smo-teiv-equipment:AntennaModule": [
{
"id": "urn:oran:smo:teiv:AntennaModule=2"
}
]
}
],
"self": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
},
"first": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
},
"prev": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
},
"next": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
},
"last": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
},
"totalCount": 2
}
Sample request to fetch a specific AntennaModule from EQUIPMENT by id:
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1
Response:
{
"o-ran-smo-teiv-equipment:AntennaModule": [
{
"decorators": {},
"classifiers": [],
"attributes": {
"mechanicalAntennaTilt": 10,
"mechanicalAntennaBearing": 50,
"positionWithinSector": "Unknown",
"geo-location": {
"height": 3000,
"latitude": 41.73297,
"longitude": -73.007696
},
"antennaModelNumber": "1",
"totalTilt": 14,
"antennaBeamWidth": [
35,
23,
21
],
"electricalAntennaTilt": 2
},
"id": "urn:oran:smo:teiv:AntennaModule=1",
"sourceIds": [
"urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaUnit=1",
"urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaUnit=1,AntennaSubunit=1",
"urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaNearUnit=1,RetSubUnit=1"
]
}
]
}
Sample request to fetch all relationships from a specific AntennaModule from EQUIPMENT by id:
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships
Response:
{
"items": [
{
"o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
{
"bSide": "urn:oran:smo:teiv:Site=1",
"aSide": "urn:oran:smo:teiv:AntennaModule=1",
"id": "urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1"
}
]
}
],
"self": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
},
"first": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
},
"prev": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
},
"next": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
},
"last": {
"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
},
"totalCount": 1
}
Sample request to fetch all relationship types in EQUIPMENT:
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types
Response:
{
"items": [
{
"name": "ANTENNAMODULE_INSTALLED_AT_SITE",
"relationships": {
"href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships"
}
}
],
"self": {
"href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
},
"first": {
"href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
},
"prev": {
"href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
},
"next": {
"href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
},
"last": {
"href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
},
"totalCount": 1
}
Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationships from EQUIPMENT:
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships
Response:
{
"items": [
{
"o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
{
"bSide": "urn:oran:smo:teiv:Site=1",
"aSide": "urn:oran:smo:teiv:AntennaModule=1",
"id": "urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1"
}
]
},
{
"o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
{
"bSide": "urn:oran:smo:teiv:Site=2",
"aSide": "urn:oran:smo:teiv:AntennaModule=2",
"id": "urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=2"
}
]
}
],
"self": {
"href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
},
"first": {
"href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
},
"prev": {
"href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
},
"next": {
"href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
},
"last": {
"href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
},
"totalCount": 2
}
Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationship from EQUIPMENT by id:
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships/urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1
Response:
{
"o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
{
"decorators": {},
"bSide": "urn:oran:smo:teiv:Site=1",
"aSide": "urn:oran:smo:teiv:AntennaModule=1",
"classifiers": [],
"id": "urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1",
"sourceIds": []
}
]
}
Querying entities and relationships:
Use the targetFilter parameter to narrow down the fields to return. To filter the results which match a given criteria, use the scopeFilter. Think of it as an SQL statement, where the targetFilter is the SELECT, and the scopeFilter is the WHERE tag.
Supported filter options
Sample request to query AntennaModule entities and attributes from EQUIPMENT:
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entities?targetFilter=/AntennaModule/attributes
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities?targetFilter=/attributes
Response:
{
"items": [
{
"o-ran-smo-teiv-equipment:AntennaModule": [
{
"attributes": {
"mechanicalAntennaTilt": 10,
"mechanicalAntennaBearing": 50,
"positionWithinSector": "Unknown",
"geo-location": {
"height": 3000,
"latitude": 41.73297,
"longitude": -73.007696
},
"antennaModelNumber": "1",
"totalTilt": 14,
"antennaBeamWidth": [
35,
23,
21
],
"electricalAntennaTilt": 2
},
"id": "urn:oran:smo:teiv:AntennaModule=1"
}
]
},
{
"o-ran-smo-teiv-equipment:AntennaModule": [
{
"attributes": {
"mechanicalAntennaTilt": 12,
"mechanicalAntennaBearing": 45,
"positionWithinSector": "Unknown",
"geo-location": {
"height": 2500,
"latitude": 43.75443,
"longitude": -71.096454
},
"antennaModelNumber": "2",
"totalTilt": 15,
"antennaBeamWidth": [
45,
32,
21
],
"electricalAntennaTilt": 1
},
"id": "urn:oran:smo:teiv:AntennaModule=2"
}
]
}
],
"self": {
"href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
},
"first": {
"href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
},
"prev": {
"href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
},
"next": {
"href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
},
"last": {
"href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
},
"totalCount": 2
}
Sample request to query CloudifiedNFs name attribute from EQUIPMENT:
GET https://<host>/topology-inventory/<API_VERSION>/domains/CLOUD/entities?targetFilter=/CloudifiedNF/attributes(name)
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/CLOUD/entity-types/CloudifiedNF/entities?targetFilter=/attributes(name)
Response:
{
"items": [
{
"o-ran-smo-teiv-cloud:CloudifiedNF": [
{
"attributes": {
"name": "CloudifiedNF-1"
},
"id": "urn:oran:smo:teiv:CloudifiedNF:1"
}
]
}
],
"self": {
"href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
},
"first": {
"href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
},
"prev": {
"href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
},
"next": {
"href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
},
"last": {
"href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
},
"totalCount": 1
}
Sample request to query ODUFunction entities and the gNBId, gNBIdLength attributes from RAN:
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entities?targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entity-types/ODUFunction/entities?targetFilter=/attributes(gNBId, gNBIdLength)
Response:
{
"items": [
{
"o-ran-smo-teiv-ran:ODUFunction": [
{
"attributes": {
"gNBId": 1,
"gNBIdLength": 23
},
"id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1"
}
]
}
],
"self": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)"
},
"first": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)"
},
"prev": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)"
},
"next": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)"
},
"last": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)"
},
"totalCount": 1
}
Sample request to query RAN for ODUFunction, NRSectorCarrier, NRCellDU entities:
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entities?targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU
Response:
{
"items": [
{
"o-ran-smo-teiv-ran:ODUFunction": [
{
"id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1"
}
]
},
{
"o-ran-smo-teiv-ran:NRCellDU": [
{
"id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRCellDU=1"
}
]
},
{
"o-ran-smo-teiv-ran:NRCellDU": [
{
"id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRCellDU=2"
}
]
},
{
"o-ran-smo-teiv-ran:NRSectorCarrier": [
{
"id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRSectorCarrier=1"
}
]
},
{
"o-ran-smo-teiv-ran:NRSectorCarrier": [
{
"id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRSectorCarrier=2"
}
]
},
{
"o-ran-smo-teiv-ran:NRSectorCarrier": [
{
"id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRSectorCarrier=3"
}
]
}
],
"self": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
},
"first": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
},
"prev": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
},
"next": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
},
"last": {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
},
"totalCount": 6
}
Sample request to query RAN ODUFunction filtered by gNBIdLength=23 and gNBId=1:
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entities?targetFilter=/ODUFunction&scopeFilter=%2FODUFunction%2Fattributes%5B%40gNBIdLength=23 and %40gNBId=1%5D
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entity-types/ODUFunction/entities?scopeFilter=%2FODUFunction%2Fattributes%5B%40gNBIdLength=23 and %40gNBId=1%5D
Response:
{
"items": [
{
"o-ran-smo-teiv-ran:ODUFunction": [
{
"id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1"
}
]
}
],
"self": {
"href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
},
"first": {
"href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
},
"prev": {
"href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
},
"next": {
"href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
},
"last": {
"href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
},
"totalCount": 1
}