Topology Exposure and Inventory API

Topology Exposure and Inventory data is the information that represents entities in a telecommunications network and the relationships between them that provide insight into a particular aspect of the network of importance to specific use cases. Topology and Inventory data can be derived from inventory, configuration, or other data.

Topology Exposure and Inventory supports several topology domains. A domain is a grouping of topology and inventory entities that handles topology and inventory data.

Entities are enabling the modelling and storage of complex network infrastructure and relationships.

A relationship is a bi-directional connection between two entities, one of which is the originating side (A-side) and the other is the terminating side (B-side). The order of the sides matters since it defines the relationship itself which must be unique.

Classifier (also known as tag or label) permits the association of a well defined user specified string with an entity or relationship.

Decorators are user-defined attributes (key-value pairs) which can be applied to topology entities and relationships.

Topology Exposure and Inventory API provides the capabilities to fetch topology data. Using the filtering options, it is possible to define more specific query requests.

Querying simple entities

The entityTypeName is used as the root of the queries (from here referred to as RootObject). Every other object, either in targetFilter or scopeFilter, has to relate to the RootObject. The queries are constructed starting from the RootObject and all other objects are joined to it. If there is no connection between the RootObject and the other object(s), the query is not constructed. The RootObject still can be retrieved and filtered using the /attributes.

| Use case | domainName | entityTypeName | targetFilter | scopeFilter | Query result | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|:---------------|:--------------------------------|:----------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------| | To return the ids for all instances of the entityTypeName used in the query. | RAN | GNBDUFunction | | | All ids of every GNBDUFunction | | To return all attributes of every instance of the entityTypeName used in the query. | RAN | GNBDUFunction | /attributes | | All GNBDUFunctions with every attribute | | To return every instance of the entityTypeName used in the query, but only the attribute that was defined in the targetFilter parameter.
Note: The attribute must be a valid field of the object. | RAN | GNBDUFunction | /attributes(gNBId) | | All gNBIds of every GNBDUFunction | | To return every instance of the entityTypeName used in the query, but only the attributes that were defined in the targetFilter parameter.
Note: The attributes must be separated by a comma "," when using parenthesis "()". | RAN | GNBDUFunction | /attributes(gNBId, gNBIdLength) | | All gNBIds and gNBIdLengths of every GNBDUFunction | | To return the ids for all instances of the entityTypeName used in the query, that matches the given property in the scopeFilter parameter. | RAN | GNBDUFunction | | /sourceIds[contains (@item, 'SubNetwork=Ireland')] | Unique set of ids of GNBDUFunctions, where sourceIds contains SubNetwork=Ireland | | To return the ids for all instances of the entityTypeName used in the query, that matches the given attributes in the scopeFilter parameter.
Note: The attributes must be separated by a AND or OR". | RAN | GNBDUFunction | | /attributes [@gNBIdLength=3 and @gNBId=111] | Unique set of ids of GNBDUFunctions, where the gNBIdLength equals 3 and the gNBId equals 111 | | To return the ids for all instances of the entityTypeName used in the query, that satisfies one of the conditions in the scopeFilter parameter. A condition is a complete unit of scopeFilter parameter surrounded by square brackets.
Note: Multiple conditions can be given in the scopeFilter separated by a semicolon ";" to represent AND, or a pipe symbol "|" to represent OR. | RAN | GNBDUFunction | | /attributes [@gNBIdLength=3] | /sourceIds[contains (@item, 'SubNetwork=Ireland')] | Unique set of ids of GNBDUFunctions, where the gNBIdLength equals 3 or the sourceIds contains an item with "SubNetwork=Ireland" |

Querying connected entities

The entityTypeName is used as the root of the queries.

| Use case | domainName | entityTypeName | targetFilter | scopeFilter | Query result | |:-----------------------------------------------------------------------------------------------------------------------------------------------|-------------|:---------------|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | To return the ids for all instances of an entityTypeName related by an association. | REL_OAM_RAN | ENodeBFunction | | /managed-by-managedElement | All ENodeBFunction entities that are managed by any Managed Element. | | To return the ids for all instances of an entityTypeName related by an association to another entity specified by its id. | REL_OAM_RAN | ENodeBFunction | | /managed-by-managedElement [@id = 'urn:3gpp:dn: ManagedElement=1'] | All ENodeBFunction entities that are managed by by the Managed Element urn:3gpp:dn: ManagedElement=1. | | To return the attributes for all instances of an entityTypeName related by one or more associations to other entities specified by their id. | REL_OAM_RAN | ENodeBFunction | /attributes | /attributes [@enbId=1] ; /managed-by-managedElement [@id='urn:3gpp:dn: ManagedElement=1'] | /managed-by-managedElement [@id='urn:3gpp:dn: ManagedElement=2'] ; /provided-euTranCell [@id='urn:3gpp:dn: ManagedElement=1, EUtranCell=2'] | All EnodeBFunction entities with enbId as 1, managed by the Managed Element urn:3gpp:dn: ManagedElement=1 or urn:3gpp:dn: ManagedElement=2, and provides EuTranCell urn:3gpp:dn: ManagedElement=1, EUtranCell=2. |

