HAL Resource Base (object)

Abstract base object. Not to be used directly. See HAL Resource.

HAL Resource (HAL Resource Base) ¶

HAL Resource is the base type for all HAL resource models. It contains two predefined elements containing hypertext links of the given resource and embedded resources. Derived resource models may add additional elements to specify the state of the resource.

Properties ¶

• _links

  • relation (Link)
  • curies (array[CURIE], optional)

• _embedded

  • relation (Embedded)

Embedded (enum) ¶

HAL Specification: _embedded property value

The value is either a descendant of HAL Resource Base or an array of its descendats.

Members ¶

• (HAL Resource Base)

• (array[HAL Resource Base])

Link (object) ¶

Link object specifies a link to a target resource.

Properties ¶

• href: https://monolith.spotahome.com/api/{resource}/{id} (string, required) - The link URI or URI template

CURIE (Link) ¶

HAL Specification: Link relations

Properties ¶

• name: sah (string, required)

• href: https://monolith.spotahome.com/api/rels/{rel} (string, required)