logo
logo

HTTP Implementation

The Search API is based on the Sitecore Content Hub base API. In the following paragraphs is an explanation of the differences between these two.

Methods

The Search API uses a subset of the standard HTTP methods, namely GET, HEAD, and POST methods to perform its tasks. It is thought of as a read-only api, used as an interface to search and filter operations that would be otherwise quite resource consuming, if done through the base API.

NameType
GETRetrieve the current state of a resource, including the content.
HEADRetrieve the current state of a resource, excluding the content.
POSTDo whatever GET does, but the parameters are passed in a resource instead of url arguments.

Headers

The Search API uses the same request headers as the base API, but the response headers are not all used, as follows: Search API does not use the "Location" header, as there is no support for the creation of a resource.

Response Codes

The set of response codes of the Search API is as well a subset of the response codes of the base API:

  • "200 OK"
  • "304 Not Modified"
  • "400 Bad Request"
  • "403 Forbidden"
  • "404 Not Found"
  • "500 Server Error"

Links

The Search API follows the principle of the base API, in that all locations are accessible and discoverable through links.

Paging

Paging behavior is similar to the one in base API, the differences consisting in the fact that the user can choose the desired page size from a list of page size options.

Sorting

Unlike the base API, the search can be sorted by some predefined parameters depending also on the asset types returned as results.

Cultures

The Search API is multicultural.

Caching

The behavior is in line with the one from base API (See the caching from the Hypermedia API documentation).

Authentication

Authentication is done through the base API.

Can we improve this article ? Provide feedback