Querying entities for relationships

The entityTypeName is used as the root of the queries.

| Use case | domainName | entityTypeName | entityId | targetFilter | scopeFilter | Query result | |:-------------------------------------------------------------------------------------------------------------------|-------------|:---------------|------------------------------------------------|:----------------------------------------|:-------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | To return the relationships for a given entity specified by its id. | RAN | GNBDUFunction | urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1 | | | All relations for the GNBDUFunction with id urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1. | | To return specific relationships for a given entity specified by its id. | REL_OAM_RAN | GNBDUFunction | urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1 | /MANAGEDELEMENT _MANAGES _GNBDUFUNCTION | | All MANAGEDELEMENT _MANAGES _GNBDUFUNCTION relations for the GNBDUFunction with id urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1. | | To return specific relationships for an entity specified by its id to another entity using its id and association. | REL_OAM_RAN | GNBDUFunction | urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1 | | /managed-by-managedElement [@id = 'urn:3gpp:dn: ManagedElement=1'] | All MANAGEDELEMENT _MANAGES _GNBDUFUNCTION relations for the GNBDUFunction with id urn:3gpp:dn: ManagedElement=1, GNBDUFunction=1 where the managed element is urn:3gpp:dn: ManagedElement=1. |

Querying on relationships

Here, the relationshipTypeName is used as the root of the queries.

| Use case | domainName | relationshipTypeName | targetFilter | scopeFilter | Query result | |:---------------------------------------------------------------------------------------------------------|-------------|:----------------------------------------|:-------------|:-----------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------| | To return all relationships for a specified relationship type. | REL_OAM_RAN | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | | | All MANAGEDELEMENT_MANAGES_ENODEBFUNCTION relationships. | | To return all relationships for a specified relationship type with a specified association to an entity. | REL_OAM_RAN | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | | /managed-by-managedElement [@id='urn:3gpp:dn: ManagedElement=1'] | All MANAGEDELEMENT_MANAGES_ENODEBFUNCTION relationships having an association managed-by-managedElement to ManagedElement urn:3gpp:dn: ManagedElement=1. |

Querying on classifiers and decorators

The domainName is used as the root of the queries.

| Use case | domainName | targetFilter | scopeFilter | Query result | |:--------------------------------------------------------------------------------------------------------------------------------------------------|------------|--------------|:----------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------| | Return all related entity IDs that are exactly matched with the specified classifier with given domain name. | RAN | | /classifiers[@item = 'gnbdu-function-model:Indoor'] | All the entity IDs that are classified with "gnbdu-function-model:Indoor" in RAN domain. | | Return all related entity IDs that are partially matched for the given classifier with given domain name. | RAN | | /classifiers[contains(@item, 'Ind')] | All the entity IDs that are partially matched with "Ind" in RAN domain. | | Return all related entity IDs that are exactly matched with the key-value pair that specified decorators with given domain name. | RAN | | /decorators[@gnbdu-function-model:textdata = 'Stockholm'] | All the entity IDs that are exactly matched with "gnbdu-function-model:textdata = 'Stockholm'" in RAN domain. | | Return all related entity IDs that are exactly matched with key parameter where the value of the decorator is unknown with given domain name. | RAN | | /decorators[contains(@gnbdu-function-model:textdata, "")] | All the entity IDs that are exactly matched with "gnbdu-function-model:textdata as key of the decorator in RAN domain. |

The entityName is used as the root of the queries.

