Versions Compared

Old Version 13

changes.mady.by.user Jeff van Dam

Saved on

compared with

New Version Current

changes.mady.by.user Jeff van Dam

Saved on

Key

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


Table of Contents

...

Environment: TEIV.postman_environment.json

Schema for "Create classifiers and decorators schema": classifiers-and-decorators-module.yang

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

...

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

Response:

Code Block
languagetext
titleGET entity from domain by id Response
linenumberstrue
collapsetrue
{
    "o-ran-smo-teiv-equipment:AntennaModule": [
        {
            "decorators": {},
            "classifiers": [],
            "attributes": {
                "mechanicalAntennaTilt": 10,
                "mechanicalAntennaBearing": 50,
                "positionWithinSector": "Unknown",
                "geo-location": {
                    "height": 3000,
                    "latitude": 41.73297,
                    "longitude": -73.007696
                },
                "antennaModelNumber": "1",
                "totalTilt": 14,
                "antennaBeamWidth": [
                    35,
                    23,
                    21
                ],
                "electricalAntennaTilt": 2
            },
            "id": "urn:oran:smo:teiv:AntennaModule=1",
            "sourceIds": [
                "urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaUnit=1",
                "urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaUnit=1,AntennaSubunit=1",
                "urn:3gpp:dn:ManagedElement=NR01,Equipment=1,AntennaUnitGroup=1,AntennaNearUnit=1,RetSubUnit=1"
            ]
        }
    ]
}

...

Code Block
languagexml
GET https://<host>/topology-inventory/<API_VERSION>/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=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:oran:smo:teiv:Site=1",
                    "aSide": "urn:oran:smo:teiv:AntennaModule=1",
                    "id": "urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
    },
    "first": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
    },
    "next": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
    },
    "last": {
        "href": "/domains/EQUIPMENT/entity-types/AntennaModule/entities/urn:oran:smo:teiv:AntennaModule=1/relationships?offset=0&limit=500"
    },
    "totalCount": 1
}

...

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

...

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

...

Code Block
languagexml
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
languagetext
titleGET a specific relationship from domain by id Response
linenumberstrue
collapsetrue
{
    "o-ran-smo-teiv-equipment:ANTENNAMODULE_INSTALLED_AT_SITE": [
        {
            "decorators": {},
            "bSide": "urn:oran:smo:teiv:Site=1",
            "aSide": "urn:oran:smo:teiv:AntennaModule=1",
            "classifiers": [],
            "id": "urn:oran:smo:teiv:ANTENNAMODULE_INSTALLED_AT_SITE=1",
            "sourceIds": []
        }
    ]
}

...

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": {
                        "mechanicalAntennaTilt": 10,
                        "mechanicalAntennaBearing": 50,
                        "positionWithinSector": "Unknown",
                        "geo-location": {
                            "height": 3000,
                            "latitude": 41.73297,
                            "longitude": -73.007696
                        },
                        "antennaModelNumber": "1",
                        "totalTilt": 14,
                        "antennaBeamWidth": [
                            35,
                            23,
                            21
                        ],
                        "electricalAntennaTilt": 2
                    },
                    "id": "urn:oran:smo:teiv:AntennaModule=1"
                }
            ]
        },
        {
            "o-ran-smo-teiv-equipment:AntennaModule": [
                {
                    "attributes": {
                        "mechanicalAntennaTilt": 12,
                        "mechanicalAntennaBearing": 45,
                        "positionWithinSector": "Unknown",
                        "geo-location": {
                            "height": 2500,
                            "latitude": 43.75443,
                            "longitude": -71.096454
                        },
                        "antennaModelNumber": "2",
                        "totalTilt": 15,
                        "antennaBeamWidth": [
                            45,
                            32,
                            21
                        ],
                        "electricalAntennaTilt": 1
                    },
                    "id": "urn:oran:smo:teiv:AntennaModule=2"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "first": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "prev": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "next": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "last": {
        "href": "/domains/EQUIPMENT/entities?offset=0&limit=500&targetFilter=/AntennaModule/attributes"
    },
    "totalCount": 2
}

...

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/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:oran:smo:teiv:CloudifiedNF:1"
                }
            ]
        }
    ],
    "self": {
        "href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
    },
    "first": {
        "href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
    },
    "prev": {
        "href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
    },
    "next": {
        "href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
    },
    "last": {
        "href": "/domains/CLOUD/entity-types/CloudifiedNF/entities?offset=0&limit=500&targetFilter=/attributes(name)"
    },
    "totalCount": 1
}

...

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

Response:

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

...

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

Response:

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

...

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

...