Table of Contents

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, and TEIV Ingestion. The 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.

...

language	text
title	Example Data
linenumbers	true
collapse	true

...

Table of Contents

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 docu mentation.

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:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains

Response:

Code Block

title	GET domains Response
linenumbers	true
collapse	true

{
    "items": [
        {
 },           "fdnname": "ManagedElement=NR01,GNBDUFunction=1CLOUD",
            "cmIdentityTypes": {
                "cmHandlehref": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",/domains/CLOUD/entity-types"
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]"},
           } "relationshipTypes": {
      }       }     ],
"href": "/domains/CLOUD/relationship-types"
   "o-ran-smo-teiv-ran:NRSectorCarrier": [       { }
       "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1", },
        {
"attributes": {           "arfcnDLname": 4000"EQUIPMENT",
            "arfcnULentityTypes": 40000,
 {
        "frequencyDL": 4,       "href": "/domains/EQUIPMENT/entity-types"
  "frequencyUL": 40,         },
 "fdn": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1",           "cmIdrelationshipTypes": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier"href": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRSectorCarrier[@id=1]domains/EQUIPMENT/relationship-types"
            }
        },
      },  {
    {         "idname": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2OAM",
          "attributes  "entityTypes": {
          "arfcnDL": 5000      "href": "/domains/OAM/entity-types"
            },
            "arfcnULrelationshipTypes": 50000,{
                "frequencyDLhref": 5, "/domains/OAM/relationship-types"
            }
       "frequencyUL": 50},
        {
    "fdn        "name": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2RAN",
            "cmIdentityTypes": {
                "cmHandlehref": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",/domains/RAN/entity-types"
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRSectorCarrier[@id=2]"},
           } "relationshipTypes": {
      }       },   "href": "/domains/RAN/relationship-types"
  {         "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3", }
        "attributes": {},
        {
  "arfcnDL": 6000,           "arfcnULname": 60000,"REL_CLOUD_RAN",
            "frequencyDLentityTypes": {
6,           "frequencyUL": 60,           "fdn"href": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3",/domains/REL_CLOUD_RAN/entity-types"
           "cmId": { },
            "cmHandlerelationshipTypes": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG", {
                "resourceIdentifierhref": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRSectorCarrier[@id=3]domains/REL_CLOUD_RAN/relationship-types"
            }
        },
      }  {
  ],     "o-ran-smo-teiv-ran:NRCellDU": [       {"name": "REL_EQUIPMENT_RAN",
        "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1",   "entityTypes": {
    "attributes": {           "cellLocalIdhref": 1,"/domains/REL_EQUIPMENT_RAN/entity-types"
           "nRTAC": 40},
            "nRPCIrelationshipTypes": 400,
{
         "nCI": 24577,           "fdnhref": "ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1",/domains/REL_EQUIPMENT_RAN/relationship-types"
           "cmId": {}
        },
   "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",    {
        "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRCellDU[@id=1]"   "name": "REL_OAM_CLOUD",
      }         }"entityTypes": {
      },       {         "id"href": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",/domains/REL_OAM_CLOUD/entity-types"
        "attributes": {   },
       "cellLocalId": 2,    "relationshipTypes":  {
    "nRTAC": 50,           "nRPCIhref": 500,"/domains/REL_OAM_CLOUD/relationship-types"
          "nCI": 24578, }
         "fdn": "ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",
 },
        "cmId": {
            "cmHandlename": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAGREL_OAM_RAN",
            "resourceIdentifierentityTypes": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRCellDU[@id=2]"{
          }         }"href": "/domains/REL_OAM_RAN/entity-types"
       }     ]},
    "o-ran-smo-teiv-ran:AntennaCapability": [        "relationshipTypes": {
        "id": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1",
        "attributeshref": {
 "/domains/REL_OAM_RAN/relationship-types"
        "eUtranFqBands": "[1,2,3]",   }
       "geranFqBands": "[10,11,12]", },
        {
 "nRFqBands": "[100,101,102]",           "fdnname": "ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1TEIV",
            "cmIdentityTypes": {
                "cmHandlehref": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-ComTop:NodeSupport[@id=1]/o-ran-smo-RmeSectorEquipmentFunction:SectorEquipmentFunction[@id=1]"/domains/TEIV/entity-types"
            },
        }    "relationshipTypes": {
 },
      {         "idhref": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2",/domains/TEIV/relationship-types"
        "attributes": {   }
       "eUtranFqBands": "[4,5,6]", }
     ],
    "geranFqBandsself": "[13,14,15]",
 {
        "nRFqBandshref": "[103,104,105]"/domains?offset=0&limit=500"
    },
    "first": {
        "fdnhref": "ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2",/domains?offset=0&limit=500"
    },
     "cmIdprev": {
            "cmHandlehref": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",/domains?offset=0&limit=500"
    },
    "next": {
        "resourceIdentifierhref": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-ComTop:NodeSupport[@id=1]/o-ran-smo-RmeSectorEquipmentFunction:SectorEquipmentFunction[@id=2]"
  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:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/schemas

Response:

Code Block

language	text
title	GET schemas Response
linenumbers	true
collapse	true

{
    "o-ran-smo-teiv-equipment:AntennaModuleitems": [
        {
            "idname": "urn:o-ran:smo-teiv-equipment:1",_3gpp-common-yang-extensions",
            "attributesdomain": "",
{            "antennaModelNumberrevision": "12019-06-23",
            "mechanicalAntennaBearingcontent": 50, {
                "mechanicalAntennaTilthref": 10,"/schemas/_3gpp-common-yang-extensions/content"
          "positionWithinSector": "Unknown", }
         "totalTilt": 14},
        {
 "electricalAntennaTilt": 2,           "fdnname": "Unknown_3gpp-common-yang-types",
            "cmIddomain": {"",
            "cmHandlerevision": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG2022-07-26",
            "resourceIdentifiercontent": "Unknown"{
          }      "href": "/schemas/_3gpp-common-yang-types/content"
            }
        },
        {
            "idname": "urn:o-ran:smo-teiv-equipment:2",ietf-geo-location",
            "attributesdomain": "",
 {           "antennaModelNumberrevision": "22022-02-11",
            "mechanicalAntennaBearingcontent": 45,
  {
       "mechanicalAntennaTilt": 12,
          "positionWithinSectorhref": "Unknown",/schemas/ietf-geo-location/content"
          "totalTilt": 15, }
         "electricalAntennaTilt": 1},
         {
"fdn": "Unknown",           "cmIdname": {"ietf-inet-types",
            "cmHandledomain": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifierrevision": "Unknown2013-07-15",
          }  "content": {
     }       }     ],"href": "/schemas/ietf-inet-types/content"
    "o-ran-smo-teiv-equipment:Site": [       {}
        "id": "urn:o-ran:smo-teiv-equipment:1",},
        {
"attributes": {           "name": "Siteietf-yang-1types",
            "geo-locationdomain": {"",
            "latituderevision": 41.73297"2013-07-15",
            "longitudecontent": -78.007696{
          },           "cmId": {"href": "/schemas/ietf-yang-types/content"
            }
"cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",       },
     "resourceIdentifier": "Unknown"  {
        }    "name": "o-ran-smo-teiv-cloud",
   }       },  "domain": "CLOUD",
   {         "idrevision": "urn:o-ran:smo-teiv-equipment:2",2024-05-02",
            "attributescontent": {
          "name      "href": "Site-2",/schemas/o-ran-smo-teiv-cloud/content"
           "geo-location": { }
        },
   "latitude": 46.73297,    {
        "longitude": -76.007696   "name": "o-ran-smo-teiv-common-yang-extensions",
      },           "cmIddomain": {"",
            "cmHandlerevision": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG2024-05-24",
            "resourceIdentifiercontent": "Unknown" {
              }  "href": "/schemas/o-ran-smo-teiv-common-yang-extensions/content"
     }       }
        ]},
    "o-ran-smo-teiv-ran:Sector": [   {
   {         "idname": "urn:o-ran:-smo-teiv-ran:1common-yang-types",
            "attributesdomain": "",
 {           "sectorIdrevision": 1,
          "azimuth": 75.345,"2024-05-24",
            "geo-locationcontent": {
            "latitude": 40.73297,             "longitude"href": -74.007696"/schemas/o-ran-smo-teiv-common-yang-types/content"
            }
        },
      },  {
    {
        "idname": "urn:o-ran:-smo-teiv-ran:2equipment",
        "attributes": {           "sectorId"domain": 2"EQUIPMENT",
            "azimuthrevision": 90.8967,"2024-05-24",
            "geo-locationcontent": {
                "latitudehref": 41.73297,"/schemas/o-ran-smo-teiv-equipment/content"
            "longitude": -73.007696
  }
        },
        }{
      }     ],
     "name": "o-ran-smo-teiv-cloud:CloudifiedNFoam":,
[       {
        "iddomain": "urn:o-ran:smo-teiv-cloud:1OAM",
            "attributesrevision": { "2024-05-24",
            "namecontent": "CloudifiedNF-1"{
        }       }     ],
    ""href": "/schemas/o-ran-smo-teiv-cloud:NFDeployment": [oam/content"
         {   }
     "id": "urn:o-ran:smo-teiv-cloud:1",   },
        {
"attributes": {           "name": "NFDeployment-1"o-ran-smo-teiv-ran",
        }    "domain": "RAN",
 }     ]   },   "relationshipsrevision": {"2024-05-24",
            "o-ran-smo-teiv-oam-to-ran:MANAGEDELEMENT_MANAGES_GNBDUFUNCTIONcontent": [{
       {         "idhref": "urn:/schemas/o-ran:-smo-teiv-oam-to-logical:1",ran/content"
          "aSide": "urn:3gpp:dn:ManagedElement=NR01",
 }
       "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1" },
        {
   }     ],    "name": "o-ran-smo-teiv-rel-cloud-ran:GNBDUFUNCTION_PROVIDES_NRSECTORCARRIER": [",
      {         "iddomain": "urn:o-ran:smo-teiv-ran:1",REL_CLOUD_RAN",
            "aSiderevision": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=12024-05-02",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1"   "content": {
  },
      {         "idhref": "urn:/schemas/o-ran:-smo-teiv-ran:2",rel-cloud-ran/content"
          "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",
 }
       "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2"
 },
     },   {
   {         "idname": "urn:o-ran:-smo-teiv-rel-equipment-ran:3",
            "aSidedomain": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",REL_EQUIPMENT_RAN",
            "bSiderevision": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3"2024-05-24",
       }     ],
"content": {
   "o-ran-smo-teiv-ran:GNBDUFUNCTION_PROVIDES_NRCELLDU": [       {         "idhref": "urn:/schemas/o-ran:-smo-teiv-ran:1",rel-equipment-ran/content"
          "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",
 }
       "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1" },
      },   {
   {         "idname": "urn:o-ran:-smo-teiv-ran:2-rel-oam-cloud",
            "aSidedomain": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",REL_OAM_CLOUD",
          "bSide  "revision": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2"
  2024-05-02",
   }     ],     "o-ran-smo-teiv-ran:NRCELLDU_USES_NRSECTORCARRIER"content": [{
       {         "idhref": "urn:/schemas/o-ran:-smo-teiv-ran:1",-rel-oam-cloud/content"
         "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1",  }
      "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1"
  },
     },   {
   {         "idname": "urn:o-ran:-smo-teiv-rel-oam-ran:2",
            "aSidedomain": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2REL_OAM_RAN",
            "bSiderevision": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2"2024-05-24",
      },      "content": {
        "id        "href": "urn:/schemas/o-ran:-smo-teiv-ran:3",rel-oam-ran/content"
           "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2", }
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3"
  }
    }
    ],
    "o-ran-smo-teiv-ran:NRSECTORCARRIER_USES_ANTENNACAPABILITYself": [       {
        "idhref": "urn:o-ran:smo-teiv-ran:1",/schemas?offset=0&limit=500"
    },
    "aSidefirst": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1",{
        "bSidehref": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1"
 /schemas?offset=0&limit=500"
    },
     "prev": {
        "idhref": "urn:o-ran:smo-teiv-ran:2",/schemas?offset=0&limit=500"
    },
    "aSidenext": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2",{
        "bSidehref": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2/schemas?offset=0&limit=500"
      },
     "last": {
        "idhref": "urn:o-ran:smo-teiv-ran:3",/schemas?offset=0&limit=500"
    },
    "aSidetotalCount": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2"
      }
    ],
    "o-ran-smo-teiv-equipment-to-ran:ANTENNAMODULE_SERVES_ANTENNACAPABILITY": [
      { 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.

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/schemas?domain=.*CLOUD.*

Response:

Code Block

language	text
title	GET CLOUD Schema Response
linenumbers	true
collapse	true

{
    "items": [
        {
             "idname": "urn:o-ran:-smo-teiv-equipment-to-ran:1cloud",
            "aSidedomain": "urn:o-ran:smo-teiv-equipment:1CLOUD",
            "bSiderevision": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1"2024-05-02",
       },      "content": {

       "id": "urn:o-ran:smo-teiv-equipment-to-ran:2",         "aSidehref": "urn:/schemas/o-ran:-smo-teiv-equipment:2",cloud/content"
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2"   }
   }     ]},
    "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [   {
   {         "idname": "urn:o-ran:-smo-teiv-equipment:1rel-cloud-ran",
            "aSidedomain": "urn:o-ran:smo-teiv-equipment:1","REL_CLOUD_RAN",
         "bSide": "urn:o-ran:smo-teiv-equipment:1"       },
      {
        "id"revision": "urn:o-ran:smo-teiv-equipment:22024-05-02",

       "aSide": "urn:o-ran:smo-teiv-equipment:2",         "bSidecontent": "urn:o-ran:smo-teiv-equipment:2"
    {
 }
    ],
    "o-ran-smo-teiv-equipment-to-ran:SECTOR_GROUPS_NRCELLDU": [
      {
        "id": "urn:o-ran:smo-teiv-equipment-to-ran:1",
        "aSide": "urn:o-ran:smo-teiv-ran:1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1"
      },
      {
        "id": "urn:o-ran:smo-teiv-equipment-to-ran:2",
        "aSide": "urn:o-ran:smo-teiv-ran:2",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2"
      },
      {
        "id": "urn:o-ran:smo-teiv-equipment-to-ran:3",
        "aSide": "urn:o-ran:smo-teiv-ran:2",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=3"
      }
    ],
    "o-ran-smo-teiv-oam-to-cloud:NFDEPLOYMENT_SERVES_MANAGEDELEMENT": [
      {
        "id": "urn:o-ran:smo-teiv-oam-to-cloud:1",
        "aSide": "urn:o-ran:smo-teiv-cloud:1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01"
      }
    ],
    "o-ran-smo-teiv-oam-to-cloud:MANAGEDELEMENT_DEPLOYED_AS_CLOUDIFIEDNF": [
      {
        "id": "urn:o-ran:smo-teiv-oam-to-cloud:1",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01",
        "bSide": "urn:o-ran:smo-teiv-cloud:1"
      }
    ],
    "o-ran-smo-teiv-cloud:CLOUDIFIEDNF_COMPRISES_NFDEPLOYMENT": [
      {
        "id": "urn:o-ran:smo-teiv-cloud:1",
        "aSide": "urn:o-ran:smo-teiv-cloud:1",
        "bSide": "urn:o-ran:smo-teiv-cloud:1"
      }
    ],
    "o-ran-smo-teiv-cloud-to-ran:NFDEPLOYMENT_SERVES_GNBDUFUNCTION": [
      {
        "id": "urn:o-ran:smo-teiv-cloud-to-ran:1",
        "aSide": "urn:o-ran:smo-teiv-cloud:1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1"
      }
    ]
  }
}