| Use case | entityName | relationshipTypeName | targetFilter | scopeFilter | Query result | |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|:---------------------|:--------------------------|:----------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Return all related entity IDs and classifiers. | NRCellDU | | /classifiers | | All NRCellDU IDs and classifiers. | | Return all related entity IDs and decorators. | NRCellDU | | /decorators | | All NRCellDU IDs and decorators. | | Return all related entity IDs that are exact match for the given classifiers and decorators. | NRCellDU | | | /classifiers[@item = 'gnbdu-function-model:Indoor']; /decorators [@gnbdu-function-model:textdata = 'Stockholm'] | All NRCellDU IDs where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator is 'Stockholm'" and where classifier exactly contains "gnbdu-function-model:Indoor". | | Return all related entity IDs and classifiers that are partially matched for the given classifier. | NRCellDU | | /classifiers | /classifiers[contains(@item, 'Ind')] | All NRCellDU IDs and classifiers partially contains the text "Ind". | | Return all related entity IDs and decorators where key is a exact match and value is partially match. | NRCellDU | | /decorators | /decorators[contains(@gnbdu-function-model:textdata, 'Stoc')] | All NRCellDU IDs and where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator partially contains 'Stoc'. | | Return all related entity IDs, decorators and classifiers where key of the decorator is a exact match and value partially matches, and classifiers partially contains from the given parameters. | NRCellDU | | /classifiers; /decorators | /classifiers[contains(@item, 'Ind')]; /decorators[contains(@gnbdu-function-model:textdata, 'Stoc')] | All NRCellDU IDs and decorators where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator partially contains 'Stoc' and classifiers partially contains the text "Ind". |

The relationshipTypeName is used as the root of the queries.

| Use case | entityName | relationshipTypeName | targetFilter | scopeFilter | Query result | |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|:----------------------------------------|:--------------------------|:----------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Return all related relationships IDs and classifiers. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /classifiers | | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION IDs and classifiers. | | Return all related relationships IDs and decorators. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /decorators | | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION IDs and decorators. | | Return all related relationship IDs that are exact match for the given classifier and decorators. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | | /classifiers[@item = 'gnbdu-function-model:Indoor']; /decorators [@gnbdu-function-model:textdata = 'Stockholm'] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION IDs and decorators where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator is 'Stockholm'" and classifiers exactly contains "gnbdu-function-model:Indoor". | | Return all related relationships IDs and classifiers that are partially matched for the given classifier. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /classifiers | /classifiers[contains(@item, 'Ind')] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION and classifiers partially contains the text "Ind". | | Return all related relationships IDs and decorators where key is a exact match and value is partially match. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /decorators | /decorators[contains(@gnbdu-function-model:textdata, 'Stock')] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION and where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator partially contains 'Stock'. | | Return all related relationships IDs,decorators and classifiers where key of the decorator is a exact match and value partially matches, and classifiers partially contains from the given parameters. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /classifiers; /decorators | /classifiers[contains(@item, 'Ind')]; /decorators[contains(@gnbdu-function-model:textdata, 'Stock')] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION IDs and decorators where key of the decorator is "gnbdu-function-model:textdata" and the value of the decorator partially contains 'Stock' and classifiers partially contains the text "Ind". |

More information: https://openapi-generator.tech
Contact Info: team@openapitools.org
Version: 0.11.0
BasePath:/topology-inventory/v1alpha11
Copyright (C) 2024 Ericsson, Modifications Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
http://www.apache.org/licenses/LICENSE-2.0

Access

Methods

[ Jump to Models ]

Table of Contents

Classifiers

Decorators

EntitiesAndRelationships

Schemas

TopologyGroups

Classifiers

