Elevations REST API endpoint

Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.

Use the RestApi utility of the Public API for server-side access of this endpoint.

Elevations

Gets the elevations configuration for a custom search index.

Applicable to: custom sv:nodeIndex of the sv:indexRepository.

GET

Returns elevations data for a custom search index.

Requirements

The feature "search-advanced" or "search-enterprise".

Permissions

Requires that the caller is authorized to MANAGE_CUSTOM_SEARCH_INDEX on the sv:site.

Example URL

303.71a4b31177ce2d29321/elevations

Example response

[
   {
      "queryText": "introduction",
      "multipleCasing": true,
      "elevated": [
         {
            "docId": "4.611a899318a1ca89886b",
            "exclude": false
         },
         {
            "docId": "18.7f84551a13dab43a22490",
            "exclude": true
         }
      ]
   },
   {
      "queryText": "payroll",
      "multipleCasing": false,
      "elevated": [
         {
            "docId": "payrollExtId",
            "exclude": false
         },
         {
            "docId": "5.3fa0855d185cec9680f2",
            "exclude": false
         }
      ]
   }
]

Response data notes

The docId is the expected identifier ("primary key") for a Solr document. The out-of-the-box primary key field of a custom index is the "id" field. The docId value typically represents a Sitevision object but can also represent externally indexed data. Also note that there are no guarantees whatsoever that the docId value actually exists as a Solr document in the index.

The multipleCasing state determines whether to generate multiple entries with alternate casing or not. Example: if the queryText is "payroll" and multipleCasing is set to true - the effective query texts entries will be: "payroll", "Payroll", "PAYROLL" and "pAYROLL".

Did you find the content on this page useful?