inventory `relations`

Retrieves relationship models that are defined for the resource types from Cassandra database. Relationship models for all the resource types are defined in the Technology Packs in inventory model files.

URL

https://<dashboard_route>/inventory/rest/model/types/relations

https://<dashboard_hostname>:<dashboard_port>/inventory/rest/model/types/relations

https://<myserver.ibm.com>:31443/inventory/rest/model/types/relations

Method

The supported request type.

https GET

URL parameters

Name	Required	Default value	Description
`source`	No	N/A	Source resource type to get the relationship metadata. For example, `device`.
`target`	No	N/A	Target resource type to get the relationship metadata. For example, `interface`.

Sample URLs

/inventory/rest/model/types/relations
/inventory/rest/model/types/relations?source=device
/inventory/rest/model/types/relations?target=wirelessController

Error Response

Status code	Description
200	Success
400	Failure

Response

The results are returned as JSON data that contains an array of the following fields:

Name	Data type	Description
`source`	string	The source resource type. For example, `device`.
`target`	string	The target resource type. For example, `interface`.
`name`	string	The name of the relation. For example, `contain`.
`cardinality`	string	The cardinality of the relation. For example, `one-to-many`.

JSON code

[
    {
      "source": "device",
      "target": "wirelessController",
      "name": "contain",
      "cardinality": "one-to-many"
    }
  ]