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.

Metadata provides additional information about entities and relationships within the database. The reliabilityIndicator is used to indicate the reliability status of the topology data within the network. The firstDiscovered timestamp is set for an entity and relationship instance when the instances are created for the first time in Topology & Inventory. The lastModified timestamp is set for updates to entities or relationships in Topology & Inventory, excluding updates to classifiers or decorators. reliabilityIndicator, firstDiscovered, and lastModified are implemented as name-value pairs within the metadata. They apply to every entity and relationship.

Topology groups provide the capability to create user-defined collections of topology entities and/or relationships of any type. Groups can be either static or dynamic based on how they are created.

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 | ODUFunction | | | All ids of every ODUFunction | | To return all attributes of every instance of the entityTypeName used in the query. | RAN | ODUFunction | /attributes | | All ODUFunctions 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 | ODUFunction | /attributes(gNBId) | | All gNBIds of every ODUFunction | | 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 | ODUFunction | /attributes(gNBId, gNBIdLength) | | All gNBIds and gNBIdLengths of every ODUFunction | | To return the ids for all instances of the entityTypeName used in the query, that partially matches the given property in the scopeFilter parameter. | RAN | ODUFunction | | /sourceIds[contains (@item, 'SubNetwork=Europe')] | Unique set of ids of ODUFunctions, 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 | ODUFunction | | /attributes [@gNBIdLength=1 and @gNBId=9] | Unique set of ids of ODUFunctions, where the gNBIdLength equals 1 and the gNBId equals 9 | | 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 | ODUFunction | | /attributes [@gNBIdLength=2] | /sourceIds[contains (@item, 'SubNetwork=Europe')] | Unique set of ids of ODUFunctions, where the gNBIdLength equals 2 or the sourceIds contains an item with "SubNetwork=Europe" | | To return the metadata for all instances of the entityTypeName used in the query, that is firstDiscovered within the given timeframe in the scopeFilter parameter.
Note: The timestamps can be queried in any timezone. | RAN | ODUFunction | | /metadata[@firstDiscovered>='2025-01-06T12:34:56.789+05:30' and @firstDiscovered<='2025-01-09T16:10:36.461565+05:30'] | Unique set of ids of ODUFunctions, where metadata contains firstDiscovered timestamp within the range '2025-01-06T12:34:56.789+05:30' and '2025-01-09T16:10:36.461565+05:30' |

Querying connected entities

The entityTypeName is used as the root of the queries.

Querying based on geographical location