Up 
post /classifiers
Update entities and/or relationships with classifier(s). (updateClassifier)
Update entities and/or relationships with classifier(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Classifier Classifier (required)
Body Parameter —

Request headers

Accept (required)
Header Parameter — default: application/json
Content-Type (required)
Header Parameter — default: application/json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

409

Conflict ErrorMessage

500

Internal Server Error ErrorMessage

Decorators

Up 
post /decorators
Update entities and/or relationships with decorator(s). (updateDecorator)
Update entities and/or relationships with decorator(s). The sum of the given entityIds and relationshipIds cannot exceed 100 by default.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Decorator Decorator (required)
Body Parameter —

Request headers

Accept (required)
Header Parameter — default: application/json
Content-Type (required)
Header Parameter — default: application/json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

409

Conflict ErrorMessage

500

Internal Server Error ErrorMessage

EntitiesAndRelationships

Up 
get /domains
Get all the available topology domains. (getAllDomains)
Get all the available topology domains.

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

Domains

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ {
    "name" : "name",
    "entityTypes" : {
      "href" : "href"
    },
    "relationshipTypes" : {
      "href" : "href"
    }
  }, {
    "name" : "name",
    "entityTypes" : {
      "href" : "href"
    },
    "relationshipTypes" : {
      "href" : "href"
    }
  } ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Domains

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships
Get all relationships for entity type name with specified id. Specified id represents the entity instance. (getAllRelationshipsForEntityId)
Get all relationships for entity type name with specified id. Specified id represents the entity instance.

Path parameters

domainName (required)
Path Parameter — domain name default: null
entityTypeName (required)
Path Parameter — default: null
entityId (required)
Path Parameter — default: null

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

targetFilter (optional)
Query Parameter — Use targetFilter to specify the entity type and attributes to be returned in the REST response. The value for targetFilter can also be a list of entity types and attributes. default: null
scopeFilter (optional)
Query Parameter — Use scopeFilter to specify the attributes to match on. The value for scopeFilter can also be a list of entity types and attributes. scopeFilter returns a boolean. default: null
offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

RelationshipsResponseMessage

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ "{}", "{}" ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RelationshipsResponseMessage

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

404

Not Found ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /domains/{domainName}/entities
Get entities by domain (getEntitiesByDomain)
Get topology entities by domain, using specified targetFilter as mandatory query parameter.

Path parameters

domainName (required)
Path Parameter — domain name default: null

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

targetFilter (optional)
Query Parameter — Use targetFilter to specify the entity type and attributes to be returned in the REST response. The value for targetFilter can also be a list of entity types and attributes. default: null
scopeFilter (optional)
Query Parameter — Use scopeFilter to specify the attributes to match on. The value for scopeFilter can also be a list of entity types and attributes. scopeFilter returns a boolean. default: null
offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

EntitiesResponseMessage

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ "{}", "{}" ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK EntitiesResponseMessage

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}
Get relationship with specified id. Specified id represents the relationship instance. (getRelationshipById)
Get relationship with specified id. Specified id represents the relationship instance.

Path parameters

domainName (required)
Path Parameter — domain name default: null
relationshipTypeName (required)
Path Parameter — default: null
relationshipId (required)
Path Parameter — default: null

Request headers

Accept (required)
Header Parameter — default: application/yang.data+json

Return type

Object

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

404

Not Found ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships
Get topology relationships of a specific relationship type name. (getRelationshipsByType)
Get topology relationships of a specific relationship type name.

Path parameters

domainName (required)
Path Parameter — domain name default: null
relationshipTypeName (required)
Path Parameter — default: null

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

targetFilter (optional)
Query Parameter — Use targetFilter to specify the entity type and attributes to be returned in the REST response. The value for targetFilter can also be a list of entity types and attributes. default: null
scopeFilter (optional)
Query Parameter — Use scopeFilter to specify the attributes to match on. The value for scopeFilter can also be a list of entity types and attributes. scopeFilter returns a boolean. default: null
offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

RelationshipsResponseMessage

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ "{}", "{}" ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RelationshipsResponseMessage

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /domains/{domainName}/entity-types/{entityTypeName}/entities
Get all topology entities of a specific entity type. (getTopologyByEntityTypeName)
Get all topology entities of a specific entity type.

Path parameters

domainName (required)
Path Parameter — domain name default: null
entityTypeName (required)
Path Parameter — default: null

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

targetFilter (optional)
Query Parameter — Use targetFilter to specify the entity type and attributes to be returned in the REST response. The value for targetFilter can also be a list of entity types and attributes. default: null
scopeFilter (optional)
Query Parameter — Use scopeFilter to specify the attributes to match on. The value for scopeFilter can also be a list of entity types and attributes. scopeFilter returns a boolean. default: null
offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

EntitiesResponseMessage

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ "{}", "{}" ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK EntitiesResponseMessage

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}
Get topology for entity type name with specified id. Specified id represents the entity instance. (getTopologyById)
Get topology for entity type name with specified id. Specified id represents the entity instance.

Path parameters

domainName (required)
Path Parameter — domain name default: null
entityTypeName (required)
Path Parameter — default: null
entityId (required)
Path Parameter — default: null

Request headers

Accept (required)
Header Parameter — default: application/yang.data+json

Return type

Object

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

404

Not Found ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /domains/{domainName}/entity-types
Get all the available topology entity types in domain name. (getTopologyEntityTypes)
Get all the available topology entity types in domain name.

