Link Description

June 5, 2026 ยท View on GitHub

The request-related HATEOAS link information., The request-related HATEOAS link information., The request-related HATEOAS link information.

Structure

LinkDescription

Fields

NameTypeTagsDescriptionGetterSetter
HrefStringRequiredThe complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.String getHref()setHref(String href)
RelStringRequiredThe link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.String getRel()setRel(String rel)
MethodLinkHttpMethodOptionalThe HTTP method required to make the related call.LinkHttpMethod getMethod()setMethod(LinkHttpMethod method)

Example (as JSON)

{
  "href": "href2",
  "rel": "rel6",
  "method": "PUT"
}