Attributes of a Link Element
A link element in the XML document usually has the following attributes:
Rel
The Rel attribute defines the type of relationship between the resource and the linked resource or state. The Rel attribute can identify the following relationships:
Relationship | Description |
---|---|
Action | Identifies an action that can be performed with the linked object. For example, Create, Edit, Delete, Start, Stop, Retry, Clone and so on. |
Type of relationship | Identifies the type of relations between the linked resource and the resource. Currently Veeam Backup Enterprise Manager REST API offers two types of relations:
|
Alternate URL | In the entity reference resource representation, the Alternate value in the Rel attribute of the link identifies that the link is a reference to the resource entity. In the entity resource representation, it identifies the link to the reference representation. For details, see Resource Representation for Key Resources. |
For example, the link below is provided in the representation of the restore point resource:
<Link Rel="Up" Type="BackupReference" Href="https://localhost:9398/api/backups/d8877ca3-6283-4011-b09a-73696ef34bf0" Name="Exchange Backup" /> |
The link identifies a backup for which the restore point is created:
- Rel attribute defines the relationship between the current resource, restore point, and the linked resource, backup — Up. This means that the linked backup resource is a parent element for the restore point resource.
- Type attribute defines the type of the linked resource — Backup.
- Href attribute contains a URL for the backup resource — /backupServers/21a631e0-af7f-46ba-afbd-273de2e6fd4a.
- Name attribute defines a name for the backup — Exchange Backup.