ApiLink#

class ApiLink(href=None, rel=None, *args, **kwargs)[source]#

Bases: object

A HATEOAS style link for the response. Each link contains a user friendly name identifying the link and an address for retrieving the particular resource.

Parameters:

href – (href) The URL at which the entity described by this link can be accessed.
rel – (rel) A name that identifies the relationship of this link to the object that is returned by the URL. The special value of “self” identifies the URL for the object.

property href#

The URL at which the entity described by this link can be accessed.

Type:: str

property rel#

A name that identifies the relationship of this link to the object that is returned by the URL. The special value of “self” identifies the URL for the object.

Type:: str

to_dict()[source]#: Returns the model properties as a dictionary

to_str()[source]#: Returns the string representation of the model