The entityTypeName is used as the root of the queries. Use the "Well-known text" (WKT) representation of geometry to specify geometry objects.

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 | ODUFunction | urn:3gpp:dn: ManagedElement=1, ODUFunction=1 | | | All relations for the ODUFunction with id urn:3gpp:dn: ManagedElement=1, ODUFunction=1. | | To return specific relationships for a given entity specified by its id. | REL_OAM_RAN | ODUFunction | urn:3gpp:dn: ManagedElement=1, ODUFunction=1 | /MANAGEDELEMENT _MANAGES _ODUFUNCTION | | All MANAGEDELEMENT _MANAGES _ODUFUNCTION relations for the ODUFunction with id urn:3gpp:dn: ManagedElement=1, ODUFunction=1. | | To return specific relationships for an entity specified by its id to another entity using its id and association. | REL_OAM_RAN | ODUFunction | urn:3gpp:dn: ManagedElement=1, ODUFunction=1 | | /managed-by-managedElement [@id = 'urn:3gpp:dn: ManagedElement=1'] | All MANAGEDELEMENT _MANAGES _ODUFUNCTION relations for the ODUFunction with id urn:3gpp:dn: ManagedElement=1, ODUFunction=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 = 'odu-function-model:Indoor'] | All the entity ids that are classified with "odu-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[@odu-function-model:textdata = 'Stockholm'] | All the entity ids that are exactly matched with "odu-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(@odu-function-model:textdata, '')] | All the entity ids that are exactly matched with "odu-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 = 'odu-function-model:Indoor']; /decorators [@odu-function-model:textdata = 'Stockholm'] | All NRCellDU ids where key of the decorator is "odu-function-model:textdata" and the value of the decorator is 'Stockholm'" and where classifier exactly contains "odu-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(@odu-function-model:textdata, 'Stoc')] | All NRCellDU ids and where key of the decorator is "odu-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(@odu-function-model:textdata, 'Stoc')] | All NRCellDU ids and decorators where key of the decorator is "odu-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 relationship ids and classifiers. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /classifiers | | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION ids and classifiers. | | Return all related relationship 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 = 'odu-function-model:Indoor']; /decorators [@odu-function-model:textdata = 'Stockholm'] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION ids and decorators where key of the decorator is "odu-function-model:textdata" and the value of the decorator is 'Stockholm'" and classifiers exactly contains "odu-function-model:Indoor". | | Return all related relationship 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 relationship ids and decorators where key is a exact match and value is partially match. | | MANAGEDELEMENT _MANAGES _ENODEBFUNCTION | /decorators | /decorators[contains(@odu-function-model:textdata, 'Stock')] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION and where key of the decorator is "odu-function-model:textdata" and the value of the decorator partially contains 'Stock'. | | Return all related relationship 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(@odu-function-model:textdata, 'Stock')] | All MANAGEDELEMENT _MANAGES _ENODEBFUNCTION ids and decorators where key of the decorator is "odu-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: 1.2.0

BasePath:/topology-inventory/v1

http://www.apache.org/licenses/LICENSE-2.0

Access

Methods

[ Jump to Models ]

Classifiers

post /manage-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 request header:

application/json

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

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

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 request header; the media type will be conveyed by the response header.

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

409

Conflict ProblemDetails

411

Length Required ProblemDetails

413

Payload Too Large ProblemDetails

415

Unsupported Media Type ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

post /classifiers

Update entities and/or relationships with classifier(s). (updateClassifierDeprecated)

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 request header:

application/json

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 request header; the media type will be conveyed by the response header.

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

409

Conflict ProblemDetails

500

Internal Server Error ProblemDetails

Decorators

post /manage-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 request header:

application/json

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

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

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 request header; the media type will be conveyed by the response header.

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

409

Conflict ProblemDetails

411

Length Required ProblemDetails

413

Payload Too Large ProblemDetails

415

Unsupported Media Type ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

post /decorators

Update entities and/or relationships with decorator(s). (updateDecoratorDeprecated)

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 request header:

application/json

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 request header; the media type will be conveyed by the response header.

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

409

Conflict ProblemDetails

500

Internal Server Error ProblemDetails

EntitiesAndRelationships

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" : [ {
    "domainName" : "domainName",
    "entityTypes" : {
      "href" : "href"
    },
    "relationshipTypes" : {
      "href" : "href"
    }
  }, {
    "domainName" : "domainName",
    "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

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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK Domains

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

get /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}/relationships

Get all relationships for a specific Topology Entity instance of a Topology Entity type (getAllRelationshipsForEntityId)

Get all relationships for a specific Topology Entity instance of a Topology Entity type

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 what needs to be returned in the REST response. default: null

scopeFilter (optional)

Query Parameter — ScopeFilter is used to specify the conditions to be applied. default: null

offset (optional)

Query Parameter — Pagination offset. default: 0

limit (optional)

Query Parameter — Result limiter. default: 500

Return type

Relationships

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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK Relationships

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

get /domains/{domainName}/entities

Get entities by domain (getEntitiesByDomain)

Get topology entities by domain, using a specified targetFilter as a 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 what needs to be returned in the REST response. default: null

scopeFilter (optional)

Query Parameter — ScopeFilter is used to specify the conditions to be applied. default: null

offset (optional)

Query Parameter — Pagination offset. default: 0

limit (optional)

Query Parameter — Result limiter. default: 500

Return type

Entities

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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK Entities

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

get /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships/{relationshipId}

Get a specific Topology Relationship instance of a Topology Relationship type. (getRelationshipById)

Get a specific Topology Relationship instance of a Topology Relationship type.

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

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 request header; the media type will be conveyed by the response header.

application/yang.data+json
application/problem+json

Responses

200

OK Object

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

get /domains/{domainName}/relationship-types/{relationshipTypeName}/relationships

Get all the available Topology Relationships of a specific relationship type name. (getRelationshipsByType)

Get all the available Topology Relationships of a specific relationship type name 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 what needs to be returned in the REST response. default: null

scopeFilter (optional)

Query Parameter — ScopeFilter is used to specify the conditions to be applied. default: null

offset (optional)

Query Parameter — Pagination offset. default: 0

limit (optional)

Query Parameter — Result limiter. default: 500

Return type

Relationships

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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK Relationships

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

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 what needs to be returned in the REST response. default: null

scopeFilter (optional)

Query Parameter — ScopeFilter is used to specify the conditions to be applied. default: null

offset (optional)

Query Parameter — Pagination offset. default: 0

limit (optional)

Query Parameter — Result limiter. default: 500

Return type

Entities

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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK Entities

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

get /domains/{domainName}/entity-types/{entityTypeName}/entities/{entityId}

Get a specific Topology Entity instance of a Topology Entity type (getTopologyById)

Get a specific Topology Entity instance of a Topology Entity type

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

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 request header; the media type will be conveyed by the response header.

application/yang.data+json
application/problem+json

Responses

200

OK Object

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

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"
    },
    "entityTypeName" : "entityTypeName"
  }, {
    "entities" : {
      "href" : "href"
    },
    "entityTypeName" : "entityTypeName"
  } ],
  "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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK EntityTypes

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

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"
    },
    "relationshipTypeName" : "relationshipTypeName"
  }, {
    "relationships" : {
      "href" : "href"
    },
    "relationshipTypeName" : "relationshipTypeName"
  } ],
  "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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK RelationshipTypes

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

Groups

post /groups

Create a new group. (createGroup)

Create a group of entities and/or relationships in a static or dynamic way.

Consumes

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

application/json

Request body

CreateGroupPayload CreateGroupPayload (required)

Body Parameter —

Request headers

Accept (required)

Header Parameter — default: application/json

Content-Type (required)

Header Parameter — default: application/json

Return type

GroupByIdResponse

Example data

Content-Type: application/json

{
  "members" : {
    "href" : "href"
  },
  "name" : "name",
  "providedMembers" : {
    "href" : "href"
  },
  "id" : "id",
  "type" : "static"
}

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

201

Created GroupByIdResponse

400

Bad Request ProblemDetails

500

Internal Server Error ProblemDetails

delete /groups/{groupId}

Delete a group with specified id. (deleteGroup)

Delete a group with specified id.

Path parameters

groupId (required)

Path Parameter — default: null

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 request header; the media type will be conveyed by the response header.

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

404

Not Found ProblemDetails

500

Internal Server Error ProblemDetails

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

name (optional)

Query Parameter — Group name. If not specified, returns all the groups. default: null

Return type

GroupsResponse

Example data

Content-Type: application/json