Sample API calls

To get a list of all API calls and details go to TEIV API docu mentation.

To get a list of supported domains click here.

Postman collection

Collection:

Environment:

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:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains

Response:

Code Block

title	GET domains Response
linenumbers	true
collapse	true

{
    "items": [
        {               "href": "/schemas/o-ran-smo-teiv-rel-cloud-ran/content"
            }
        },
        {
            "name": "o-ran-smo-teiv-rel-oam-cloud",
            "domain": "REL_OAM_CLOUD",
            "namerevision": "CLOUD2024-05-02",
            "entityTypescontent": {
                "href": "/domains/CLOUD/entity-typesschemas/o-ran-smo-teiv-rel-oam-cloud/content"
            },
        }
   "relationshipTypes": { ],
    "self": {
          "href": "/domains/CLOUD/relationship-typesschemas?offset=0&limit=500&domain=.*CLOUD.*"
    },
    "first": {
  }      "href": "/schemas?offset=0&limit=500&domain=.*CLOUD.*"
 },   },
    "prev": {

           "namehref": "CLOUD_TO_RAN",/schemas?offset=0&limit=500&domain=.*CLOUD.*"
       },
    "entityTypesnext": {
                "href": "/domains/CLOUD_TO_RAN/entity-typesschemas?offset=0&limit=500&domain=.*CLOUD.*"
            },
       
    "relationshipTypeslast": {
                "href": "/domains/CLOUD_TO_RAN/relationship-types"
            }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.

