Get Class Types

Get Class Types

Get discovered topology class types such as Router, switch, VEdge etc.

Request
URI
POST
https://{api_host}/tcsa/api/topology/v1/class-types
COPY
Request Body

Request object to get the discovered class type.

ClassRequest of type(s) application/json
Required

Show optional properties

{
    "onlyMap": false
}
{
    "objectClass": "NetworkFunction",
    "objectInstance": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
    "onlyMap": false,
    "relationshipType": "string",
    "traversal": true
}
string
objectClass
Optional

Device type to get all relation ship types

string
objectInstance
Optional

Uniquely identifies the notification across domains.

boolean
onlyMap
Required

If true will return only map supported classes

string
relationshipType
Optional

Describes the type of relationship.

boolean
traversal
Optional

Traversal is required or not (true/false). If traversal = true then objectClass, objectInstance, relationshipType are mandatory.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Array of string of type(s) application/json 
[
    "KubernetesPod",
    "NetworkFunction"
]

400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"onlyMap:"boolean"}' https://{api_host}/tcsa/api/topology/v1/class-types
On This Page
Topology Operations
POST
Get Class Types
POST
Get Map Types
POST
Get Instances
POST
Get Relationships
POST
Topology Map
POST
Get Domain Managers