{
  "next" : {
    "href" : "href"
  },
  "last" : {
    "href" : "href"
  },
  "prev" : {
    "href" : "href"
  },
  "self" : {
    "href" : "href"
  },
  "totalCount" : 0,
  "items" : [ {
    "members" : {
      "href" : "href"
    },
    "name" : "name",
    "providedMembers" : {
      "href" : "href"
    },
    "id" : "id",
    "type" : "static"
  }, {
    "members" : {
      "href" : "href"
    },
    "name" : "name",
    "providedMembers" : {
      "href" : "href"
    },
    "id" : "id",
    "type" : "static"
  } ],
  "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

Produces

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

application/json
application/problem+json

Responses

200

OK GroupsResponse

400

Bad Request ProblemDetails

500

Internal Server Error ProblemDetails

get /groups/{groupId}

Get a group with specified id. (getGroupById)

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

GroupByIdResponse

Example data

Content-Type: application/json

{
  "members" : {
    "href" : "href"
  },
  "name" : "name",
  "providedMembers" : {
    "href" : "href"
  },
  "id" : "id",
  "type" : "static"
}

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK GroupByIdResponse

400

Bad Request ProblemDetails

404

Not Found ProblemDetails

500

Internal Server Error ProblemDetails

get /groups/{groupId}/members

Get the members of a group with specified id. (getMembers)

Get the members of a group with specified id.

Path parameters

groupId (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

MembersResponse

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

Produces

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

application/json
application/problem+json

Responses

200

OK MembersResponse

400

Bad Request ProblemDetails

404

Not Found ProblemDetails

500

Internal Server Error ProblemDetails

get /groups/{groupId}/provided-members

Get the provided members of a static group with specified id. (getProvidedMembers)

Get the provided members of a static group with specified id.

Path parameters

groupId (required)

Path Parameter — default: null

Request headers

Accept (required)

Header Parameter — default: application/json

Query parameters

status (optional)

Query Parameter — Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group. default: null

offset (optional)

Query Parameter — Pagination offset. default: 0

limit (optional)

Query Parameter — Result limiter. default: 500

Return type

MembersResponse

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

Produces

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

application/json
application/problem+json

Responses

200

OK MembersResponse

400

Bad Request ProblemDetails

404

Not Found ProblemDetails

500

Internal Server Error ProblemDetails

put /groups/{groupId}/name

Update the name of a group. (updateGroupName)

Update the name of a group.

Path parameters

groupId (required)

Path Parameter — default: null

Consumes

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

application/json

Request body

UpdateGroupNamePayload UpdateGroupNamePayload (required)

Body Parameter —

Request headers

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

Produces

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

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

404

Not Found ProblemDetails

500

Internal Server Error ProblemDetails

post /groups/{groupId}/provided-members-operations

Merge or remove members of a static group. (updateProvidedMembers)

Merge or remove members in an existing topology group. This operation is applicable for static group only.

Path parameters

groupId (required)

Path Parameter — default: null

Consumes

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

application/json

Request body

UpdateProvidedMembersPayload UpdateProvidedMembersPayload (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

Produces

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

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

500

Internal Server Error ProblemDetails

Schemas

post /schemas

Create a new schema. (createSchema)

Create a new schema. The request body contains the schema in YANG format.

Consumes

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

multipart/form-data

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 request header; the media type will be conveyed by the response header.

application/problem+json

Responses

201

Created without response body

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

409

Conflict ProblemDetails

500

Internal Server Error ProblemDetails

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 request header; the media type will be conveyed by the response header.

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

500

Internal Server Error ProblemDetails

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: text/plain

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

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 request header; the media type will be conveyed by the response header.

text/plain
application/problem+json

Responses

200

OK String

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

get /schemas

Get a list of all pre defined schemas. (getSchemas)

Get a list of all topology model 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

Schemas

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

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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK Schemas

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

UserDefinedSchemas

post /user-defined-schemas

Create a new user defined schema. (createUserDefinedSchema)

Create a new user defined schema. The request body contains the schema in YANG format.

Consumes

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

multipart/form-data

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

Return type

UserDefinedSchema

Example data

Content-Type: application/json

{
  "domain" : "domain",
  "name" : "name",
  "content" : {
    "href" : "href"
  },
  "revision" : "revision"
}

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

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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

201

Created UserDefinedSchema

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

409

Conflict ProblemDetails

411

Length Required ProblemDetails

413

Payload Too Large ProblemDetails

415

Unsupported Media Type ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

delete /user-defined-schemas/{schemaName}

Delete a user defined schema. (deleteUserDefinedSchema)

Delete a user defined 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

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 request header; the media type will be conveyed by the response header.

application/problem+json

Responses

204

No Content

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

get /user-defined-schemas/{schemaName}/content

Get the user defined model schema. (getUserDefinedSchemaByName)

Get the user defined model schema by name.

Path parameters

schemaName (required)

Path Parameter — default: o-ran-smo-teiv-ran

Request headers

Accept (required)

Header Parameter — default: text/plain

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

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 request header; the media type will be conveyed by the response header.

text/plain
application/problem+json

Responses

200

OK String

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

get /user-defined-schemas

Get a list of all used defined schemas. (getUserDefinedSchemas)

Get a list of all user defined schemas.

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

UserDefinedSchemas

Example data

Content-Type: application/json

{
  "items" : [ {
    "domain" : "domain",
    "name" : "name",
    "content" : {
      "href" : "href"
    },
    "revision" : "revision"
  }, {
    "domain" : "domain",
    "name" : "name",
    "content" : {
      "href" : "href"
    },
    "revision" : "revision"
  } ]
}

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

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 request header; the media type will be conveyed by the response header.

application/json
application/problem+json

Responses

200

OK UserDefinedSchemas

400

Bad Request ProblemDetails

401

Unauthorized ProblemDetails

403

Forbidden ProblemDetails

404

Not Found ProblemDetails

406

Not Acceptable ProblemDetails

414

URI Too Large ProblemDetails

429

Too Many Requests ProblemDetails

500

Internal Server Error ProblemDetails

502

Bad Gateway ProblemDetails

503

Service Unavailable ProblemDetails

Models

[ Jump to Methods ]

Classifier - Classifier
CreateGroupPayload - CreateGroupPayload
Criteria - Criteria
Decorator - Decorator
Domains - Domains
Domains_items_inner -
DynamicEnum -
DynamicGroupByIdResponse - DynamicGroup
DynamicGroupResponse - DynamicGroup
Entities - Entities
EntityTypes - EntityTypes
EntityTypes_items_inner -
GroupByIdResponse - Group
GroupResponse - Group
GroupsResponse - Groups
Href - Href
MembersResponse - GroupMembers
ProblemDetails -
RelationshipTypes - RelationshipTypes
RelationshipTypes_items_inner -
Relationships - Relationships
Schema - Schema
Schemas - Schemas
StaticEnum -
StaticGroupByIdResponse - StaticGroup
StaticGroupResponse - StaticGroup
UpdateGroupNamePayload - UpdateGroupNamePayload
UpdateProvidedMembersPayload - UpdateProvidedMembersPayload
UserDefinedSchema - UserDefinedSchema
UserDefinedSchemas - UserDefinedSchemas
dynamic - CreateDynamicGroupPayload
getEntitiesByDomain - getEntitiesByDomain
getEntitiesByType - getEntitiesByType
getRelationshipsByType - getRelationshipsByType
getRelationshipsForEntityId - getRelationshipsForEntityId
static - CreateStaticGroupPayload

`Classifier` - Classifier Up

operation (optional)

String

Enum:

merge

delete

classifiers (optional)

array[String]

entityIds (optional)

array[String]

relationshipIds (optional)

array[String]

`CreateGroupPayload` - CreateGroupPayload Up

name

String A name of the topology group.

type

String Allowed: dynamic

providedMembers

array[Object]

criteria

Criteria

`Criteria` - Criteria Up

queryType

String Allowed: getRelationshipsByType

domain

String

targetFilter (optional)

String

scopeFilter (optional)

String

entityTypeName

String

entityId

String

relationshipTypeName

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 its schema.

entityIds (optional)

array[String]

relationshipIds (optional)

array[String]