Code Block

language	xml

GET  {
            "name": "EQUIPMENT",https://<host>/topology-inventory/<API_VERSION>/schemas/o-ran-smo-teiv-oam/content

Response:

Code Block

language	text
title	GET OAM Schema Content Response
linenumbers	true
collapse	true

module o-ran-smo-teiv-oam {
    yang-version 1.1;
    namespace  "entityTypes": {"urn:o-ran:smo-teiv-oam";
    prefix or-teiv-oam;

    import o-ran-smo-teiv-common-yang-types     "href": "/domains/EQUIPMENT/entity-types"
{prefix or-teiv-types; }

    import o-ran-smo-teiv-common-yang-extensions {prefix    },or-teiv-yext; }

    organization       "relationshipTypes": {"Ericsson AB";
    contact "Ericsson first line support         "href": "/domains/EQUIPMENT/relationship-types"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
   "name": "EQUIPMENT_TO_RAN",
     RAN O&M domain, which are intended to represent management systems
    and management interfaces."entityTypes":;
{
    revision "2024-05-02" {
        description "href":Initial "/domains/EQUIPMENT_TO_RAN/entity-types"revision.";
        or-teiv-yext:label 0.3.0;
  },  }

         "relationshipTypes": {or-teiv-yext:domain OAM;

    list ManagedElement {
        "href": "/domains/EQUIPMENT_TO_RAN/relationship-types"
            }description "A Managed Element (ME) is a node into a telecommunication network
           },         {providing support and/or service to subscribers. An ME communicates
     "name": "OAM",             "entityTypes": {with a manager application (directly or indirectly) over one or more
      "href": "/domains/OAM/entity-types"             },interfaces for the purpose of being monitored and/or controlled.";

   "relationshipTypes": {    uses or-teiv-types:Top_Grp_Type;
        key id;

"href": "/domains/OAM/relationship-types"       container attributes {
   }         },leaf fdn {
      {          description "This Full "name": "OAM_TO_CLOUD",
 Distinguished Name (FDN) identifies
          "entityTypes": {                 "href": "/domains/OAM_TO_CLOUD/entity-types"
     an instance of the ManagedElement MO. It contains
      },             "relationshipTypes": {        the full path from the Subnetwork to the
 "href": "/domains/OAM_TO_CLOUD/relationship-types"             }         },    ManagedElement.";
    {             "name": "OAM_TO_RAN",type or-teiv-types:_3GPP_FDN_Type;
            "entityTypes":}
{
            container cmId {
 "href": "/domains/OAM_TO_RAN/entity-types"             }, uses or-teiv-types:CM_ID;
          "relationshipTypes": { }
        }
    }
 "href": "/domains/OAM_TO_RAN/relationship-types"
       }

...

Reading entities and relationships

Sample request to fetch the entities for EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types

Response:

Code Block

language	text
title	GET domain entity types Response
linenumbers	true
collapse	true

{
    }
   "items": [
    },         {
            "name": "RANAntennaModule",
            "entityTypesentities": {
                "href": "/domains/RANEQUIPMENT/entity-types/AntennaModule/entities"
            },
        },
   "relationshipTypes": {    {
            "hrefname": "/domains/RAN/relationship-types"PhysicalNF",
            }"entities": {
       },         {
"href": "/domains/EQUIPMENT/entity-types/PhysicalNF/entities"
           "name": "TEIV", }
        },
   "entityTypes": {    {
            "hrefname": "/domains/TEIV/entity-types"
            }Site",
            "relationshipTypesentities": {
                "href": "/domains/TEIVEQUIPMENT/relationship-typesentity-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": 93
}

...

Sample request to fetch

...

the AntennaModule entities from EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/schemas/domains/EQUIPMENT/entity-types/AntennaModule/entities

Response:

Code Block

language	text
title	GET schemas entities from domain Response
linenumbers	true
collapse	true

{
    "items": [
        {
            "domaino-ran-smo-teiv-equipment:AntennaModule": [],
            "name": "o-ran-smo-teiv-common-yang-extensions",   {
         "content": {                 "href"id": "/schemas/o-ran-smo-teiv-common-yang-extensions/contenturn:oran:smo:teiv:AntennaModule=1"
                },
            "revision": "2024-05-02"]
        },
        {
            "domaino-ran-smo-teiv-equipment:AntennaModule": [
                "OAM_TO_CLOUD"
{
           ],             "nameid": "o-ran-smo-teiv-oam-to-cloud",urn:oran:smo:teiv:AntennaModule=2"
            "content": {   }
            ]
 "href": "/schemas/o-ran-smo-teiv-oam-to-cloud/content"      }
    ],
 },   "self": {
        "revisionhref": "2024-05-02/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
   }, "first": {
      {  "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "domainprev": [],
  {
         "namehref": "o-ran-smo-teiv-common-yang-types",/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
       "contentnext": {
 
              "href": "/domains/schemasEQUIPMENT/o-ran-smo-teiv-common-yang-types/content"entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "last": {
      },  "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "revisiontotalCount": "2024-05-02"
 2
}

...

Sample request to fetch a specific AntennaModule from EQUIPMENT by id:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1

Response:

Code Block

language	text
title	GET entity from domain by id Response
linenumbers	true
collapse	true

{
      },"o-ran-smo-teiv-equipment:AntennaModule": [
        {
            "domaindecorators": [
{},
               "OAMclassifiers"
            : [],
            "nameattributes": "o-ran-smo-teiv-oam", {
                "contentmechanicalAntennaTilt": {10,
                "hrefmechanicalAntennaBearing": "/schemas/o-ran-smo-teiv-oam/content"50,
            },
            "revision"positionWithinSector": "2024-05-02Unknown",
        },        "geo-location": {
            "domain": [       "height": 3000,
        "OAM_TO_RAN"             ]"latitude": 41.73297,
            "name        "longitude": "o-ran-smo-teiv-oam-to-ran",-73.007696
               "content": { },
                "hrefantennaModelNumber": "/schemas/o-ran-smo-teiv-oam-to-ran/content"1",
            },    "totalTilt": 14,
       "revision": "2024-05-02"         },"antennaBeamWidth": [
        {            35,
"domain": [                 "RAN"  23,
          ],          21
  "name": "o-ran-smo-teiv-ran",             "content": {],
                "hrefelectricalAntennaTilt": "/schemas/o-ran-smo-teiv-ran/content"2
            },
            "revisionid": "2024-05-02"
        },
  urn:oran:smo:teiv:AntennaModule=1",
     {             "domain"sourceIds": [
                "EQUIPMENT"urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaUnit=1",
            ],         "urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaUnit=1,AntennaSubunit=1",
   "name": "o-ran-smo-teiv-equipment",             "content": {urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaNearUnit=1,RetSubUnit=1"
            ]
        }
   "href": "/schemas/o-ran-smo-teiv-equipment/content" ]
}

...

Sample request to fetch all relationships from a specific AntennaModule from EQUIPMENT by id:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships

Response:

Code Block

language	text
title	GET entity relationships from domain by id Response
linenumbers	true
collapse	true

{
    "items": [
       }, {
           "revision": "2024-05-02"
o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
       },         {
            "domain": [                 "CLOUD_TO_RAN"
    "bSide": "urn:oran:smo:teiv:Site=1",
       ],             "nameaSide": "o-ran-smo-teiv-cloud-to-ranurn:oran:smo:teiv:AntennaModule=1",
            "content": {
                "hrefid": "/schemas/o-ran-smo-teiv-cloud-to-ran/contenturn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1"
            },    }
         "revision": "2024-05-02"  ]
      },  }
    ],
 {   "self": {
        "href"domain": [: "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
    },
    "first": {
         "CLOUD"href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
    },
       ],
   "prev": {
        "namehref": "o-ran-smo-teiv-cloud",/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
       },
    "contentnext": {
   
            "href": "/schemasdomains/EQUIPMENT/o-ran-smo-teiv-cloud/content"
            },
            "revision": "2024-05-02"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"
    },
    "domaintotalCount": [
    1
}

...

Sample request to fetch all relationship types in EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types

Response:

Code Block

language	text
title	GET all domain relationship types Response
linenumbers	true
collapse	true

{
           "EQUIPMENT_TO_RAN"
"items": [
        {
  ],             "name": "o-ran-smo-teiv-equipment-to-ranANTENNAMODULE_INSTALLED_AT_SITE",
            "contentrelationships": {
                "href": "/schemasdomains/EQUIPMENT/o-ran-smo-teiv-equipment-to-ran/contentrelationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships"
            },
   
        "revision": "2024-05-02"
        }
    ],
    "self": {
        "href": "/schemasdomains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "first": {
        "href": "/schemas/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "prev": {
        "href": "/schemas/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "next": {
        "href": "/schemas "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "last": {
        "href": "/schemas/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "totalCount": 101
}

...

Sample request to fetch

...

To get a list of all modules for a specific domain, use a domain query parameter. The query parameter is case sensitive.

...

ANTENNAMODULE_INSTALLED_AT_SITE relationships from EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/schemas?domain=.*CLOUD.*domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships

Response:

{

Code Block

language	text
title	GET CLOUD Schema specific relationships from domain Response
linenumbers	true
collapse	true

collapse	true

{
    "items": [
        {
            "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
                {
                    "bSide": "urn:oran:smo:teiv:Site=1",
                    "itemsaSide": ["urn:oran:smo:teiv:AntennaModule=1",
        {
            "domainid": ["urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1"
                "OAM_TO_CLOUD"}
            ]
        },
        {
   "name":         "o-ran-smo-teiv-oam-to-cloud",equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
               "content": {
                    "hrefbSide": "/schemas/o-ran-smo-teiv-oam-to-cloud/content"urn:oran:smo:teiv:Site=2",
            },
            "revisionaSide": "2024-05-02"
        }urn:oran:smo:teiv:AntennaModule=2",
        {
            "domainid": ["urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=2"
                "CLOUD_TO_RAN"}
            ],
        }
   "name": "o-ran-smo-teiv-cloud-to-ran" ],
    "self": {
        "contenthref": {
 "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "first": {
        "href": "/domains/schemasEQUIPMENT/o-ran-smo-teiv-cloud-to-ran/contentrelationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "prev": {
 },
            "revisionhref": "2024-05-02/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
        },
       "next": {
            "domain": ["href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
            "CLOUD"
"last": {
        "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
 ],   },
    "totalCount": 2
   "name": "o-ran-smo-teiv-cloud",
            "content": {
           }

...

Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationship from EQUIPMENT by id:

Code Block

language	xml

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:

Code Block

language	text
title	GET a specific relationship from domain by id Response
linenumbers	true
collapse	true

{
    "href": "/schemas/o-ran-smo-teiv-cloud/content"
            },
            "revision": "2024-05-02"
        }equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
      ],  {
  "self": {         "hrefdecorators": "/schemas?offset=0&limit=500"
    {},
    "first": {         "hrefbSide": "/schemas?offset=0&limit=500"
    },
    "prev": {urn:oran:smo:teiv:Site=1",
            "hrefaSide": "/schemas?offset=0&limit=500"urn:oran:smo:teiv:AntennaModule=1",
    },        "nextclassifiers": {[],
            "hrefid": "/schemas?offset=0&limit=500"urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1",
    },        "lastsourceIds": {[]
        "href": "/schemas?offset=0&limit=500"}
    ]
},
    "totalCount": 3
}

Sample request to fetch the module data for the o-ran-smo-teiv-oam module:

...

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:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/schemas/o-ran-smo-teiv-oam/content/domains/EQUIPMENT/entities?targetFilter=/AntennaModule/attributes
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities?targetFilter=/attributes

Response:

Code Block

language	text
title	GET OAM Schema Content domain entities and attributes Response
linenumbers	true
collapse	true

module o-ran-smo-teiv-oam{
    "items": [
        {
    yang-version 1.1;       namespace "urn:o-ran:-smo-teiv-oam";equipment:AntennaModule": [
                {
            prefix or-teiv-oam;      import o-ran-smo-teiv-common-yang-types {prefix or-teiv-types; } "attributes": {
       import o-ran-smo-teiv-common-yang-extensions {prefix or-teiv-yext; }      organization "Ericsson AB";     contact "mechanicalAntennaTilt"Ericsson: first10,
line support via email";     description     "RAN O&M topology model.      Copyright (c) 2023 Ericsson AB. All rights reserved. "mechanicalAntennaBearing": 50,
         This model contains the topology entities and relations in the     RAN O&M domain, which are intended to represent management systems "positionWithinSector": "Unknown",
               and management interfaces.";      revision "2024geo-05-02location": {
        description "Initial revision.";                    or-teiv-yext:label 0.3.0;"height": 3000,
    }      or-teiv-yext:domain OAM;      list ManagedElement {         description "latitude"A Managed Element (ME) is a node into a telecommunication network: 41.73297,
                             providing support and/or service to subscribers. An ME communicates"longitude": -73.007696
                        },
   with a manager application (directly or indirectly) over one or more           "antennaModelNumber": "1",
        interfaces for the purpose of being monitored and/or controlled.";        "totalTilt": 14,
uses or-teiv-types:Top_Grp_Type;         key id;          container attributes { "antennaBeamWidth": [
          leaf fdn {                35,
description "This Full Distinguished Name (FDN) identifies                      23,
      an instance of the ManagedElement MO. It contains               21
             the full path from the Subnetwork to the    ],
                        ManagedElement.";"electricalAntennaTilt": 2
                  type or-teiv-types:_3GPP_FDN_Type;
 },
           }         "id": "urn:oran:smo:teiv:AntennaModule=1"
   container cmId {           }
     uses or-teiv-types:CM_ID;       ]
        },
        {
}     } }

Reading entities and relationships

Sample request to fetch the entities for EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types

Response:

Code Block

language	text
title	GET domain entity types Response
linenumbers	true
collapse	true

{     "itemso-ran-smo-teiv-equipment:AntennaModule": [
          {      {
      "name": "AntennaModule",             "entitiesattributes": {
                "href        "mechanicalAntennaTilt": "/domains/EQUIPMENT/entity-types/AntennaModule/entities" 12,
               }         },"mechanicalAntennaBearing": 45,
           {             "namepositionWithinSector": "PhysicalNFUnknown",
            "entities            "geo-location": {
                "href": "/domains/EQUIPMENT/entity-types/PhysicalNF/entities"             }
 "height": 2500,
      },         {             "namelatitude": "Site"43.75443,
            "entities": {
                "hreflongitude": "/domains/EQUIPMENT/entity-types/Site/entities"-71.096454
               }         },
    ],          "self": {         "hrefantennaModelNumber": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"2",
    },          "first": {         "hreftotalTilt": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"15,
         },     "prev": {         "hrefantennaBeamWidth": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"[
       },     "next": {         "href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"     }45,
    "last": {         "href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },     "totalCount": 3 }

Sample request to fetch the AntennaModule entities from EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entities/AntennaModule/entities

Response:

Code Block

language	text
title	GET entities from domain Response
linenumbers	true
collapse	true

{
 32,
   "items": [         {             "o-ran-smo-teiv-equipment:AntennaModule": [ 21
               {         ],
           "id": "urn:o-ran:smo-teiv-equipment:1"            "electricalAntennaTilt": 1
   },                 {},
                    "id": "urn:o-ranoran:smo-:teiv-equipment:AntennaModule=2"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "first": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "next": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "last": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "totalCount": 2
}

...

Sample request to

...

query CloudifiedNFs name attribute from EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/CLOUD/entities?targetFilter=/CloudifiedNF/attributes(name)
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/CLOUD/entity-types/AntennaModuleCloudifiedNF/entities/urn:o-ran:smo-teiv-equipment:1?targetFilter=/attributes(name)

Response:

Code Block

language	text
title	GET entity from domain by id get domain entities and specific attributes Response
linenumbers	true
collapse	true

{
    "o-ran-smo-teiv-equipment:AntennaModuleitems": [
        {
            "decorators": {},
            "classifiers": [],
            "attributes": {
                "mechanicalAntennaBearing": 50,
                "mechanicalAntennaTilt": 10,
 o-ran-smo-teiv-cloud:CloudifiedNF": [
              "positionWithinSector": "Unknown",  {
              "fdn": "Unknown",     "attributes": {
          "geo-location": null,                 "antennaModelNumbername": "CloudifiedNF-1",
                   "totalTilt": 14},
                    "antennaBeamWidthid": null,"urn:oran:smo:teiv:CloudifiedNF:1"
                "cmId":}
{            ]
        "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",}
    ],
       "self": {
        "resourceIdentifierhref": "Unknown/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)"
    },
    "electricalAntennaTiltprev": {
2        "href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
    },
    "next": {
        "idhref": "urn:o-ran:smo-teiv-equipment:1"/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
    },
    "last": {
        "sourceIdshref": []"/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:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/RAN/entities?targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationshipsODUFunction/entities?targetFilter=/attributes(gNBId, gNBIdLength)

Response:

Code Block

language	text
title	GET entity relationships from domain by id domain entities and multiple attributes Response
linenumbers	true
collapse	true

{
    "items": [
        {
            "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITEran:ODUFunction": [
                {
                    "bSideattributes": "urn:o-ran:smo-teiv-equipment:1", {
                        "aSidegNBId": "urn:o-ran:smo-teiv-equipment:1",
 
                  "id": "urn:o-ran:smo-teiv-equipment:1"            "gNBIdLength": 23
   }             ]         },
        {             "o-ran-smo-teiv-equipment-to-ran:ANTENNAMODULE_SERVES_ANTENNACAPABILITY": ["id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1"
                }
{            ]
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1",}
    ],
       "self": {
        "aSidehref": "urn:o-ran:smo-teiv-equipment:1",
/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)"
    },
    "first": {
        "idhref": "urn:o-ran:smo-teiv-equipment-to-ran:1/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)"
    ]},
    "selflast": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction/attributes(gNBId, gNBIdLength)"
    },
    "firsttotalCount": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500"1
}

...

Sample request to query RAN for ODUFunction, NRSectorCarrier, NRCellDU entities:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entities?targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU

Response:

Code Block

language	text
title	GET multiple different domain entities Response
linenumbers	true
collapse	true

{
    "items": [
     },   {
 "prev": {         "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:-smo-teiv-equipment:1/relationships?offset=0&limit=500"
ran:ODUFunction": [
   },     "next": {         "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500"{
     },     "last": {         "hrefid": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500"3gpp:dn:ManagedElement=NR01,ODUFunction=1"
            },    }
            "totalCount":]
2 }

Sample request to fetch all relationship types in EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types

Response:

Code Block

language	text
title	GET all domain relationship types Response
linenumbers	true
collapse	true

{     "items": [ },
        {
            "nameo-ran-smo-teiv-ran:NRCellDU": "ANTENNAMODULE_INSTALLED_AT_SITE",[
               "relationships": {
                    "hrefid": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationshipsurn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRCellDU=1"
            }         },
        {    ]
        "name": "PHYSICALNF_INSTALLED_AT_SITE",
},
           "relationships": {
 
              "href": "/domains/EQUIPMENT/relationship-types/PHYSICALNF_INSTALLED_AT_SITE/relationships""o-ran-smo-teiv-ran:NRCellDU": [
            }        {
}     ],     "self": {         "hrefid": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRCellDU=2"
    },     "first": {      }
  "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },     "prev":]
{        },
"href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"     },  {
  "next": {         "hrefo-ran-smo-teiv-ran:NRSectorCarrier": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500" [
          },     "last": {
                    "hrefid": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRSectorCarrier=1"
         },     "totalCount": 2 }

Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationships from EQUIPMENT:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships

Response:

Code Block

language	text
title	GET specific relationships from domain Response
linenumbers	true
collapse	true

{
            ]
       "items": [ },
        {
            "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [ran:NRSectorCarrier": [
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRSectorCarrier=2"
                }
            ]
        {},
        {
           "bSide": "urn:o-ran:-smo-teiv-equipmentran:1",NRSectorCarrier": [
                {
                    "aSideid": "urn:o-ran:smo-teiv-equipment:1",3gpp:dn:ManagedElement=NR01,ODUFunction=1,NRSectorCarrier=3"
                }
   "id": "urn:o-ran:smo-teiv-equipment:1"        ]
        },
    ],
    "self": {
        {
"href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
    },
    "first": {
        "bSidehref": "urn:o-ran:smo-teiv-equipment:2",/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
    },
    "prev":  {
        "aSidehref": "urn:o-ran:smo-teiv-equipment:2",/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
    },
    "next": {
         "idhref": "urn:o-ran:smo-teiv-equipment:2"
        /domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
       },
    "last": {
      ]    "href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/ODUFunction;/NRSectorCarrier;/NRCellDU"
    }
    ],
    "selftotalCount": {
        "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "first": {6
}

...

Sample request to query RAN ODUFunction filtered by gNBIdLength=23 and gNBId=1:

Code Block

language	xml

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:

Code Block

language	text
title	GET domain entities filtered by specific attributes Response
linenumbers	true
collapse	true

{
    "items": [
        {
            "hrefo-ran-smo-teiv-ran:ODUFunction": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500" [
          },     "prev": {
            "href        "id": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"urn:3gpp:dn:ManagedElement=NR01,ODUFunction=1"
         },       }
     "next": {      ]
  "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"     }
    ],
    "lastself": {
        "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
    },

   "totalCount": 2
}

Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationship from EQUIPMENT by id:

Code Block

language	xml

GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships/urn:o-ran:smo-teiv-equipment:1

Response:

Code Block

language	text
title	GET a specific relationship from domain by id Response
linenumbers	true
collapse	true

 "first": {
    "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
     "href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
    },
 {   "prev": {
        "bSidehref": "urn:o-ran:smo-teiv-equipment:1",
   /domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
    },
    "next": {
        "aSidehref": "urn:o-ran:smo-teiv-equipment:1",/domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
       },
    "idlast": "urn:o-ran:smo-teiv-equipment:1",
   {
        "sourceIdshref": []
 "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/ODUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/ODUFunction"
    },
 }     ]"totalCount": 1
}

...

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Starting TEIV with Docker Compose

Starting TEIV with Docker Compose

Sample API calls

Postman collection

Retrieving and using topology modules

Sample request to fetch a list of all domains in TEIV:

Sample request to fetch a list of all modules in TEIV:

Sample request to fetch a list of all modules related to the CLOUD domain:

Sample API calls

Postman collection

Retrieving and using topology modules

Sample request to fetch a list of all domains in TEIV:

Sample request to fetch the module data for the o-ran-smo-teiv-oam module:

Reading entities and relationships

Sample request to fetch the entities for EQUIPMENT:

Sample request to fetch

the AntennaModule entities from EQUIPMENT:

Sample request to fetch a specific AntennaModule from EQUIPMENT by id:

Sample request to fetch all relationships from a specific AntennaModule from EQUIPMENT by id:

Sample request to fetch all relationship types in EQUIPMENT:

Sample request to fetch

ANTENNAMODULE_INSTALLED_AT_SITE relationships from EQUIPMENT:

Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationship from EQUIPMENT by id:

Sample request to fetch the module data for the o-ran-smo-teiv-oam module:

Querying entities and relationships:

Sample request to query AntennaModule entities and attributes from EQUIPMENT:

Reading entities and relationships

Sample request to fetch the entities for EQUIPMENT:

Sample request to fetch the AntennaModule entities from EQUIPMENT:

Sample request to

query CloudifiedNFs name attribute from EQUIPMENT:

Sample request to

query ODUFunction entities and the gNBId, gNBIdLength attributes from RAN:

Sample request to query RAN for ODUFunction, NRSectorCarrier, NRCellDU entities:

Sample request to fetch all relationship types in EQUIPMENT:

Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationships from EQUIPMENT:

Sample request to query RAN ODUFunction filtered by gNBIdLength=23 and gNBId=1:

Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationship from EQUIPMENT by id: