Links & Pagination

Sourcengine API implements links between entities according to RFC8288. Values are returned as part of the response body as _links.

The _links object contains keys indicating the relationship of additional pages. The values of these are the URLs of the associated pages. The keys will be one of the following:

  • first: The URI of the first page of results.
  • prev: The URI of the previous sequential page of results.
  • next: The URI of the next sequential page of results.
  • last: The URI of the last page of results.

The pages object will only include the links that apply for the current context. For the first page of results, no first or prev links will ever be set.

{
  "_links": {
      "self": {
          "href": "/api/parts/search?page=2&size=10"
      },
      "first": {
          "href": "/api/parts/search?page=1&size=10"
      },
      "last": {
          "href": "/api/parts/search?page=3&size=10"
      },
      "previous": {
          "href": "/api/parts/search?page=1&size=10"
      },
      "next": {
          "href": "/api/parts/search?page=3&size=10"
      }
  }
}