API Docs for: 2.0.20133.2
Show:

api.search.SearchFacets Class

Defined in: src\internal\api\search\searchFacets.ts:8
Module: API Search
Parent Module: API

Search api request facetable fields specification

Properties

BASE_GATEWAYURI

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:17

Endpoint base url through the app gateway

BASE_GATEWAYURI_STG

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:24

Endpoint base url through the app gateway for staging

BASE_URI

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:3

Endpoint base url

BASE_URI_STG

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:10

Endpoint base url for staging

confidentiality

SearchFacet

Defined in src\internal\api\search\searchFacets.ts:13

The document confidentiality facet to use when faceting results

contentType

SearchFacet

Defined in src\internal\api\search\searchFacets.ts:19

The document content type facet to use when faceting results

DEFAULT_LOCALE

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:45

Default language

DEFAULT_SCOPE

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:52

Default scope

DEFAULT_SEARCHRESULTSCOUNT

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:38

Default number of search results

DEFAULT_VERSION

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:59

Default version

language

SearchFacet

Defined in src\internal\api\search\searchFacets.ts:25

The document language facet to use when faceting results

productFamilyId

SearchFacet

Defined in src\internal\api\search\searchFacets.ts:31

The document product family id facet to use when faceting results

productFamilyId

SearchFacet

Defined in src\internal\api\search\searchFacets.ts:43

The document product version id facet to use when faceting results

productNameId

SearchFacet

Defined in src\internal\api\search\searchFacets.ts:37

The document product name id facet to use when faceting results

SEARCH_ROUTE

String private

Provided by the API module.

Defined in src\internal\api\search\searchConstants.ts:31

Route to the search controller method