Link V1 Documentation

Links capture data related to the current model they live on.

The type of link is dependent on the rel property.

  • self: href value points to the current models direct url address.
  • documentation: href value points to documentation relevant to the current error.
  • redirect: href value indicates a url that should be redirected to.


Link model represents related link url for the current item

  • Href ( String ) Url to a page or endpoint
  • Rel ( String ) Identifier for the href url. [self] = link to the current item, [documentation] = link to related documentation, [redirect] = link to redirect page
  • Method ( String , optional ) Method type of the link. If not displayed then GET is assumed.