Annotations in the Search Response

The following annotations are returned in the search response.

Table 11:

Annotation

Description

Example

Facets

Contains the result list of a facet column.

"@com.sap.vocabularies.Search.v1.Facets": [ ... ]

Label

The text to be displayed. The example returns:

1. A heading for the facet list

2. The display value of a single item in the facet list

"@com.sap.vocabularies.Common.v1.Label": "Count by FACET1"

"FACET1@com.sap.vocabularies.Common.v1.Label": "mysearchquery"

Ranking

The ranking value, output of the SCORE() function, returned for each item in the result.

"@com.sap.vocabularies.Search.v1.Ranking": 0.75

ResponseTime

The runtime of the search, returned for each search call of a bulk request.

"@com.sap.vocabularies.Search.v1.ResponseTime": 0.0143

URI

Currently always empty. In future this will be URI that has to be used to get all values of a facet.

"@com.sap.vocabularies.Search.v1.Facet.URI": ""

WhereFound

The output of the WHY_FOUND() function, returned for each item in the result if a freestyle search has been called, and where found=true has been given.

"@com.sap.vocabularies.Search.v1.WhereFound": "<TERM>mysearchquery</TERM><FOUND>TXT1</FOUND>"