Path parameters

domainName (required)
Path Parameter — domain name default: null

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

EntityTypes

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ {
    "entities" : {
      "href" : "href"
    },
    "name" : "name"
  }, {
    "entities" : {
      "href" : "href"
    },
    "name" : "name"
  } ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK EntityTypes

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /domains/{domainName}/relationship-types
Get all the available topology relationship types. (getTopologyRelationshipTypes)
Get all the available topology relationship types.

Path parameters

domainName (required)
Path Parameter — domain name default: null

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

RelationshipTypes

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ {
    "relationships" : {
      "href" : "href"
    },
    "name" : "name"
  }, {
    "relationships" : {
      "href" : "href"
    },
    "name" : "name"
  } ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RelationshipTypes

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage

Schemas

Up 
post /schemas
Create a new schema. (createSchema)
Create a new schema. The request body shall contain the schema in YANG format.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request headers

Accept (required)
Header Parameter — default: application/json
Content-Type (required)
Header Parameter — default: multipart/form-data

Form parameters

file (required)
Form Parameter — multipartFile default: null format: binary

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created without response body

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

409

Conflict ErrorMessage

500

Internal Server Error ErrorMessage
Up 
delete /schemas/{schemaName}
Delete a schema. (deleteSchema)
Delete a schema.

Path parameters

schemaName (required)
Path Parameter — default: o-ran-smo-teiv-ran

Request headers

Accept (required)
Header Parameter — default: application/json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /schemas/{schemaName}/content
Get the model schema. (getSchemaByName)
Get the model schema by name.

Path parameters

schemaName (required)
Path Parameter — default: o-ran-smo-teiv-ran

Request headers

Accept (required)
Header Parameter — default: application/json

Return type

String

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK String

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

404

Not Found ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /schemas
Get a list of all schemas. (getSchemas)
Get a list of all schemas.

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

domain (optional)
Query Parameter — default: null
offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

SchemaList

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ {
    "domain" : "domain",
    "name" : "name",
    "content" : {
      "href" : "href"
    },
    "revision" : "revision"
  }, {
    "domain" : "domain",
    "name" : "name",
    "content" : {
      "href" : "href"
    },
    "revision" : "revision"
  } ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SchemaList

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage

TopologyGroups

Up 
post /groups
Create group. (createGroup)
Create group.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Group Group (required)
Body Parameter —

Request headers

Accept (required)
Header Parameter — default: application/json
Content-Type (required)
Header Parameter — default: application/json

Return type

GroupResponse

Example data

Content-Type: application/json
{
  "groupName" : "groupName",
  "criteria" : {
    "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
  },
  "id" : "id"
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created GroupResponse

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

409

Conflict ErrorMessage

500

Internal Server Error ErrorMessage
Up 
delete /groups/{groupId}
Delete a group with specified id. (deleteGroup)
Delete a group with specified id.

Path parameters

groupId (required)
Path Parameter — default: null

Request headers

Accept (required)
Header Parameter — default: application/json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

404

Not Found ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /groups
Get all groups. (getAllGroups)
Get all groups.

Request headers

Accept (required)
Header Parameter — default: application/json

Query parameters

offset (optional)
Query Parameter — Pagination offset. default: 0
limit (optional)
Query Parameter — Result limiter. default: 500

Return type

Groups

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ {
    "groupName" : "groupName",
    "criteria" : {
      "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
    },
    "id" : "id"
  }, {
    "groupName" : "groupName",
    "criteria" : {
      "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
    },
    "id" : "id"
  } ],
  "first" : {
    "href" : "href"
  }
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Groups

204

No Content

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /groups/{groupId}
Get a group with specified id. (getGroup)
Get a Group with specified id.

Path parameters

groupId (required)
Path Parameter — default: null

Request headers

Accept (required)
Header Parameter — default: application/json

Return type

GroupResponse

Example data

Content-Type: application/json
{
  "groupName" : "groupName",
  "criteria" : {
    "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
  },
  "id" : "id"
}

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK GroupResponse

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

404

Not Found ErrorMessage

500

Internal Server Error ErrorMessage
Up 
put /groups/{groupId}
Update a Group. (updateGroup)
Update a Group.

Path parameters

groupId (required)
Path Parameter — default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Group Group (required)
Body Parameter —

Request headers

Accept (required)
Header Parameter — default: application/json
Content-Type (required)
Header Parameter — default: application/json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Example data

