Offered APIs

API Table

API name

swagger-icon

yaml-icon

Topology Exposure & Inventory Service API (NBI)

link

link

Topology Exposure & Inventory Service API

The Topology Exposure & Inventory Service API is described in more detail in:

Topology Exposure & Inventory Service API (Summary)

GET /domains

Get all the available topology domains.

Get all the available topology domains.

Query Parameters:

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

GET /domains/{domainName}/entity-types

Get all the available topology entity types in domain name.

Get all the available topology entity types in domain name.

Parameters:

  • domainName (string) – domain name

Query Parameters:

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

GET /domains/{domainName}/entity-types/{entityTypeName}/entities

Get all topology entities of a specific entity type.

Get all topology entities of a specific entity type.

Parameters:

  • domainName (string) – domain name

  • entityTypeName (string)

Query Parameters:

  • targetFilter (string) – 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.

  • scopeFilter (string) – 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.

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

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

Get topology for entity type name with specified id. Specified id represents the entity instance.

Get topology for entity type name with specified id. Specified id represents the entity instance.

Parameters:

  • domainName (string) – domain name

  • entityTypeName (string)

  • entityId (string)

Status Codes:
Request Headers:

  • Accept – (Required)

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.

Get all relationships for entity type name with specified id. Specified id represents the entity instance.

Parameters:

  • domainName (string) – domain name

  • entityTypeName (string)

  • entityId (string)

Query Parameters:

  • targetFilter (string) – 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.

  • scopeFilter (string) – 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.

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

GET /domains/{domainName}/relationship-types

Get all the available topology relationship types.

Get all the available topology relationship types.

Parameters:

  • domainName (string) – domain name

Query Parameters:

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

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

Get topology relationships of a specific relationship type name.

Get topology relationships of a specific relationship type name.

Parameters:

  • domainName (string) – domain name

  • relationshipTypeName (string)

Query Parameters:

  • targetFilter (string) – 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.

  • scopeFilter (string) – 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.

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

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

Get relationship with specified id. Specified id represents the relationship instance.

Get relationship with specified id. Specified id represents the relationship instance.

Parameters:

  • domainName (string) – domain name

  • relationshipTypeName (string)

  • relationshipId (string)

Status Codes:
Request Headers:

  • Accept – (Required)

GET /domains/{domainName}/entities

Get entities by domain

Get topology entities by domain, using specified targetFilter as mandatory query parameter.

Parameters:

  • domainName (string) – domain name

Query Parameters:

  • targetFilter (string) – 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.

  • scopeFilter (string) – 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.

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

POST /schemas

Create a new schema.

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

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)

GET /schemas

Get a list of all schemas.

Get a list of all schemas.

Query Parameters:

  • domain (string)

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

GET /schemas/{schemaName}/content

Get the model schema.

Get the model schema by name.

Parameters:

  • schemaName (string)

Status Codes:
Request Headers:

  • Accept – (Required)

DELETE /schemas/{schemaName}

Delete a schema.

Delete a schema.

Parameters:

  • schemaName (string)

Status Codes:
Request Headers:

  • Accept – (Required)

POST /classifiers

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

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

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)

POST /decorators

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

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

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)

POST /groups

Create group.

Create group.

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)

GET /groups

Get all groups.

Get all groups.

Query Parameters:

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

GET /groups/{groupId}

Get a group with specified id.

Get a Group with specified id.

Parameters:

  • groupId (string)

Status Codes:
Request Headers:

  • Accept – (Required)

PUT /groups/{groupId}

Update a Group.

Update a Group.

Parameters:

  • groupId (string)

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)

DELETE /groups/{groupId}

Delete a group with specified id.

Delete a group with specified id.

Parameters:

  • groupId (string)

Status Codes:
Request Headers:

  • Accept – (Required)