Versions Compared

Old Version 9

changes.mady.by.user Jeff van Dam

Saved on

compared with

New Version 10

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

...

Postman collection

Collection: Query TEIV.postman_collection.json

Environment: TEIV.postman_environment.json

Retrieving and using topology modules

...

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.*

...

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

...

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
{
    "items": [
        {
            "name": "AntennaModule",
            "entities": {
                "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities"
            }
        },
        {
            "name": "PhysicalNF",
            "entities": {
                "href": "/domains/EQUIPMENT/entity-types/PhysicalNF/entities"
            }
        },
        {
            "name": "Site",
            "entities": {
                "href": "/domains/EQUIPMENT/entity-types/Site/entities"
            }
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },
    "first": {
        "href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },
    "next": {
        "href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },
    "last": {
        "href": "/domains/EQUIPMENT/entity-types?offset=0&limit=500"
    },
    "totalCount": 3
}

...

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

Response:

Code Block
languagetext
titleGET entities from domain Response
linenumberstrue
collapsetrue
{
    "items": [
        {
            "o-ran-smo-teiv-equipment:AntennaModule": [
                {
                    "id": "urn:o-ran:smo-teiv-equipment:1"
                },
                {
                    "id": "urn:o-ran:smo-teiv-equipment:2"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "first": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "next": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "last": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities?offset=0&limit=500"
    },
    "totalCount": 2
}

...

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
{
    "o-ran-smo-teiv-equipment:AntennaModule": [
        {
            "decorators": {},
            "classifiers": [],
            "attributes": {
                "mechanicalAntennaBearing": 50,
                "mechanicalAntennaTilt": 10,
                "positionWithinSector": "Unknown",
                "fdn": "Unknown",
                "geo-location": null,
                "antennaModelNumber": "1",
                "totalTilt": 14,
                "antennaBeamWidth": null,
                "cmId": {
                    "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
                    "resourceIdentifier": "Unknown"
                },
                "electricalAntennaTilt": 2
            },
            "id": "urn:o-ran:smo-teiv-equipment:1",
            "sourceIds": []
        }
    ]
}

...

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

Response:

Code Block
languagetext
titleGET entity relationships from domain by id Response
linenumberstrue
collapsetrue
{
    "items": [
        {
            "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
                {
                    "bSide": "urn:o-ran:smo-teiv-equipment:1",
                    "aSide": "urn:o-ran:smo-teiv-equipment:1",
                    "id": "urn:o-ran:smo-teiv-equipment:1"
                }
            ]
        },
        {
            "o-ran-smo-teiv-equipment-to-ran:ANTENNAMODULE_SERVES_ANTENNACAPABILITY": [
                {
                    "bSide": "urn:3gpp:dn:ManagedElement=NR01,NodeSupport=1,SectorEquipmentFunction=1",
                    "aSide": "urn:o-ran:smo-teiv-equipment:1",
                    "id": "urn:o-ran:smo-teiv-equipment-to-ran:1"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500"
    },
    "first": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500"
    },
    "next": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500"
    },
    "last": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:o-ran:smo-teiv-equipment:1/relationships?offset=0&limit=500"
    },
    "totalCount": 2
}

...

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": [
        {
            "name": "ANTENNAMODULE_INSTALLED_AT_SITE",
            "relationships": {
                "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships"
            }
        },
        {
            "name": "PHYSICALNF_INSTALLED_AT_SITE",
            "relationships": {
                "href": "/domains/EQUIPMENT/relationship-types/PHYSICALNF_INSTALLED_AT_SITE/relationships"
            }
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "first": {
        "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "next": {
        "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "last": {
        "href": "/domains/EQUIPMENT/relationship-types?offset=0&limit=500"
    },
    "totalCount": 2
}

...

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
{
    "items": [
        {
            "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
                {
                    "bSide": "urn:o-ran:smo-teiv-equipment:1",
                    "aSide": "urn:o-ran:smo-teiv-equipment:1",
                    "id": "urn:o-ran:smo-teiv-equipment:1"
                },
                {
                    "bSide": "urn:o-ran:smo-teiv-equipment:2",
                    "aSide": "urn:o-ran:smo-teiv-equipment:2",
                    "id": "urn:o-ran:smo-teiv-equipment:2"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "first": {
        "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "next": {
        "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "last": {
        "href": "/domains/EQUIPMENT/relationship-types/ANTENNAMODULE_INSTALLED_AT_SITE/relationships?offset=0&limit=500"
    },
    "totalCount": 2
}

...

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 a specific relationship from domain by id Response
linenumberstrue
collapsetrue
{
    "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
        {
            "bSide": "urn:o-ran:smo-teiv-equipment:1",
            "aSide": "urn:o-ran:smo-teiv-equipment:1",
            "id": "urn:o-ran:smo-teiv-equipment:1",
            "sourceIds": []
        }
    ]
}

...

Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entities?targetFilter=/AntennaModule/attributes
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities?targetFilter=/attributes

Response:

Code Block
languagetext
titleGET domain entities and attributes Response
linenumberstrue
collapsetrue
{
    "items": [
        {
            "o-ran-smo-teiv-equipment:AntennaModule": [
                {
                    "attributes": {
                        "mechanicalAntennaBearing": 45,
                        "mechanicalAntennaTilt": 12,
                        "positionWithinSector": "Unknown",
                        "fdn": "Unknown",
                        "geo-location": null,
                        "antennaModelNumber": "2",
                        "totalTilt": 15,
                        "antennaBeamWidth": null,
                        "cmId": {
                            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
                            "resourceIdentifier": "Unknown"
                        },
                        "electricalAntennaTilt": 1
                    },
                    "id": "urn:o-ran:smo-teiv-equipment:2"
                },
                {
                    "attributes": {
                        "mechanicalAntennaBearing": 50,
                        "mechanicalAntennaTilt": 10,
                        "positionWithinSector": "Unknown",
                        "fdn": "Unknown",
                        "geo-location": null,
                        "antennaModelNumber": "1",
                        "totalTilt": 14,
                        "antennaBeamWidth": null,
                        "cmId": {
                            "cmHandle": "9D2C7AA8AECF0B5FDE21FDBD2B93EEAG",
                            "resourceIdentifier": "Unknown"
                        },
                        "electricalAntennaTilt": 2
                    },
                    "id": "urn:o-ran:smo-teiv-equipment:1"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "first": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "next": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "last": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "totalCount": 2
}

...

Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/CLOUD/entities?targetFilter=/CloudifiedNF/attributes(name)
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/CLOUD/entities?targetFilter=/CloudifiedNF/attributes/name
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/CLOUD/entity-types/CloudifiedNF/entities?targetFilter=/attributes(name)

Response:

Code Block
languagetext
titleGET get domain entities and specific attributes Response
linenumberstrue
collapsetrue
{
    "items": [
        {
            "o-ran-smo-teiv-cloud:CloudifiedNF": [
                {
                    "attributes": {
                        "name": "CloudifiedNF-1"
                    },
                    "id": "urn:o-ran:smo-teiv-cloud:1"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/CLOUD/entities?offset=0&limit=500&targetFilter=/CloudifiedNF/attributes(name)"
    },
    "first": {
        "href": "/domains/CLOUD/entities?offset=0&limit=500&targetFilter=/CloudifiedNF/attributes(name)"
    },
    "prev": {
        "href": "/domains/CLOUD/entities?offset=0&limit=500&targetFilter=/CloudifiedNF/attributes(name)"
    },
    "next": {
        "href": "/domains/CLOUD/entities?offset=0&limit=500&targetFilter=/CloudifiedNF/attributes(name)"
    },
    "last": {
        "href": "/domains/CLOUD/entities?offset=0&limit=500&targetFilter=/CloudifiedNF/attributes(name)"
    },
    "totalCount": 1
}

...

Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entities?targetFilter=/GNBDUFunction/attributes(gNBId, gNBIdLength)
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entity-types/GNBDUFunction/entities?targetFilter=/attributes(gNBId, gNBIdLength)

Response:

Code Block
languagetext
titleGET domain entities and multiple attributes Response
linenumberstrue
collapsetrue
{
    "items": [
        {
            "o-ran-smo-teiv-ran:GNBDUFunction": [
                {
                    "attributes": {
                        "gNBId": 1,
                        "gNBIdLength": 23
                    },
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/RAN/entity-types/GNBDUFunction/entities?offset=0&limit=500&targetFilter=/attributes(gNBId, gNBIdLength)"
    },
    "first": {
        "href": "/domains/RAN/entity-types/GNBDUFunction/entities?offset=0&limit=500&targetFilter=/attributes(gNBId, gNBIdLength)"
    },
    "prev": {
        "href": "/domains/RAN/entity-types/GNBDUFunction/entities?offset=0&limit=500&targetFilter=/attributes(gNBId, gNBIdLength)"
    },
    "next": {
        "href": "/domains/RAN/entity-types/GNBDUFunction/entities?offset=0&limit=500&targetFilter=/attributes(gNBId, gNBIdLength)"
    },
    "last": {
        "href": "/domains/RAN/entity-types/GNBDUFunction/entities?offset=0&limit=500&targetFilter=/attributes(gNBId, gNBIdLength)"
    },
    "totalCount": 1
}

...

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

Response:

Code Block
languagetext
titleGET multiple different domain entities Response
linenumberstrue
collapsetrue
{
    "items": [
        {
            "o-ran-smo-teiv-ran:NRSectorCarrier": [
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=1"
                },
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=2"
                },
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRSectorCarrier=3"
                }
            ],
            "o-ran-smo-teiv-ran:GNBDUFunction": [
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1"
                }
            ],
            "o-ran-smo-teiv-ran:NRCellDU": [
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=1"
                },
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=2"
                },
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1,NRCellDU=3"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/GNBDUFunction;/NRSectorCarrier;/NRCellDU"
    },
    "first": {
        "href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/GNBDUFunction;/NRSectorCarrier;/NRCellDU"
    },
    "prev": {
        "href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/GNBDUFunction;/NRSectorCarrier;/NRCellDU"
    },
    "next": {
        "href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/GNBDUFunction;/NRSectorCarrier;/NRCellDU"
    },
    "last": {
        "href": "/domains/RAN/entities?offset=0&limit=500&targetFilter=/GNBDUFunction;/NRSectorCarrier;/NRCellDU"
    },
    "totalCount": 7
}

...

Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entities?targetFilter=/GNBDUFunction&scopeFilter=%2FGNBDUFunction%2Fattributes%5B%40gNBIdLength=23 and %40gNBId=1%5D
or
GET https://<host>/topology-inventory/<API_VERSION>/domains/RAN/entity-types/GNBDUFunction/entities?scopeFilter=%2FGNBDUFunction%2Fattributes%5B%40gNBIdLength=23 and %40gNBId=1%5D

Response:

Code Block
languagetext
titleGET domain entities filtered by specific attributes Response
linenumberstrue
collapsetrue
{
    "items": [
        {
            "o-ran-smo-teiv-ran:GNBDUFunction": [
                {
                    "id": "urn:3gpp:dn:ManagedElement=NR01,GNBDUFunction=1"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/GNBDUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/GNBDUFunction"
    },
    "first": {
        "href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/GNBDUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/GNBDUFunction"
    },
    "prev": {
        "href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/GNBDUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/GNBDUFunction"
    },
    "next": {
        "href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/GNBDUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/GNBDUFunction"
    },
    "last": {
        "href": "/domains/RAN/entities?offset=0&limit=500&scopeFilter=/GNBDUFunction/attributes[@gNBIdLength=23 and @gNBId=1]&targetFilter=/GNBDUFunction"
    },
    "totalCount": 1
}

...