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

  • scopeFilter (string) – ScopeFilter is used to specify the conditions to be applied.

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

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

Get a specific Topology Entity instance of a Topology Entity type

Get a specific Topology Entity instance of a Topology Entity type

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 a specific Topology Entity instance of a Topology Entity type

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

Parameters:

  • domainName (string) – domain name

  • entityTypeName (string)

  • entityId (string)

Query Parameters:

  • targetFilter (string) – Use targetFilter to specify what needs to be returned in the REST response.

  • scopeFilter (string) – ScopeFilter is used to specify the conditions to be applied.

  • 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 all the available Topology Relationships of a specific relationship type name.

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

Parameters:

  • domainName (string) – domain name

  • relationshipTypeName (string)

Query Parameters:

  • targetFilter (string) – Use targetFilter to specify what needs to be returned in the REST response.

  • scopeFilter (string) – ScopeFilter is used to specify the conditions to be applied.

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

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

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

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

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 a specified targetFilter as a query parameter.

Parameters:

  • domainName (string) – domain name

Query Parameters:

  • targetFilter (string) – Use targetFilter to specify what needs to be returned in the REST response.

  • scopeFilter (string) – ScopeFilter is used to specify the conditions to be applied.

  • 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 contains the schema in YANG format.

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)

GET /schemas

Get a list of all pre defined schemas.

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

POST /user-defined-schemas

Create a new user defined schema.

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

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)

Response Headers:

  • Location – Contains the URI of the newly created resource

GET /user-defined-schemas

Get a list of all used defined schemas.

Get a list of all user defined schemas.

Query Parameters:

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

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

Get the user defined model schema.

Get the user defined 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)

DELETE /user-defined-schemas/{schemaName}

Delete a user defined schema.

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

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

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

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

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

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

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)

POST /groups

Create a new group.

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

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.

  • name (string) – Group name. If not specified, returns all the groups.

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)

DELETE /groups/{groupId}

Delete a group with specified id.

Delete a group with specified id.

Parameters:

  • groupId (string)

Status Codes:
PUT /groups/{groupId}/name

Update the name of a group.

Update the name of a group.

Parameters:

  • groupId (string)

Status Codes:
Request Headers:

  • Content-Type – (Required)

GET /groups/{groupId}/members

Get the members of a group with specified id.

Get the members of a group with specified id.

Parameters:

  • groupId (string)

Query Parameters:

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

GET /groups/{groupId}/provided-members

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

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

Parameters:

  • groupId (string)

Query Parameters:

  • status (string) – Status can be present (or) not-present (or) invalid. If not specified, returns all members of the group.

  • offset (integer) – Pagination offset.

  • limit (integer) – Result limiter.

Status Codes:
Request Headers:

  • Accept – (Required)

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

Merge or remove members of a static group.

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

Parameters:

  • groupId (string)

Status Codes:
Request Headers:

  • Accept – (Required)

  • Content-Type – (Required)