Content-Type: application/problem+json
Custom MIME type example not yet supported: application/problem+json

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

409

Conflict ErrorMessage

500

Internal Server Error ErrorMessage

Models

[ Jump to Methods ]

Table of Contents

  1. Classifier - Classifier
  2. Decorator - Decorator
  3. Domains - Domains
  4. Domains_items_inner -
  5. DynamicSelection -
  6. DynamicSelection_resourceQuery -
  7. EntitiesResponseMessage - Entities
  8. EntityTypes - EntityTypes
  9. EntityTypes_items_inner -
  10. ErrorMessage - Error
  11. Group -
  12. GroupResponse -
  13. GroupResponse_criteria -
  14. Groups - Groups
  15. Href - Href
  16. RelationshipTypes - RelationshipTypes
  17. RelationshipTypes_items_inner -
  18. RelationshipsResponseMessage - Relationships
  19. Schema - Schema
  20. SchemaList - Schemas
  21. StaticSelection -
  22. TopologySelection -

Classifier - Classifier Up

operation (optional)
String
Enum:
merge
delete
classifiers (optional)
array[String]
entityIds (optional)
array[String]
relationshipIds (optional)
array[String]

Decorator - Decorator Up

operation (optional)
String
Enum:
merge
delete
decorators (optional)
map[String, oas_any_type_not_mapped] Decorators must be defined in schema before use. Data type of a decorator is restricted as defined by it's schema.
entityIds (optional)
array[String]
relationshipIds (optional)
array[String]

Domains - Domains Up

items (optional)
array[Domains_items_inner]
self (optional)
Href
first (optional)
Href
prev (optional)
Href
next (optional)
Href
last (optional)
Href
totalCount (optional)
Integer

Domains_items_inner - Up

name (optional)
String
entityTypes (optional)
Href
relationshipTypes (optional)
Href

DynamicSelection - Up

resourceQuery (optional)
DynamicSelection_resourceQuery

DynamicSelection_resourceQuery - Up

url
String
method (optional)
String
queryParams (optional)
Object
requestBody (optional)
Object

EntitiesResponseMessage - Entities Up

items (optional)
array[Object]
self (optional)
Href
first (optional)
Href
prev (optional)
Href
next (optional)
Href
last (optional)
Href
totalCount (optional)
Integer

EntityTypes - EntityTypes Up

items (optional)
array[EntityTypes_items_inner]
self (optional)
Href
first (optional)
Href
prev (optional)
Href
next (optional)
Href
last (optional)
Href
totalCount (optional)
Integer

EntityTypes_items_inner - Up

name (optional)
String
entities (optional)
Href

ErrorMessage - Error Up

status (optional)
String
message (optional)
String
details (optional)
String

Group - Up

groupName (optional)
String
criteria (optional)
TopologySelection

GroupResponse - Up

id (optional)
String
groupName (optional)
String
criteria (optional)
GroupResponse_criteria

GroupResponse_criteria - Up

resourceInstances (optional)
array[String]
resourceQuery (optional)
DynamicSelection_resourceQuery

Groups - Groups Up

items (optional)
array[GroupResponse]
self (optional)
Href
first (optional)
Href
prev (optional)
Href
next (optional)
Href
last (optional)
Href
totalCount (optional)
Integer

Href - Href Up

href (optional)
String format: uri-template

RelationshipTypes - RelationshipTypes Up

items (optional)
array[RelationshipTypes_items_inner]
self (optional)
Href
first (optional)
Href
prev (optional)
Href
next (optional)
Href
last (optional)
Href
totalCount (optional)
Integer

RelationshipTypes_items_inner - Up

name (optional)
String
relationships (optional)
Href

RelationshipsResponseMessage - Relationships Up

items (optional)
array[Object]
self (optional)
Href
first (optional)
Href
prev (optional)
Href
next (optional)
Href
last (optional)
Href
totalCount (optional)
Integer

Schema - Schema Up

name (optional)
String
domain (optional)
String
revision (optional)
String
content (optional)
Href

SchemaList - Schemas Up

items (optional)
array[Schema]
self (optional)
Href
first (optional)
Href
prev (optional)
Href
next (optional)
Href
last (optional)
Href
totalCount (optional)
Integer

StaticSelection - Up

resourceInstances (optional)
array[String]

TopologySelection - Up

resourceInstances (optional)
array[String]
resourceQuery (optional)
DynamicSelection_resourceQuery