View search index configuration

get

/gsadmin/v1/{appName}/searchIndexConfig

Returns the search index configuration of the application.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

appName

Type: string

Required: true

Specifies the name of your application, for example, Discover.

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json
• application/zip

200 Response

The search index config.

Body

Represents an application's search index configuration.

Root Schema : SearchIndexConfig

Type: object

Represents an application's search index configuration.

Properties

defaultLocale

Type: string

Specifies the default locale to use when none is provided.

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: search-index-config

isWildcardEnabledInDimensionSearch

Type: boolean

Indicates that a query can contain a wildcard character (*) to match against fragments of words in a dimension value.

locales

Type: array locales

Additional Properties Allowed:

Specifies the additional locales that can be supported.

spellingDictMaxWordLength

Type: integer

Specifies the maximum length of a word that should be included in the spelling dictionary. Applies to both dimension search and record search.

spellingDictMinNumWordOccurrences

Type: integer

Specifies the minimum number of times the word must appear in the source data before the word should be included in the spelling dictionary.

spellingDictMinWordLength

Type: integer

Specifies the minimum character length for a word to be included in the spelling dictionary. This setting applies to both dimension search and record search.

Nested Schema : locales

Type: array

Specifies the additional locales that can be supported.

Items

• Type: string

Examples

The following example shows how to view a search index configuration by submitting a GET request on the REST resource using cURL:

curl -u <username>:<password> http://localhost:8006/ifcr/gsadmin/v1/{appName}/searchIndexConfig.json

Response Body Example

The following example shows the response returned in JSON format.

{
	"ecr:lastModifiedBy": "admin",
	"ecr:lastModified": "2016-05-24T17:10:24.914z",
	"ecr:createDate": "2016-01-13T08:21:15.372z",
	"ecr:type": "search-index-config",
	"defaultLocale": "en-US",
	"locales": [
		"de"
	]
}