5.2. Link elements
Access to the Entry Point provides
link elements and URIs for all of the resource collections the API exposes. Each collection uses a relation type to identify the URI a client needs.
| Relationship | Description |
|---|---|
capabilities | Supported capabilities of the Red Hat Storage Console. |
clusters | Clusters. |
events | Events. |
hosts | Hosts. |
networks | Virtual networks. |
roles | Roles. |
tags | Tags. |
users | Users. |
groups | Imported identity service groups. |
domains | Identity service domains. |
The
link elements also contain a set of search URIs for certain collections. These URIs use URI templates [2] to integrate search queries. The purpose of the URI template is to accept a search expression using the natural HTTP pattern of a query parameter. The client does not require prior knowledge of the URI structure. Thus clients should treat these templates as being opaque and access them with a URI template library.
Each search query URI template is identified with a relation type using the convention
"collection/search".
| Relationship | Description |
|---|---|
clusters/search | Query clusters. |
events/search | Query events. |
hosts/search | Query hosts. |
users/search | Query users. |
groups/search | Query groups. |
22632%2C+Console+Developer+Guide-322-09-2014+17%3A11%3A35Report a bug
[2]
The Internet-Draft describing the format of a URI Template is available at http://tools.ietf.org/html/draft-gregorio-uritemplate-03.
