Jump to

• Request
• Response
• Examples

View search index configuration

get

/gsadmin/v1/{appName}/searchIndexConfig

Returns the search index configuration of the application.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

The search index config.

Body ()

Root Schema : SearchIndexConfig

Type: object

Represents an application's search index configuration.

Show Source

• defaultLocale(optional): string
  Specifies the default locale to use when none is provided.
• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: search-index-config
• isWildcardEnabledInDimensionSearch(optional): boolean
  Indicates that a query can contain a wildcard character (*) to match against fragments of words in a dimension value.
• locales(optional): array locales
  Specifies the additional locales that can be supported.
• spellingDictMaxWordLength(optional): 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(optional): 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(optional): 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.

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"search-index-config"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        },
        "spellingDictMinNumWordOccurrences":{
            "type":"integer",
            "description":"Specifies the minimum number of times the word must appear in the source data before the word should be included in the spelling dictionary."
        },
        "isWildcardEnabledInDimensionSearch":{
            "type":"boolean",
            "description":"Indicates that a query can contain a wildcard character (*) to match against fragments of words in a dimension value."
        },
        "spellingDictMaxWordLength":{
            "type":"integer",
            "description":"Specifies the maximum length of a word that should be included in the spelling dictionary. Applies to both dimension search and record search."
        },
        "spellingDictMinWordLength":{
            "type":"integer",
            "description":"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."
        },
        "defaultLocale":{
            "type":"string",
            "description":"Specifies the default locale to use when none is provided."
        },
        "locales":{
            "type":"array",
            "description":"Specifies the additional locales that can be supported.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Represents an application's search index configuration."
}

Nested Schema : locales

Type: array

Specifies the additional locales that can be supported.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Specifies the additional locales that can be supported.",
    "items":{
        "type":"string"
    }
}

Back to Top

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"
	]
}

Back to Top