Topology and Inventory API

Topology 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 and Inventory supports several topology domains. A domain is a grouping of network topology entities which handles topology data.

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

Relationships are a uni-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

Topology 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

EntityType is used as the root of the queries (from here referred as RootObject). Every other object, either 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 will not get constructed. The RootObject still can be retrieved and filtered using the /attributes.

| USE CASE | ENTITY TYPE | TARGET FILTER | SCOPE FILTER | QUERY RESULT | |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------|:----------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------| | To return the ids for all instances of the entityType used in the query. |  GNBDUFunction | | | All ids of every GNBDUFunction | | To return all attributes of every instance of the entityType used in the query. |  GNBDUFunction |  /attributes | | All GNBDUFunctions with every attribute | | To return every instance of the entityType 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. |  GNBDUFunction |  /attributes(gNBId)
   OR
/attributes/gNBId | | All FDNs of every GNBDUFunction | | To return every instance of the entityType used in the query, but only the attributes that were defined in the targetFilter parameter.
Case 1: The attributes must be separated by a comma "," in case of using parenthesis "()".
Case 2: The attributes must be separated by a semicolon ";" in case of using slash "/".
Note: The attributes must be valid targetFilter of the object. |  GNBDUFunction |  /attributes(gNBId, gNBIdLength)
   OR
/attributes/gNBId; /attributes/gNBIdLength | | All Ids and FDNs of every GNBDUFunction | | To return the ids for all instances of the entityType used in the query, that matches the given attribute in the scopeFilter parameter.
Note: The attribute must be a valid field of the object. |  GNBDUFunction | | /attributes[contains (@fdn, "/SubNetwork=Ireland/")] | Unique set of ids of GNBDUFunctions, where fdn contains "SubNetwork=Ireland" | | To return the ids for all instances of the entityType used in the query, that matches the given attributes in the scopeFilter parameter.
Note: the entityType and the object in the scopeFilter parameter must match, and the attributes must be valid field or fields of the object. The attributes must be separated by a comma ",". |  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 entityType used in the query, that satisfies every condition in one of the tags in the scopeFilter parameter. A tag is a complete unit of scopeFilter parameter surrounded by square brackets.
Note: The attributes must be valid field or fields of the object. |  GNBDUFunction | | /attributes[@gNBIdLength=3 and @gNBId=111]
   OR
/attributes[@gNBIdLength=3 and @gNBId=112] | Unique set of ids of GNBDUFunctions, where where the gNBIdLength equals 3 and the gNBId is either 111 or 112 |

Querying connected entities

It is possible to get information about directly connected objects as well. If entityType is present in the targetFilter parameter, the query provides information about that entityType itself.

| USE CASE | ENTITY TYPE | TARGET FILTER | SCOPE FILTER | QUERY RESULT | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-------------------------------------|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| | To return the ids for all instances of the entityType in the targetFilter parameter, if they are directly related to the queried entityType. |  GNBDUFunction |  /NRCellDU | | Unique set of ids of NRCellDUs that relates to GNBDUFunctions directly with any relationship type | | To return the ids for all instances of the entityTypes in the targetFilter parameter, if they are directly related to the entityType. |  GNBDUFunction |  /NRCellDU ;  /NRSectorCarrier | | Unique set of ids of NRCellDUs and NRSectorCarriers that relates to GNBDUFunctions directly with any relationship type | | To return the ids for all instances of the queried entityType that has one or more direct relationships with the entityType specified in the scopeFilter parameter. |  GNBDUFunction | | /AntennaCapability | Unique set of ids of GNBDUFunctions that are directly related to AntennaCapability with any relationship type | | To return the ids for all instances of the queried entityType that has one or more direct relationships with at least one of the entityTypes specified in the scopeFilter parameter. |  GNBDUFunction | | /AntennaCapability
   OR
/NRCellDU | Unique set of ids of GNBDUFunctions that are directly related to AntennaCapability or NRCellDU with any relationship type |

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

Collections

Decorators

EntitiesAndRelationships

GeoQuery

Schemas

Classifiers

Up 
put /classifiers
Update entities and/or relationships with classifier(s). (updateClassifier)
Update entities and/or relationships with classifier(s).

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

Collections

Up 
post /collections
Create a collection. (createCollection)
Create a collection.

Consumes

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

Request body

Collection Collection (required)
Body Parameter —

Request headers

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

Return type

CollectionResponse

Example data

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

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 CollectionResponse

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

409

Conflict ErrorMessage

500

Internal Server Error ErrorMessage
Up 
delete /collections/{collectionId}
Delete a collection with specified id. (deleteCollection)
Delete a collection with specified id.

Path parameters

collectionId (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 /collections
Get all collections. (getAllCollections)
Get all collections.

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

Collections

Example data

Content-Type: application/json
{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ {
    "criteria" : {
      "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
    },
    "id" : "id",
    "collectionName" : "collectionName"
  }, {
    "criteria" : {
      "resourceInstances" : [ "resourceInstances", "resourceInstances" ]
    },
    "id" : "id",
    "collectionName" : "collectionName"
  } ],
  "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 Collections

204

No Content

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

500

Internal Server Error ErrorMessage
Up 
get /collections/{collectionId}
Get a collection with specified id. (getCollection)
Get a collection with specified id.

Path parameters

collectionId (required)
Path Parameter — default: null

Request headers

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

Return type

CollectionResponse

Example data

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

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 CollectionResponse

400

Bad Request ErrorMessage

401

Unauthorized ErrorMessage

403

Forbidden ErrorMessage

404

Not Found ErrorMessage

500

Internal Server Error ErrorMessage
Up 
put /collections/{collectionId}
Update a collection. (updateCollection)
Update a collection.

Path parameters

collectionId (required)
Path Parameter — default: null

Consumes

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

Request body

Collection Collection (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 
put /decorators
Update entities and/or relationships with decorator(s). (updateDecorator)
Update entities and/or relationships with decorator(s).

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

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/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/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

GeoQuery

Up 
post /geo-queries
Geo query topology entity or entities across topology domains. (geoQueryTopologyAcrossDomains)
Geo query topology entity or entities across topology domains.

Consumes

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

Request body

QueryMessage QueryMessage (required)
Body Parameter —

Request headers

Accept (required)
Header Parameter — default: application/json
Content-Type (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

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

409

Conflict ErrorMessage

500

Internal Server Error ErrorMessage

Schemas

Up 
post /schemas
Create a new schema. (createSchema)
Create a new schema.

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: application/json

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", "domain" ],
    "name" : "name",
    "content" : {
      "href" : "href"
    },
    "revision" : "revision"
  }, {
    "domain" : [ "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

Models

[ Jump to Methods ]

Table of Contents

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

Classifier - Classifier Up

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

Collection - Up

collectionName (optional)
String
criteria (optional)
TopologySelection

CollectionResponse - Up

id (optional)
String
collectionName (optional)
String
criteria (optional)
CollectionResponse_criteria

CollectionResponse_criteria - Up

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

Collections - Collections Up

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

Decorator - Decorator Up

operation (optional)
String
Enum:
merge
delete
decorators (optional)
map[String, String]
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

Href - Href Up

href (optional)
String format: uri-template

QueryMessage - Query Up

query (optional)
String

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)
array[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