Link Object
Version: 3.3
A Link Object represents a URL or a URI Template to another resource. It is an object with the following properties:
Name | Type | Description |
---|---|---|
href | String | The URL or URI Template that points to the specified resource. |
title | String | Optionally, a user-friendly text describing the hyperlink. Ignored by client and server. |
is_template | Boolean | Optional. True if the ‘href’ property is a URI Template that needs expansion before it can be used as a URL. The default value is false. |
Example
RequestResponse
{
"href":"http://somecompany.com/api",
"title":"The service endpoint resource",
"is_template":false
}