Versions Compared

Old Version 1

changes.mady.by.user Jeff van Dam

Saved on

compared with

New Version 2

changes.mady.by.user Jeff van Dam

Saved on

Key

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

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.

...

languagetext
titleExample Data
linenumberstrue
collapsetrue

...

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.


Code Block
languagetext
titleExample Data
linenumberstrue
collapsetrue
{
  "entities": {
    "o-ran-smo-teiv-oam:ManagedElement": [
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01",
        "attributes": {
          "fdn": "ManagedElement=NR01",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]"
          }
        }
      }
    ],
    "o-ran-smo-teiv-ran:GNBDUFunction": [
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",
        "attributes": {
          "gNBDUId": 1,
          "gNBId": 1,
          "gNBIdLength": 23,
          "dUpLMNId": {
            "mcc": 353,
            "mnc": 87
          },
          "fdn": "ManagedElement=NR01,GNBDUFunction=1",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]"
          }
        }
      }
    ],
    "o-ran-smo-teiv-ran:NRSectorCarrier": [
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1",
        "attributes": {
          "arfcnDL": 4000,
          "arfcnUL": 40000,
          "frequencyDL": 4,
          "frequencyUL": 40,
          "fdn": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRSectorCarrier[@id=1]"
          }
        }
      },
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2",
        "attributes": {
          "arfcnDL": 5000,
          "arfcnUL": 50000,
          "frequencyDL": 5,
          "frequencyUL": 50,
          "fdn": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRSectorCarrier[@id=2]"
          }
        }
      },
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3",
        "attributes": {
          "arfcnDL": 6000,
          "arfcnUL": 60000,
          "frequencyDL": 6,
          "frequencyUL": 60,
          "fdn": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRSectorCarrier[@id=3]"
          }
        }
      }
    ],
    "o-ran-smo-teiv-ran:NRCellDU": [
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1",
        "attributes": {
          "cellLocalId": 1,
          "nRTAC": 40,
          "nRPCI": 400,
          "nCI": 24577,
          "fdn": "ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1",
          "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]"
          }
        }
      },
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",
        "attributes": {
          "cellLocalId": 2,
          "nRTAC": 50,
          "nRPCI": 500,
          "nCI": 24578,
          "fdn": "ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRCellDU[@id=2]"
          }
        }
      }
    ],
    "o-ran-smo-teiv-ran:AntennaCapability": [
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1",
        "attributes": {
          "eUtranFqBands": "[1,2,3]",
          "geranFqBands": "[10,11,12]",
          "nRFqBands": "[100,101,102]",
          "fdn": "ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-ComTop:NodeSupport[@id=1]/o-ran-smo-RmeSectorEquipmentFunction:SectorEquipmentFunction[@id=1]"
          }
        }
      },
      {
        "id": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2",
        "attributes": {
          "eUtranFqBands": "[4,5,6]",
          "geranFqBands": "[13,14,15]",
          "nRFqBands": "[103,104,105]",
          "fdn": "ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-ComTop:NodeSupport[@id=1]/o-ran-smo-RmeSectorEquipmentFunction:SectorEquipmentFunction[@id=2]"
          }
        }
      }
    ],
    "o-ran-smo-teiv-equipment:AntennaModule": [
      {
        "id": "urn:o-ran:smo-teiv-equipment:1",
        "attributes": {
          "antennaModelNumber": "1",
          "mechanicalAntennaBearing": 50,
          "mechanicalAntennaTilt": 10,
          "positionWithinSector": "Unknown",
          "totalTilt": 14,
          "electricalAntennaTilt": 2,
          "fdn": "Unknown",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "Unknown"
          }
        }
      },
      {
        "id": "urn:o-ran:smo-teiv-equipment:2",
        "attributes": {
          "antennaModelNumber": "2",
          "mechanicalAntennaBearing": 45,
          "mechanicalAntennaTilt": 12,
          "positionWithinSector": "Unknown",
          "totalTilt": 15,
          "electricalAntennaTilt": 1,
          "fdn": "Unknown",
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "Unknown"
          }
        }
      }
    ],
    "o-ran-smo-teiv-equipment:Site": [
      {
        "id": "urn:o-ran:smo-teiv-equipment:1",
        "attributes": {
          "name": "Site-1",
          "geo-location": {
            "latitude": 41.73297,
            "longitude": -78.007696
          },
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "Unknown"
          }
        }
      },
      {
        "id": "urn:o-ran:smo-teiv-equipment:2",
        "attributes": {
          "name": "Site-2",
          "geo-location": {
            "latitude": 46.73297,
            "longitude": -76.007696
          },
          "cmId": {
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifier": "Unknown"
          }
        }
      }
    ],
    "o-ran-smo-teiv-ran:Sector": [
      {
        "id": "urn:o-ran:smo-teiv-ran:1",
        "attributes": {
          "sectorId": 1,
          "azimuth": 75.345,
          "geo-location": {
            "latitude": 40.73297,
            "longitude": -74.007696
          }
        }
      },
      {
        "id": "urn:o-ran:smo-teiv-ran:2",
        "attributes": {
          "sectorId": 2,
          "azimuth": 90.8967,
          "geo-location": {
            "latitude": 41.73297,
            "longitude": -73.007696
          }
        }
      }
    ],
    "o-ran-smo-teiv-cloud:CloudifiedNF": [
      {
        "id": "urn:o-ran:smo-teiv-cloud:1",
        "attributes": {
          "name": "CloudifiedNF-1"
        }
      }
    ],
    "o-ran-smo-teiv-cloud:NFDeployment": [
      {
        "id": "urn:o-ran:smo-teiv-cloud:1",
        "attributes": {
          "name": "NFDeployment-1"
        }
      }
    ]
  },
  "relationships": {
    "o-ran-smo-teiv-oam-to-ran:MANAGEDELEMENT_MANAGES_GNBDUFUNCTION": [
      {
        "id": "urn:o-ran:smo-teiv-oam-to-logical:1",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1"
      }
    ],
    "o-ran-smo-teiv-ran:GNBDUFUNCTION_PROVIDES_NRSECTORCARRIER": [
      {
        "id": "urn:o-ran:smo-teiv-ran:1",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1"
      },
      {
        "id": "urn:o-ran:smo-teiv-ran:2",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2"
      },
      {
        "id": "urn:o-ran:smo-teiv-ran:3",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3"
      }
    ],
    "o-ran-smo-teiv-ran:GNBDUFUNCTION_PROVIDES_NRCELLDU": [
      {
        "id": "urn:o-ran:smo-teiv-ran:1",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1"
      },
      {
        "id": "urn:o-ran:smo-teiv-ran:2",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2"
      }
    ],
    "o-ran-smo-teiv-ran:NRCELLDU_USES_NRSECTORCARRIER": [
      {
        "id": "urn:o-ran:smo-teiv-ran:1",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1"
      },
      {
        "id": "urn:o-ran:smo-teiv-ran:2",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2"
      },
      {
        "id": "urn:o-ran:smo-teiv-ran:3",
        "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_ANTENNACAPABILITY": [
      {
        "id": "urn:o-ran:smo-teiv-ran:1",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1"
      },
      {
        "id": "urn:o-ran:smo-teiv-ran:2",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2"
      },
      {
        "id": "urn:o-ran:smo-teiv-ran:3",
        "aSide": "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": [
      {
        "id": "urn:o-ran:smo-teiv-equipment-to-ran:1",
        "aSide": "urn:o-ran:smo-teiv-equipment:1",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1"
      },
      {
        "id": "urn:o-ran:smo-teiv-equipment-to-ran:2",
        "aSide": "urn:o-ran:smo-teiv-equipment:2",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2"
      }
    ],
    "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
      {
        "id": "urn:o-ran:smo-teiv-equipment:1",
        "aSide": "urn:o-ran:smo-teiv-equipment:1",
        "bSide": "urn:o-ran:smo-teiv-equipment:1"
      },
      {
        "id": "urn:o-ran:smo-teiv-equipment:2",
        "aSide": "urn:o-ran:smo-teiv-equipment:2",
        "bSide": "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 documentation.

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
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains


Response:

Code Block
titleGET domains Response
linenumberstrue
collapsetrue
{
    "items": [
        {
            "name": "CLOUD",
            "entityTypes": {
                "href": "/domains/CLOUD/entity-types"
            },
            "relationshipTypes": {
                "idhref": "urn:3gpp:dn:ManagedElement=NR01",/domains/CLOUD/relationship-types"
        "attributes": {   }
       "fdn": "ManagedElement=NR01", },
        {
            "cmIdname": {"CLOUD_TO_RAN",
            "cmHandleentityTypes": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG", {
                "resourceIdentifierhref": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]"/domains/CLOUD_TO_RAN/entity-types"
            },
          }  "relationshipTypes": {
      }     ],     "o-ran-smo-teiv-ran:GNBDUFunction": ["href": "/domains/CLOUD_TO_RAN/relationship-types"
          {  }
      "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",  },
        {
"attributes": {           "gNBDUIdname": 1"EQUIPMENT",
            "gNBIdentityTypes": 1, {
                "gNBIdLengthhref": 23,"/domains/EQUIPMENT/entity-types"
           "dUpLMNId": { },
            "mccrelationshipTypes": 353, {
                "mnchref": 87"/domains/EQUIPMENT/relationship-types"
          },  }
        "fdn": "ManagedElement=NR01,GNBDUFunction=1",
  },
       "cmId": {
            "cmHandlename": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAGEQUIPMENT_TO_RAN",
            "resourceIdentifierentityTypes": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]"{
          }      "href": "/domains/EQUIPMENT_TO_RAN/entity-types"
 }           },
       ],     "o-ran-smo-teiv-ran:NRSectorCarrierrelationshipTypes": [{
       {         "idhref": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1",/domains/EQUIPMENT_TO_RAN/relationship-types"
        "attributes": {   }
       "arfcnDL": 4000},
        {
 "arfcnUL": 40000,           "frequencyDLname": 4"OAM",
            "frequencyULentityTypes": 40,{
                "fdnhref": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1",/domains/OAM/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=1]"/domains/OAM/relationship-types"
            }
        },
      },   {
   {         "idname": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2",OAM_TO_CLOUD",
            "attributesentityTypes": {
          "arfcnDL": 5000,      "href": "/domains/OAM_TO_CLOUD/entity-types"
            },
            "relationshipTypes": {
                "arfcnULhref": 50000,"/domains/OAM_TO_CLOUD/relationship-types"
          "frequencyDL": 5, }
         "frequencyUL": 50},
        {
 "fdn": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2",           "cmIdname": {"OAM_TO_RAN",
            "cmHandleentityTypes": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG", {
                "resourceIdentifierhref": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRSectorCarrier[@id=2]domains/OAM_TO_RAN/entity-types"
            }
,
       }     "relationshipTypes": {
},       {         "idhref": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3",/domains/OAM_TO_RAN/relationship-types"
        "attributes": {   }
       "arfcnDL": 6000},
        {
 "arfcnUL": 60000,           "frequencyDLname": 6"RAN",
            "frequencyULentityTypes": 60,{
                "fdnhref": "ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3",/domains/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/RAN/relationship-types"
          }   }
     }       }
    ],
    "o-ran-smo-teiv-ran:NRCellDU": [   {
   {         "idname": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1",TEIV",
            "attributesentityTypes": {
                "cellLocalIdhref": 1, "/domains/TEIV/entity-types"
           "nRTAC": 40},
            "nRPCIrelationshipTypes": 400,{
          "nCI": 24577,           "fdnhref": "ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1",/domains/TEIV/relationship-types"
           "cmId": {}
        }
   "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG" ],
    "self":  {
     "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRCellDU[@id=1]   "href": "/domains?offset=0&limit=500"
    },
    "first": }{
        }
 "href": "/domains?offset=0&limit=500"
    },
    "prev":  {
        "idhref": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",/domains?offset=0&limit=500"
    },
    "attributesnext": {
 
        "cellLocalIdhref": 2,"/domains?offset=0&limit=500"
     },
    "nRTAClast": 50,
{
         "nRPCIhref": 500,"/domains?offset=0&limit=500"
     },
    "nCItotalCount": 24578,
     9
}


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

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


Response:

Code Block
languagetext
titleGET schemas Response
linenumberstrue
collapsetrue
{
    "fdnitems": "ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",
 [
        "cmId":  {
            "cmHandledomain": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG"[],
            "resourceIdentifiername": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-GNBDU:GNBDUFunction[@id=1]/o-ran-smo-GNBDU:NRCellDU[@id=2]"teiv-common-yang-extensions",
          }  "content": {
     }       }     ],
    ""href": "/schemas/o-ran-smo-teiv-ran:AntennaCapability": [-common-yang-extensions/content"
            },
            {
"revision": "2024-05-02"
       "id": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1", },
        {
"attributes": {           "eUtranFqBandsdomain": "[1,2,3]",[
                "geranFqBandsOAM_TO_CLOUD":
"[10,11,12]",           "nRFqBands": "[100,101,102]",
            "fdnname": "ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1o-ran-smo-teiv-oam-to-cloud",
            "cmIdcontent": {
         
  "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",             "resourceIdentifierhref": "/schemas/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-ComTop:NodeSupport[@id=1]/o-ran-smo-RmeSectorEquipmentFunction:SectorEquipmentFunction[@id=1]"
teiv-oam-to-cloud/content"
         }         }
      },
      {         "idrevision": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2",2024-05-02"
        "attributes": {},
           "eUtranFqBands": "[4,5,6]",{
            "geranFqBandsdomain": "[13,14,15]",
            "nRFqBandsname": "[103,104,105]",o-ran-smo-teiv-common-yang-types",
            "fdncontent": "ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2", {
                "cmIdhref": {"/schemas/o-ran-smo-teiv-common-yang-types/content"
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
},
           "resourceIdentifier": "/o-ran-smo-ComTop:ManagedElement[@id=NR01]/o-ran-smo-ComTop:NodeSupport[@id=1]/o-ran-smo-RmeSectorEquipmentFunction:SectorEquipmentFunction[@id=2]"
  "revision": "2024-05-02"
        },
        }{
            "domain": }[
      }     ],     "o-ran-smo-teiv-equipment:AntennaModule": [OAM"
            ],
   {         "idname": "urn:o-ran:-smo-teiv-equipment:1oam",
            "attributescontent": {
                "antennaModelNumberhref": "1",/schemas/o-ran-smo-teiv-oam/content"
           "mechanicalAntennaBearing": 50},
            "mechanicalAntennaTiltrevision": 10, "2024-05-02"
        },
  "positionWithinSector": "Unknown",      {
      "totalTilt": 14,     "domain": [
    "electricalAntennaTilt": 2,           "fdnOAM_TO_RAN":
"Unknown",           "cmId": { ],
            "cmHandlename": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAGo-ran-smo-teiv-oam-to-ran",
            "resourceIdentifiercontent": "Unknown"{
             }   "href": "/schemas/o-ran-smo-teiv-oam-to-ran/content"
     }       },
  
   {         "idrevision": "urn:o-ran:smo-teiv-equipment:2",2024-05-02"
        "attributes": {},
        {
  "antennaModelNumber": "2",           "mechanicalAntennaBearingdomain": 45, [
                "mechanicalAntennaTiltRAN":
12,           "positionWithinSector": "Unknown", ],
            "totalTiltname": 15,"o-ran-smo-teiv-ran",
            "electricalAntennaTiltcontent": 1,{
          "fdn": "Unknown",           "cmId": {"href": "/schemas/o-ran-smo-teiv-ran/content"
            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG"},
            "resourceIdentifierrevision": "Unknown"
 2024-05-02"
        },
        }
{
     }     ],     "o-ran-smo-teiv-equipment:Sitedomain": [
       {         "id": "urn:o-ran:smo-teiv-equipment:1",EQUIPMENT"
            ],
"attributes": {           "name": "Site-1o-ran-smo-teiv-equipment",
            "geo-locationcontent": {
            "latitude": 41.73297,   "href": "/schemas/o-ran-smo-teiv-equipment/content"
        "longitude": -78.007696   },
       },     "revision": "2024-05-02"
    "cmId": {   },
        {
"cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
            "resourceIdentifierdomain": "Unknown"[
          }      "CLOUD_TO_RAN"
  }       },   ],
   {         "idname": "urn:o-ran:-smo-teiv-equipment:2cloud-to-ran",
            "attributescontent": {
          "name": "Site-2",           "geo-location": {"href": "/schemas/o-ran-smo-teiv-cloud-to-ran/content"
             "latitude": 46.73297},
            "longituderevision": -76.007696"2024-05-02"
          },
  
       "cmId": {
            "cmHandledomain": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",[
               "resourceIdentifier": "UnknownCLOUD"
          }  ],
      }       }"name": "o-ran-smo-teiv-cloud",
       ],     "o-ran-smo-teiv-ran:Sectorcontent": [{
       {         "idhref": "urn:/schemas/o-ran:-smo-teiv-ran:1",
        "attributes": {cloud/content"
           "sectorId": 1},
            "azimuthrevision": 75.345,"2024-05-02"
          "geo-location": {},
            "latitude": 40.73297,{
            "longitudedomain": -74.007696[
          }      "EQUIPMENT_TO_RAN"
  }       },   ],
   {         "idname": "urn:o-ran:-smo-teiv-equipment-to-ran:2",
            "attributescontent": {
          "sectorId": 2,           "azimuthhref": 90.8967,
          "geo-location": { "/schemas/o-ran-smo-teiv-equipment-to-ran/content"
            "latitude": 41.73297},
            "longituderevision": -73.007696"2024-05-02"
        }
    }],
    "self": {
  }       }"href": "/schemas?offset=0&limit=500"
    ]},
    "o-ran-smo-teiv-cloud:CloudifiedNFfirst": [
      {
        "idhref": "urn:o-ran:smo-teiv-cloud:1",/schemas?offset=0&limit=500"
    },
    "attributesprev": {

         "namehref": "CloudifiedNF-1"
        }
 /schemas?offset=0&limit=500"
    }
    ],
    "o-ran-smo-teiv-cloud:NFDeploymentnext": [
      {
        "idhref": "urn:o-ran:smo-teiv-cloud:1",/schemas?offset=0&limit=500"
    },
    "attributeslast": {
 
        "namehref": "NFDeployment-1"
        }
 /schemas?offset=0&limit=500"
    }
 ,
  ]   },
  "relationships"totalCount": {
    "o-ran-smo-teiv-oam-to-ran:MANAGEDELEMENT_MANAGES_GNBDUFUNCTION": [
      {
        "id": "urn:o-ran:smo-teiv-oam-to-logical:1",
        "aSide": "urn:3gpp:dn:ManagedElement=NR01",
        "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1"
      }
    ],
    "o-ran-smo-teiv-ran:GNBDUFUNCTION_PROVIDES_NRSECTORCARRIER10
}


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
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/schemas?domain=.*CLOUD.*


