Link relations

The HAL media-type dictates that link relations are proper URI’s. In order to shorten the link relations, so called CURIES (prefixed with ‘findsi:’) have been introduced. To further reduce overhead and improve readability, certain links are classified using the widely used IANA Link Relations.

The Findsi API may return links with the following IANA link relations:

• self - Conveys an identifier for the link’s context.
• next - Indicates that the link’s context is a part of a series, and that the next in the series is the link target.
• prev - Indicates that the link’s context is a part of a series, and that the previous in the series is the link target.
• first - An IRI that refers to the furthest preceding resource in a series of resources.
• last - An IRI that refers to the furthest following resource in a series of resources.

The Findsi API may return links with the following CURIES link relations:

• actor-similars
• actor-targets
• actor
• actors
• logs
• shortcuts
• target-recommendations
• target-similars
• target
• targets

Embrace hypermedia!

As the API is hypermedia driven and urls are likely change and vary over time, it is strongly recommended you do not hardcode any of the urls in your client. Rather, access the root resource and follow links from there. Doing so will make your client resilient and adaptive, allowing us to regularly implement changes and improvements.

Findsi will not guarantee any url to remain accessible over time, other than the API root. Moreover, urls are API consumer specific. Consequently this documentation is structured around link relations, rather than resource locations.