Get Relationships

Get Relationships

Get all the relationships for the given instance

Request
URI
POST
https://{api_host}/tcsa/api/topology/v1/relationships
COPY
Request Body

Request object to get the relationships for given device type and instance.

RelationshipRequest of type(s) application/json
Required 
{
    "classType": "NetworkFunction",
    "instanceName": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES"
}
string
classType
Required

The type of class, such as Router, Switch etc

string
instanceName
Required

Uniquely identifies the object across domains.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Array of string of type(s) application/json 
[
    "PartOf",
    "MemberOf",
    "RealizedBy"
]

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 '{"classType:"string","instanceName:"string"}' https://{api_host}/tcsa/api/topology/v1/relationships
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