Help Page Home

# ReferenceModel

Link to a related resource or action. See Hypermedia.

### Properties

Name | Description | Additional information
--- | --- | ---
Href | Link reference to a related resource. See Hypermedia. Normal: https://server.com/api/Tenants/t1 Using a curie: (unknown API) | Type: String
Templated | Optional. If true, indicates that the link contains a template, for example: (unknown API) | Type: Boolean
RelatedTo | Optional. Secondary key for selecting link objects which share the same relation type. For example, if you have a collection of related offerings and a collection of icons, the icons refer to the offering by setting RelatedTo to the offering ID. The name can be used by the client to differentiate the links. | Type: String
Name | Optional. A human-readable identifier for the target resource. Usually the name of the related object. Example: Acme Tenant | Type: String
Method | Optional. The HTTP method to use when accessing the referenced Href. GET, POST, PUT, DELETE, OPTIONS, or PATCH. If not specified, GET is used. | Type: String
Id | Optional. The globally unique identifier of the object. | Type: String

### Sample

#### application/json

Sample:

    {
      "Href": "[api:Tenants(5e531466-5c6d-41c8-97e1-d814d261f322)]",
      "Name": "Acme Tenant",
      "Id": "5e531466-5c6d-41c8-97e1-d814d261f322"
    }