Response:

Code Block
languagetext
titleGET CLOUD Schema Response
linenumberstrue
collapsetrue

{
    "items": [
        {
            "domain": [
      {          "id": "urn:o-ran:smo-teiv-ran:1",OAM_TO_CLOUD"
           "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1", ],
            "bSidename": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1"o-ran-smo-teiv-oam-to-cloud",
      },      "content": {
                "idhref": "urn:/schemas/o-ran:-smo-teiv-ran:2",-oam-to-cloud/content"
           "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1", },
            "bSiderevision": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2"2024-05-02"
        },

     {         "id": "urn:o-ran:smo-teiv-ran:3",{
            "aSidedomain": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1", [
                "bSideCLOUD_TO_RAN":
"urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3"       }     ],
            "name": "o-ran-smo-teiv-ran:GNBDUFUNCTION_PROVIDES_NRCELLDU-cloud-to-ran",
            "content": [{
       {         "idhref": "urn:/schemas/o-ran:-smo-teiv-cloud-to-ran:1",/content"
           "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1", },
            "bSiderevision": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=12024-05-02"
        },
        {
        "id": "urn:o-ran:smo-teiv-ran:2",   "domain": [
    "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1",         "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2  "CLOUD"
      }      ],
            "name": "o-ran-smo-teiv-ran:NRCELLDU_USES_NRSECTORCARRIER": [cloud",
            "content": {
       {         "idhref": "urn:/schemas/o-ran:-smo-teiv-ran:1",cloud/content"
           "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1", },
            "bSiderevision": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1"2024-05-02"
        }
    ],
     "self": {
        "idhref": "urn:o-ran:smo-teiv-ran:2",/schemas?offset=0&limit=500"
    },
    "aSidefirst": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",{
        "bSidehref": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2"
 /schemas?offset=0&limit=500"
    },
 
    {
        "id": "urn:o-ran:smo-teiv-ran:3","prev": {
        "aSidehref": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2",/schemas?offset=0&limit=500"
    },
    "next": {
        "bSidehref": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3"
 /schemas?offset=0&limit=500"
    },
    }"last": {
   ],     "o-ran-smo-teiv-ran:NRSECTORCARRIER_USES_ANTENNACAPABILITY": [
  href": "/schemas?offset=0&limit=500"
   { },
    "totalCount":   "id": "urn:o-ran:smo-teiv-ran:1",
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
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/schemas/o-ran-smo-teiv-oam/content


Response:

Code Block
languagetext
titleGET OAM Schema Content Response
linenumberstrue
collapsetrue
module o-ran-smo-teiv-oam {
       "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1",yang-version 1.1;
       namespace "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1"o-ran:smo-teiv-oam";
    prefix  },or-teiv-oam;

    import o-ran-smo-teiv-common-yang-types {prefix or-teiv-types; }

     "id": "urn:o-ran:smo-teiv-ran:2",
import o-ran-smo-teiv-common-yang-extensions {prefix or-teiv-yext; }

    organization "Ericsson AB"aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2",;
    contact "Ericsson first line support via "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2"
 email";
    description
    },
  "RAN O&M topology model.

  {  Copyright (c) 2023 Ericsson AB. All  "id": "urn:o-ran:smo-teiv-ran:3",rights reserved.

    This model contains the topology "aSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3",
  entities and relations in the
     "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2"
  RAN O&M domain, which are intended to represent management systems
   } and management interfaces.";

],    revision "o2024-ran-smo-teiv-equipment-to-ran:ANTENNAMODULE_SERVES_ANTENNACAPABILITY": [05-02" {
        description  {"Initial revision.";
        "id": "urn:o-ran:smoor-teiv-equipment-to-ran:1",yext:label 0.3.0;
    }

   "aSide": "urn:o-ran:smo or-teiv-equipmentyext:1",domain OAM;

      "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1"
list ManagedElement {
     },   description "A Managed Element {(ME) is a node      "id": "urn:o-ran:smo-teiv-equipment-to-ran:2",
into a telecommunication network
       "aSide": "urn:o-ran:smo-teiv-equipment:2",         "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=2"  providing support and/or service  }
to subscribers. An ME communicates
   ],     "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [       {    with a manager application  "id": "urn:o-ran:smo-teiv-equipment:1",
   (directly or indirectly) over one or more
    "aSide": "urn:o-ran:smo-teiv-equipment:1",         "bSide": "urn:o-ran:smo-teiv-equipment:1"     interfaces for },the purpose of being monitored and/or controlled.";
{
        "id": "urn:o-ran:smouses or-teiv-equipment:2",types:Top_Grp_Type;
        key id;

        container attributes "aSide": "urn:o-ran:smo-teiv-equipment:2",{
            leaf fdn "bSide": "urn:o-ran:smo-teiv-equipment:2"{
       }     ],     "o-ran-smo-teiv-equipment-to-ran:SECTOR_GROUPS_NRCELLDU": [description "This Full Distinguished Name (FDN) identifies
         {         "id": "urn:o-ran:smo-teiv-equipment-to-ran:1",         "aSide": "urn:o-ran:smo-teiv-ran:1",
    an instance of the ManagedElement MO. It contains
   "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", the full path from the Subnetwork to the
           "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2"       },       {  ManagedElement.";
      "id": "urn:o-ran:smo-teiv-equipment-to-ran:3",         "aSide": "urn:o-ran:smotype or-teiv-ran:2",types:_3GPP_FDN_Type;
          "bSide": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=3"
 }

    }     ],   container  "o-ran-smo-teiv-oam-to-cloud:NFDEPLOYMENT_SERVES_MANAGEDELEMENT": [cmId {
       {         "id": "urn:o-ran:smouses or-teiv-oam-to-cloud:1",types:CM_ID;
            }
   "aSide": "urn:o-ran:smo-teiv-cloud:1",     }
     "bSide": "urn:3gpp:dn:ManagedElement=NR01"
      }
    ],}
}

