logo

Link Object

A Link Object represents a URL or a URI Template to another resource. It is an object with the following properties:

NameTypeDescription
hrefStringThe URL or URI Template that points to the specified resource.
titleStringOptionally, a user-friendly text describing the hyperlink. Ignored by client and server.
is_templateBooleanOptional. 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

{
    "href":"http://somecompany.com/api",
    "title":"The service endpoint resource",
    "is_template":false
}

Can we improve this article ? Provide feedback