Reading entities and relationships

Sample request to fetch the entities for EQUIPMENT:

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


Response:

Code Block
languagetext
titleGET domain entity types Response
linenumberstrue
collapsetrue
{
    "o-ran-smo-teiv-oam-to-cloud:MANAGEDELEMENT_DEPLOYED_AS_CLOUDIFIEDNFitems": [
      {  {
      "id": "urn:o-ran:smo-teiv-oam-to-cloud:1",
        "aSidename": "urn:3gpp:dn:ManagedElement=NR01",
        "bSide": "urn:o-ran:smo-teiv-cloud:1"
   AntennaModule",
  }     ],     "o-ran-smo-teiv-cloud:CLOUDIFIEDNF_COMPRISES_NFDEPLOYMENTentities": [{
       {         "idhref": "urn:o-ran:smo-teiv-cloud:1",/domains/EQUIPMENT/entity-types/AntennaModule/entities"
            }
        },
        {
  "aSide": "urn:o-ran:smo-teiv-cloud:1",         "bSidename": "urn:o-ran:smo-teiv-cloud:1"
   PhysicalNF",
  }     ],     "o-ran-smo-teiv-cloud-to-ran:NFDEPLOYMENT_SERVES_GNBDUFUNCTIONentities": {
[       {         "idhref": "urn:o-ran:smo-teiv-cloud-to-ran:1",/domains/EQUIPMENT/entity-types/PhysicalNF/entities"
            }
        },
         "aSide": "urn:o-ran:smo-teiv-cloud:1",{
            "bSidename": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1"Site",
            "entities": {
 }     ]   }
}

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 modules in TEIV:

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

Response:

Code Block
languagetext
titleGET schemas Response
linenumberstrue
collapsetrue
{       "href": "/domains/EQUIPMENT/entity-types/Site/entities"
            }
        }
    ],
    "itemsself": [{
        {
  "href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },
    "domainfirst": [],{
            "namehref": "o-ran-smo-teiv-common-yang-extensions",/domains/EQUIPMENT/entity-types?offset=0&limit=500"
       },
    "contentprev": {
  
             "href": "/schemasdomains/EQUIPMENT/o-ran-smo-teiv-common-yang-extensions/contententity-types?offset=0&limit=500"
    },
       },
"next": {
           "revisionhref": "2024-05-02"
   /domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },
        {
   "last": {
        "domainhref": ["/domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },
    "totalCount": 3
     "OAM_TO_CLOUD"}

Sample request to fetch the AntennaModule entities from EQUIPMENT:

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


Response:

Code Block
languagetext
titleGET entities from domain Response
linenumberstrue
collapsetrue
{
    "items": [
       ], {
           "name": "o-ran-smo-teiv-oam-to-cloud",
            "content": {equipment:AntennaModule": [
                "href": "/schemas/o-ran-smo-teiv-oam-to-cloud/content"
     {
       },             "revisionid": "2024-05-02"
        },
        {
   urn:o-ran:smo-teiv-equipment:1"
        "domain": [],       },
     "name": "o-ran-smo-teiv-common-yang-types",          {
  "content": {                 "hrefid": "/schemas/urn:o-ran-:smo-teiv-common-yang-types/contentequipment:2"
            },    }
        "revision": "2024-05-02"    ]
      },  }
    ],
 {   "self": {
        "domainhref": ["/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
       "first": {
   "OAM"       "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    ]},
    "prev": {
        "namehref": "o-ran-smo-teiv-oam",/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
       "contentnext": {
       
        "href": "/domains/schemasEQUIPMENT/o-ran-smo-teiv-oam/content"entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "last": {
      },  "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "revision": "2024-05-02"
        },
        {
       totalCount": 2
}

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

Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1


Response:

Code Block
languagetext
titleGET entity from domain by id Response
linenumberstrue
collapsetrue
{
    "domaino-ran-smo-teiv-equipment:AntennaModule": [
        {
       "OAM_TO_RAN"             ]"decorators": {},
            "nameclassifiers": "o-ran-smo-teiv-oam-to-ran"[],
            "contentattributes": {
                "hrefmechanicalAntennaBearing": "/schemas/o-ran-smo-teiv-oam-to-ran/content" 50,
                "mechanicalAntennaTilt": }10,
                "revisionpositionWithinSector": "2024-05-02"Unknown",
          },      "fdn": "Unknown",
   {             "domaingeo-location": null,
[                "antennaModelNumber": "RAN1",
              ],  "totalTilt": 14,
                "nameantennaBeamWidth": "o-ran-smo-teiv-ran",null,
                "contentcmId": {
                    "hrefcmHandle": "/schemas/o-ran-smo-teiv-ran/content"
    9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
       },             "revisionresourceIdentifier": "2024-05-02Unknown"
         },       },
 {               "domainelectricalAntennaTilt": [ 2
            },
            "id": "EQUIPMENT"urn:o-ran:smo-teiv-equipment:1",
            "sourceIds": [],
        }
     "name": "o-ran-smo-teiv-equipment",
            "content": {
                "href": "/schemas/o-ran-smo-teiv-equipment/content"
   ]
}

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

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


Response:

Code Block
languagetext
titleGET ____ Response
linenumberstrue
collapsetrue
Sample request to fetch all relationship types in EQUIPMENT:
 Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types

Response:
 Code Block
languagetext
titleGET all domain relationship types Response
linenumberstrue
collapsetrue
{
    "items": [
        },{
            "revisionname": "2024-05-02"ANTENNAMODULE_INSTALLED_AT_SITE",
        },    "relationships": {
   {             "domainhref": [
                "CLOUD_TO_RAN"/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships"
            ],
            "name": "o-ran-smo-teiv-cloud-to-ran",}
        },
   "content": {    {
            "hrefname": "/schemas/o-ran-smo-teiv-cloud-to-ran/content"PHYSICALNF_INSTALLED_AT_SITE",
            "relationships": {
   },             "revisionhref": "2024-05-02"/domains/EQUIPMENT/relationship-types/PHYSICALNF_INSTALLED_AT_SITE/relationships"
         },   }
     {   }
    ],
    "domainself": [{
                "CLOUD"
    "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
  ],  "first":  {
        "namehref": "o-ran-smo-teiv-cloud",/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
       "contentprev": {
       
        "href": "/domains/schemasEQUIPMENT/o-ran-smo-teiv-cloud/contentrelationship-types?offset=0&limit=500"
    },
    "next": {
 },       "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
   "revision": "2024-05-02last": {
       }, "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
 {   "totalCount": 2
   }
Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationships from EQUIPMENT:
 Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships

Response:
 Code Block
languagetext
titleGET specific relationships from domain Response
linenumberstrue
collapsetrue
{
    "domainitems": [
                "EQUIPMENT_TO_RAN"
            ],{
            "name": "o-ran-smo-teiv-equipment-to-ran",:ANTENNAMODULE_INSTALLED_AT_SITE": [
               "content": {
                    "hrefbSide": "/schemas/urn:o-ran-:smo-teiv-equipment-to-ran/content":1",
            },             "revisionaSide": "2024-05-02"
        }urn:o-ran:smo-teiv-equipment:1",
     ],     "self": {         "hrefid": "/schemas?offset=0&limit=500"urn:o-ran:smo-teiv-equipment:1"
      },     "first": {    },
    "href": "/schemas?offset=0&limit=500"     },     "prev": {
         "href": "/schemas?offset=0&limit=500"     },     "nextbSide": {"urn:o-ran:smo-teiv-equipment:2",
        "href": "/schemas?offset=0&limit=500"       },     "aSide"last": {: "urn:o-ran:smo-teiv-equipment:2",
         "href": "/schemas?offset=0&limit=500"     },     "totalCountid": 10
}
Sample request to fetch a list of all modules related to the CLOUD domain:
 Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/schemas?domain=.*CLOUD.*
Response:
 Code Block
languagetext
titleGET CLOUD Schema Response
linenumberstrue
collapsetrue
{"urn:o-ran:smo-teiv-equipment:2"
       "items": [        }
{            ]
"domain": [       }
    ],
    "CLOUDself": {
        "href":   ]"/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "first": {
        "namehref": "o-ran-smo-teiv-cloud",
   /domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "prev": {
        "contenthref": { "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "next": {
        "href": "/domains/schemasEQUIPMENT/o-ran-smo-teiv-cloud/contentrelationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "last": {
 },             "revision": "2024-05-02"
   "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    ],
    "self": {
   "totalCount": 2
}
Sample request to fetch ANTENNAMODULE_INSTALLED_AT_SITE relationship from EQUIPMENT by id:
 Code Block
languagexml
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
languagetext
titleGET ____ Response
linenumberstrue
collapsetrue
{
    "hrefo-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": "/schemas?offset=0&limit=500"
[
   },     "first": {
        "href": "/schemas?offset=0&limit=500"
    },
    "prevbSide": {
        "href": "/schemas?offset=0&limit=500""urn:o-ran:smo-teiv-equipment:1",
       },     "aSide"next": {: "urn:o-ran:smo-teiv-equipment:1",
            "hrefid": "/schemas?offset=0&limit=500"urn:o-ran:smo-teiv-equipment:1",
      },      "lastsourceIds": {[]
        "href": "/schemas?offset=0&limit=500"}
    ]
},
    "totalCount": 1
}
Sample request to fetch the module data for the o-ran-smo-teiv-ran module:
Reading and querying topology and inventory
Reading entities and relationships
...
Sample request to heading 3 0:
 Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types

Response:
 Code Block
languagetext
titleGET ____ Response
linenumberstrue
collapsetrue



Sample request to heading 3 0:
 Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types

Response:
 Code Block
languagetext
titleGET ____ Response
linenumberstrue
collapsetrue